Skip to content

Fix the comment lines in section headers #845

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Fix the comment lines in section headers #845

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ae1f178
Fix the comment lines in section headers
MrOneTwo Oct 28, 2025
be0aed7
Remove unnecessary header for Stack section
MrOneTwo Oct 28, 2025
8bbf991
Escape whitespace after 'i.e.'
MrOneTwo Oct 28, 2025
678c9f3
Fix window functions reference table
MrOneTwo Oct 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 18 additions & 13 deletions src/nuklear.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
*
Expand Down Expand Up @@ -1134,15 +1134,15 @@ 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
*
* =============================================================================*/
/**
* \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.<br /><br />
Expand Down Expand Up @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -2565,7 +2571,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
*
Expand Down Expand Up @@ -2783,7 +2789,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
*
Expand Down Expand Up @@ -4124,7 +4130,7 @@ NK_API void nk_font_atlas_clear(struct nk_font_atlas*);

#endif

/** ==============================================================
/* ==============================================================
*
* MEMORY BUFFER
*
Expand Down Expand Up @@ -4213,7 +4219,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
*
Expand Down Expand Up @@ -4269,7 +4275,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
*
Expand Down Expand Up @@ -5569,7 +5575,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
Expand Down