mirrors/Nuklear
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Correct doc comments for nk_window_get_height

Browse Source
This commit is contained in:
Zach Ploskey 2018-02-10 11:08:52 -08:00 committed by GitHub
parent cb8ee01456
commit 5a79427453
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
nuklear.h
View File

@ -1564,20 +1564,20 @@ NK_API struct nk_vec2 nk_window_get_size(const struct nk_context*);
/// Returns the current window width /// Returns the current window width
*/ */
NK_API float nk_window_get_width(const struct nk_context*); NK_API float nk_window_get_width(const struct nk_context*);
/*/// #### nk_window_get_width /*/// #### nk_window_get_height
/// ///
/// Returns the height of the currently processed window. /// Returns the height of the currently processed window.
/// !!! WARNING /// !!! WARNING
/// Only call this function between calls `nk_begin_xxx` and `nk_end` /// Only call this function between calls `nk_begin_xxx` and `nk_end`
/// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c /// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c
/// float nk_window_get_width(const struct nk_context *ctx); /// float nk_window_get_height(const struct nk_context *ctx);
/// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ /// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
/// ///
/// Parameter | Description /// Parameter | Description
/// ------------|----------------------------------------------------------- /// ------------|-----------------------------------------------------------
/// __ctx__ | Must point to an previously initialized `nk_context` struct /// __ctx__ | Must point to an previously initialized `nk_context` struct
/// ///
/// Returns the current window width /// Returns the current window height
*/ */
NK_API float nk_window_get_height(const struct nk_context*); NK_API float nk_window_get_height(const struct nk_context*);
/*/// #### nk_window_get_panel /*/// #### nk_window_get_panel