Skip to content

Commit 0e872de

Browse files
authored
Fix the comment lines in section headers (#845)
1 parent b5f506a commit 0e872de

1 file changed

Lines changed: 18 additions & 13 deletions

File tree

src/nuklear.h

Lines changed: 18 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -732,7 +732,7 @@ NK_API void nk_input_unicode(struct nk_context*, nk_rune);
732732
*/
733733
NK_API void nk_input_end(struct nk_context*);
734734

735-
/** =============================================================================
735+
/* =============================================================================
736736
*
737737
* DRAWING
738738
*
@@ -1134,15 +1134,15 @@ NK_API const struct nk_draw_command* nk__draw_next(const struct nk_draw_command*
11341134
#define nk_draw_foreach(cmd,ctx, b) for((cmd)=nk__draw_begin(ctx, b); (cmd)!=0; (cmd)=nk__draw_next(cmd, b, ctx))
11351135
#endif
11361136

1137-
/** =============================================================================
1137+
/* =============================================================================
11381138
*
11391139
* WINDOW
11401140
*
11411141
* =============================================================================*/
11421142
/**
11431143
* \page Window
11441144
* Windows are the main persistent state used inside nuklear and are life time
1145-
* controlled by simply "retouching" (i.e. calling) each window each frame.
1145+
* controlled by simply "retouching" (i.e.\ calling) each window each frame.
11461146
* All widgets inside nuklear can only be added inside the function pair `nk_begin_xxx`
11471147
* and `nk_end`. Calling any widgets outside these two functions will result in an
11481148
* assert in debug or no state change in release mode.<br /><br />
@@ -1219,12 +1219,14 @@ NK_API const struct nk_draw_command* nk__draw_next(const struct nk_draw_command*
12191219
* ```
12201220
*
12211221
* # Reference
1222-
* Function | Description
1223-
* ------------------------------------|----------------------------------------
1222+
* Function | Description
1223+
* -----------------------------------------|----------------------------------------
12241224
* \ref nk_begin | Starts a new window; needs to be called every frame for every window (unless hidden) or otherwise the window gets removed
12251225
* \ref nk_begin_titled | Extended window start with separated title and identifier to allow multiple windows with same name but not title
12261226
* \ref nk_end | Needs to be called at the end of the window building process to process scaling, scrollbars and general cleanup
12271227
*
1228+
* Function | Description
1229+
* -----------------------------------------|----------------------------------------
12281230
* \ref nk_window_find | Finds and returns the window with give name
12291231
* \ref nk_window_get_bounds | Returns a rectangle with screen position and size of the currently processed window.
12301232
* \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*
12461248
* \ref nk_window_is_hovered | Returns if the currently processed window is currently being hovered by mouse
12471249
* \ref nk_window_is_any_hovered | Return if any window currently hovered
12481250
* \ref nk_item_is_any_active | Returns if any window or widgets is currently hovered or active
1249-
//
1251+
*
1252+
* Function | Description
1253+
* -----------------------------------------|----------------------------------------
12501254
* \ref nk_window_set_bounds | Updates position and size of the currently processed window
12511255
* \ref nk_window_set_position | Updates position of the currently process window
12521256
* \ref nk_window_set_size | Updates the size of the currently processed window
12531257
* \ref nk_window_set_focus | Set the currently processed window as active window
12541258
* \ref nk_window_set_scroll | Sets the scroll offset of the current window
1255-
//
1259+
*
1260+
* Function | Description
1261+
* -----------------------------------------|----------------------------------------
12561262
* \ref nk_window_close | Closes the window with given window name which deletes the window at the end of the frame
12571263
* \ref nk_window_collapse | Collapses the window with given window name
12581264
* \ref nk_window_collapse_if | Collapses the window with given window name if the given condition was met
@@ -2565,7 +2571,7 @@ NK_API struct nk_rect nk_layout_space_rect_to_local(const struct nk_context *ctx
25652571
NK_API void nk_spacer(struct nk_context *ctx);
25662572

25672573

2568-
/** =============================================================================
2574+
/* =============================================================================
25692575
*
25702576
* GROUP
25712577
*
@@ -2783,7 +2789,7 @@ NK_API void nk_group_get_scroll(struct nk_context*, const char *id, nk_uint *x_o
27832789
*/
27842790
NK_API void nk_group_set_scroll(struct nk_context*, const char *id, nk_uint x_offset, nk_uint y_offset);
27852791

2786-
/** =============================================================================
2792+
/* =============================================================================
27872793
*
27882794
* TREE
27892795
*
@@ -4124,7 +4130,7 @@ NK_API void nk_font_atlas_clear(struct nk_font_atlas*);
41244130

41254131
#endif
41264132

4127-
/** ==============================================================
4133+
/* ==============================================================
41284134
*
41294135
* MEMORY BUFFER
41304136
*
@@ -4213,7 +4219,7 @@ NK_API void *nk_buffer_memory(struct nk_buffer*);
42134219
NK_API const void *nk_buffer_memory_const(const struct nk_buffer*);
42144220
NK_API nk_size nk_buffer_total(const struct nk_buffer*);
42154221

4216-
/** ==============================================================
4222+
/* ==============================================================
42174223
*
42184224
* STRING
42194225
*
@@ -4269,7 +4275,7 @@ NK_API const char *nk_str_get_const(const struct nk_str*);
42694275
NK_API int nk_str_len(const struct nk_str*);
42704276
NK_API int nk_str_len_char(const struct nk_str*);
42714277

4272-
/**===============================================================
4278+
/* ===============================================================
42734279
*
42744280
* TEXT EDITOR
42754281
*
@@ -5569,7 +5575,6 @@ struct nk_window {
55695575
* =============================================================*/
55705576
/**
55715577
* \page Stack
5572-
* # Stack
55735578
* The style modifier stack can be used to temporarily change a
55745579
* property inside `nk_style`. For example if you want a special
55755580
* red button you can temporarily push the old button color onto a stack

0 commit comments

Comments
 (0)