From ae1f178b444385d6cead60691203b353ee44b39c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C5=82=20Ciesielski?= Date: Tue, 28 Oct 2025 11:40:42 +0100 Subject: [PATCH 1/4] Fix the comment lines in section headers Comment lines for headers were inconsistent and didn't play well with doxygen. --- src/nuklear.h | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/src/nuklear.h b/src/nuklear.h index 9362e816..f8462288 100644 --- a/src/nuklear.h +++ b/src/nuklear.h @@ -732,7 +732,7 @@ NK_API void nk_input_unicode(struct nk_context*, nk_rune); */ NK_API void nk_input_end(struct nk_context*); -/** ============================================================================= +/* ============================================================================= * * DRAWING * @@ -1134,7 +1134,7 @@ NK_API const struct nk_draw_command* nk__draw_next(const struct nk_draw_command* #define nk_draw_foreach(cmd,ctx, b) for((cmd)=nk__draw_begin(ctx, b); (cmd)!=0; (cmd)=nk__draw_next(cmd, b, ctx)) #endif -/** ============================================================================= +/* ============================================================================= * * WINDOW * @@ -2565,7 +2565,7 @@ NK_API struct nk_rect nk_layout_space_rect_to_local(const struct nk_context *ctx NK_API void nk_spacer(struct nk_context *ctx); -/** ============================================================================= +/* ============================================================================= * * GROUP * @@ -2783,7 +2783,7 @@ NK_API void nk_group_get_scroll(struct nk_context*, const char *id, nk_uint *x_o */ NK_API void nk_group_set_scroll(struct nk_context*, const char *id, nk_uint x_offset, nk_uint y_offset); -/** ============================================================================= +/* ============================================================================= * * TREE * @@ -4124,7 +4124,7 @@ NK_API void nk_font_atlas_clear(struct nk_font_atlas*); #endif -/** ============================================================== +/* ============================================================== * * MEMORY BUFFER * @@ -4213,7 +4213,7 @@ NK_API void *nk_buffer_memory(struct nk_buffer*); NK_API const void *nk_buffer_memory_const(const struct nk_buffer*); NK_API nk_size nk_buffer_total(const struct nk_buffer*); -/** ============================================================== +/* ============================================================== * * STRING * @@ -4269,7 +4269,7 @@ NK_API const char *nk_str_get_const(const struct nk_str*); NK_API int nk_str_len(const struct nk_str*); NK_API int nk_str_len_char(const struct nk_str*); -/**=============================================================== +/* =============================================================== * * TEXT EDITOR * From be0aed7ec8a6ff4438dbe73284c300e11ce3dbf4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C5=82=20Ciesielski?= Date: Tue, 28 Oct 2025 11:48:44 +0100 Subject: [PATCH 2/4] Remove unnecessary header for Stack section --- src/nuklear.h | 1 - 1 file changed, 1 deletion(-) diff --git a/src/nuklear.h b/src/nuklear.h index f8462288..c60fc2e3 100644 --- a/src/nuklear.h +++ b/src/nuklear.h @@ -5569,7 +5569,6 @@ struct nk_window { * =============================================================*/ /** * \page Stack - * # Stack * The style modifier stack can be used to temporarily change a * property inside `nk_style`. For example if you want a special * red button you can temporarily push the old button color onto a stack From 8bbf991178db9db87f47bb93e4ef038c60361410 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C5=82=20Ciesielski?= Date: Tue, 28 Oct 2025 13:15:40 +0100 Subject: [PATCH 3/4] Escape whitespace after 'i.e.' Without this escape Doxygen breaks paragraph after 'i.e.'. --- src/nuklear.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/nuklear.h b/src/nuklear.h index c60fc2e3..4f6e5055 100644 --- a/src/nuklear.h +++ b/src/nuklear.h @@ -1142,7 +1142,7 @@ NK_API const struct nk_draw_command* nk__draw_next(const struct nk_draw_command* /** * \page Window * Windows are the main persistent state used inside nuklear and are life time - * controlled by simply "retouching" (i.e. calling) each window each frame. + * controlled by simply "retouching" (i.e.\ calling) each window each frame. * All widgets inside nuklear can only be added inside the function pair `nk_begin_xxx` * and `nk_end`. Calling any widgets outside these two functions will result in an * assert in debug or no state change in release mode.

From 678c9f33769b8d78cc440c466ce638eaad9d26cd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C5=82=20Ciesielski?= Date: Tue, 28 Oct 2025 13:26:46 +0100 Subject: [PATCH 4/4] Fix window functions reference table --- src/nuklear.h | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/src/nuklear.h b/src/nuklear.h index 4f6e5055..ea43b05b 100644 --- a/src/nuklear.h +++ b/src/nuklear.h @@ -1219,12 +1219,14 @@ NK_API const struct nk_draw_command* nk__draw_next(const struct nk_draw_command* * ``` * * # Reference - * Function | Description - * ------------------------------------|---------------------------------------- + * Function | Description + * -----------------------------------------|---------------------------------------- * \ref nk_begin | Starts a new window; needs to be called every frame for every window (unless hidden) or otherwise the window gets removed * \ref nk_begin_titled | Extended window start with separated title and identifier to allow multiple windows with same name but not title * \ref nk_end | Needs to be called at the end of the window building process to process scaling, scrollbars and general cleanup * + * Function | Description + * -----------------------------------------|---------------------------------------- * \ref nk_window_find | Finds and returns the window with give name * \ref nk_window_get_bounds | Returns a rectangle with screen position and size of the currently processed window. * \ref nk_window_get_position | Returns the position of the currently processed window @@ -1246,13 +1248,17 @@ NK_API const struct nk_draw_command* nk__draw_next(const struct nk_draw_command* * \ref nk_window_is_hovered | Returns if the currently processed window is currently being hovered by mouse * \ref nk_window_is_any_hovered | Return if any window currently hovered * \ref nk_item_is_any_active | Returns if any window or widgets is currently hovered or active -// + * + * Function | Description + * -----------------------------------------|---------------------------------------- * \ref nk_window_set_bounds | Updates position and size of the currently processed window * \ref nk_window_set_position | Updates position of the currently process window * \ref nk_window_set_size | Updates the size of the currently processed window * \ref nk_window_set_focus | Set the currently processed window as active window * \ref nk_window_set_scroll | Sets the scroll offset of the current window -// + * + * Function | Description + * -----------------------------------------|---------------------------------------- * \ref nk_window_close | Closes the window with given window name which deletes the window at the end of the frame * \ref nk_window_collapse | Collapses the window with given window name * \ref nk_window_collapse_if | Collapses the window with given window name if the given condition was met