@@ -89,8 +89,7 @@ Also optionally define the symbols listed in the section "OPTIONAL DEFINES"
8989below in header and implementation mode if you want to use additional functionality
9090or need more control over the library.
9191
92- !!! WARNING
93- Every time nuklear is included define the same compiler flags. This very important not doing so could lead to compiler errors or even worse stack corruptions.
92+ \warning Every time nuklear is included define the same compiler flags. This very important not doing so could lead to compiler errors or even worse stack corruptions.
9493
9594### Flags
9695Flag | Description
@@ -111,14 +110,12 @@ NK_UINT_DRAW_INDEX | Defining this will set the size of vertex inde
111110NK_KEYSTATE_BASED_INPUT | Define this if your backend uses key state for each frame rather than key press/release events
112111NK_IS_WORD_BOUNDARY(c) | Define this to a function macro that takes a single nk_rune (nk_uint) and returns true if it's a word separator. If not defined, uses the default definition (see nk_is_word_boundary())
113112
114- !!! WARNING
115- The following flags will pull in the standard C library:
113+ \warning The following flags will pull in the standard C library:
116114 - NK_INCLUDE_DEFAULT_ALLOCATOR
117115 - NK_INCLUDE_STANDARD_IO
118116 - NK_INCLUDE_STANDARD_VARARGS
119117
120- !!! WARNING
121- The following flags if defined need to be defined for both header and implementation:
118+ \warning The following flags if defined need to be defined for both header and implementation:
122119 - NK_INCLUDE_FIXED_TYPES
123120 - NK_INCLUDE_DEFAULT_ALLOCATOR
124121 - NK_INCLUDE_STANDARD_VARARGS
@@ -137,8 +134,7 @@ NK_BUFFER_DEFAULT_INITIAL_SIZE | Initial buffer size allocated by all buffers w
137134NK_MAX_NUMBER_BUFFER | Maximum buffer size for the conversion buffer between float and string Under normal circumstances this should be more than sufficient.
138135NK_INPUT_MAX | Defines the max number of bytes which can be added as text input in one frame. Under normal circumstances this should be more than sufficient.
139136
140- !!! WARNING
141- The following constants if defined need to be defined for both header and implementation:
137+ \warning The following constants if defined need to be defined for both header and implementation:
142138 - NK_MAX_NUMBER_BUFFER
143139 - NK_BUFFER_DEFAULT_INITIAL_SIZE
144140 - NK_INPUT_MAX
@@ -156,16 +152,13 @@ NK_STRTOD | You can define this to `strtod` or your own string to double conve
156152NK_DTOA | You can define this to `dtoa` or your own double to string conversion implementation replacement. If not defined nuklear will use its own imprecise and possibly unsafe version (does not handle nan or infinity!).
157153NK_VSNPRINTF| If you define `NK_INCLUDE_STANDARD_VARARGS` as well as `NK_INCLUDE_STANDARD_IO` and want to be safe define this to `vsnprintf` on compilers supporting later versions of C or C++. By default nuklear will check for your stdlib version in C as well as compiler version in C++. if `vsnprintf` is available it will define it to `vsnprintf` directly. If not defined and if you have older versions of C or C++ it will be defined to `vsprintf` which is unsafe.
158154
159- !!! WARNING
160- The following dependencies will pull in the standard C library if not redefined:
155+ \warning The following dependencies will pull in the standard C library if not redefined:
161156 - NK_ASSERT
162157
163- !!! WARNING
164- The following dependencies if defined need to be defined for both header and implementation:
158+ \warning The following dependencies if defined need to be defined for both header and implementation:
165159 - NK_ASSERT
166160
167- !!! WARNING
168- The following dependencies if defined need to be defined only for the implementation part:
161+ \warning The following dependencies if defined need to be defined only for the implementation part:
169162 - NK_MEMSET
170163 - NK_MEMCPY
171164 - NK_SQRT
@@ -633,8 +626,7 @@ NK_API nk_bool nk_init_default(struct nk_context*, const struct nk_user_font*);
633626 * nk_bool nk_init_fixed(struct nk_context *ctx, void *memory, nk_size size, const struct nk_user_font *font);
634627 * ```
635628 *
636- * !!! Warning
637- * make sure the passed memory block is aligned correctly for `nk_draw_commands`.
629+ * \warning Make sure the passed memory block is aligned correctly for `nk_draw_commands`.
638630 *
639631 * Parameter | Description
640632 * ------------|--------------------------------------------------------------
@@ -922,8 +914,7 @@ NK_API void nk_input_scroll(struct nk_context*, struct nk_vec2 val);
922914 * This is basically a helper function to quickly push ASCII characters into
923915 * nuklear.
924916 *
925- * \note
926- * Stores up to NK_INPUT_MAX bytes between `nk_input_begin` and `nk_input_end`.
917+ * \note Stores up to NK_INPUT_MAX bytes between `nk_input_begin` and `nk_input_end`.
927918 *
928919 * ```c
929920 * void nk_input_char(struct nk_context *ctx, char c);
@@ -938,8 +929,7 @@ NK_API void nk_input_char(struct nk_context*, char);
938929 * \brief Converts an encoded unicode rune into UTF-8 and copies the result into an
939930 * internal text buffer.
940931 *
941- * \note
942- * Stores up to NK_INPUT_MAX bytes between `nk_input_begin` and `nk_input_end`.
932+ * \note Stores up to NK_INPUT_MAX bytes between `nk_input_begin` and `nk_input_end`.
943933 *
944934 * ```c
945935 * void nk_input_glyph(struct nk_context *ctx, const nk_glyph g);
@@ -955,8 +945,7 @@ NK_API void nk_input_glyph(struct nk_context*, const nk_glyph);
955945 * into an internal text buffer.
956946 *
957947 * \details
958- * \note
959- * Stores up to NK_INPUT_MAX bytes between `nk_input_begin` and `nk_input_end`.
948+ * \note Stores up to NK_INPUT_MAX bytes between `nk_input_begin` and `nk_input_end`.
960949 *
961950 * ```c
962951 * void nk_input_unicode(struct nk_context*, nk_rune rune);
@@ -1632,8 +1621,8 @@ NK_API struct nk_window *nk_window_find(const struct nk_context *ctx, const char
16321621 * # # nk_window_get_bounds
16331622 * \returns a rectangle with screen position and size of the currently processed window
16341623 *
1635- * !!! \warning
1636- * Only call this function between calls `nk_begin_xxx` and `nk_end`
1624+ * \warning Only call this function between calls `nk_begin_xxx` and `nk_end`.
1625+ *
16371626 * ```c
16381627 * struct nk_rect nk_window_get_bounds(const struct nk_context *ctx);
16391628 * ```
@@ -1651,8 +1640,8 @@ NK_API struct nk_rect nk_window_get_bounds(const struct nk_context *ctx);
16511640 * # # nk_window_get_position
16521641 * \returns the position of the currently processed window.
16531642 *
1654- * !!! \warning
1655- * Only call this function between calls `nk_begin_xxx` and `nk_end`
1643+ * \warning Only call this function between calls `nk_begin_xxx` and `nk_end`.
1644+ *
16561645 * ```c
16571646 * struct nk_vec2 nk_window_get_position(const struct nk_context *ctx);
16581647 * ```
@@ -1670,8 +1659,8 @@ NK_API struct nk_vec2 nk_window_get_position(const struct nk_context *ctx);
16701659 * # # nk_window_get_size
16711660 * \returns the size with width and height of the currently processed window.
16721661 *
1673- * !!! \warning
1674- * Only call this function between calls `nk_begin_xxx` and `nk_end`
1662+ * \warning Only call this function between calls `nk_begin_xxx` and `nk_end`.
1663+ *
16751664 * ```c
16761665 * struct nk_vec2 nk_window_get_size(const struct nk_context *ctx);
16771666 * ```
@@ -1689,8 +1678,8 @@ NK_API struct nk_vec2 nk_window_get_size(const struct nk_context *ctx);
16891678 * nk_window_get_width
16901679 * \returns the width of the currently processed window.
16911680 *
1692- * !!! \warning
1693- * Only call this function between calls `nk_begin_xxx` and `nk_end`
1681+ * \warning Only call this function between calls `nk_begin_xxx` and `nk_end`.
1682+ *
16941683 * ```c
16951684 * float nk_window_get_width(const struct nk_context *ctx);
16961685 * ```
@@ -1707,8 +1696,8 @@ NK_API float nk_window_get_width(const struct nk_context *ctx);
17071696 * # # nk_window_get_height
17081697 * \returns the height of the currently processed window.
17091698 *
1710- * !!! \warning
1711- * Only call this function between calls `nk_begin_xxx` and `nk_end`
1699+ * \warning Only call this function between calls `nk_begin_xxx` and `nk_end`.
1700+ *
17121701 * ```c
17131702 * float nk_window_get_height(const struct nk_context *ctx);
17141703 * ```
@@ -1726,10 +1715,10 @@ NK_API float nk_window_get_height(const struct nk_context* ctx);
17261715 * # # nk_window_get_panel
17271716 * \returns the underlying panel which contains all processing state of the current window.
17281717 *
1729- * !!! \warning
1730- * Only call this function between calls `nk_begin_xxx` and `nk_end`
1731- * !!! \warning
1732- * Do not keep the returned panel pointer around, it is only valid until `nk_end`
1718+ * \warning Only call this function between calls `nk_begin_xxx` and `nk_end`
1719+ *
1720+ * \warning Do not keep the returned panel pointer around, it is only valid until `nk_end`.
1721+ *
17331722 * ```c
17341723 * struct nk_panel* nk_window_get_panel(struct nk_context *ctx);
17351724 * ```
@@ -1748,8 +1737,7 @@ NK_API struct nk_panel* nk_window_get_panel(const struct nk_context* ctx);
17481737 * \returns the position and size of the currently visible and non-clipped space
17491738 * inside the currently processed window.
17501739 *
1751- * !!! \warning
1752- * Only call this function between calls `nk_begin_xxx` and `nk_end`
1740+ * \warning Only call this function between calls `nk_begin_xxx` and `nk_end`
17531741 *
17541742 * ```c
17551743 * struct nk_rect nk_window_get_content_region(struct nk_context *ctx);
@@ -1770,8 +1758,7 @@ NK_API struct nk_rect nk_window_get_content_region(const struct nk_context* ctx)
17701758 * \returns the upper left position of the currently visible and non-clipped
17711759 * space inside the currently processed window.
17721760 *
1773- * !!! \warning
1774- * Only call this function between calls `nk_begin_xxx` and `nk_end`
1761+ * \warning Only call this function between calls `nk_begin_xxx` and `nk_end`
17751762 *
17761763 * ```c
17771764 * struct nk_vec2 nk_window_get_content_region_min(struct nk_context *ctx);
@@ -1792,8 +1779,7 @@ NK_API struct nk_vec2 nk_window_get_content_region_min(const struct nk_context *
17921779 * \returns the lower right screen position of the currently visible and
17931780 * non-clipped space inside the currently processed window.
17941781 *
1795- * !!! \warning
1796- * Only call this function between calls `nk_begin_xxx` and `nk_end`
1782+ * \warning Only call this function between calls `nk_begin_xxx` and `nk_end`
17971783 *
17981784 * ```c
17991785 * struct nk_vec2 nk_window_get_content_region_max(struct nk_context *ctx);
@@ -1814,8 +1800,7 @@ NK_API struct nk_vec2 nk_window_get_content_region_max(const struct nk_context *
18141800 * \returns the size of the currently visible and non-clipped space inside the
18151801 * currently processed window
18161802 *
1817- * !!! \warning
1818- * Only call this function between calls `nk_begin_xxx` and `nk_end`
1803+ * \warning Only call this function between calls `nk_begin_xxx` and `nk_end`
18191804 *
18201805 * ```c
18211806 * struct nk_vec2 nk_window_get_content_region_size(struct nk_context *ctx);
@@ -1833,10 +1818,8 @@ NK_API struct nk_vec2 nk_window_get_content_region_size(const struct nk_context
18331818/**
18341819 * # # nk_window_get_canvas
18351820 * \returns the draw command buffer. Can be used to draw custom widgets
1836- * !!! \warning
1837- * Only call this function between calls `nk_begin_xxx` and `nk_end`
1838- * !!! \warning
1839- * Do not keep the returned command buffer pointer around it is only valid until `nk_end`
1821+ * \warning Only call this function between calls `nk_begin_xxx` and `nk_end`
1822+ * \warning Do not keep the returned command buffer pointer around it is only valid until `nk_end`
18401823 *
18411824 * ```c
18421825 * struct nk_command_buffer* nk_window_get_canvas(struct nk_context *ctx);
@@ -1854,8 +1837,7 @@ NK_API struct nk_command_buffer* nk_window_get_canvas(const struct nk_context* c
18541837/**
18551838 * # # nk_window_get_scroll
18561839 * Gets the scroll offset for the current window
1857- * !!! \warning
1858- * Only call this function between calls `nk_begin_xxx` and `nk_end`
1840+ * \warning Only call this function between calls `nk_begin_xxx` and `nk_end`
18591841 *
18601842 * ```c
18611843 * void nk_window_get_scroll(struct nk_context *ctx, nk_uint *offset_x, nk_uint *offset_y);
@@ -1873,8 +1855,8 @@ NK_API void nk_window_get_scroll(const struct nk_context *ctx, nk_uint *offset_x
18731855/**
18741856 * # # nk_window_has_focus
18751857 * \returns if the currently processed window is currently active
1876- * !!! \warning
1877- * Only call this function between calls `nk_begin_xxx` and `nk_end`
1858+ * \warning Only call this function between calls `nk_begin_xxx` and `nk_end`.
1859+ *
18781860 * ```c
18791861 * nk_bool nk_window_has_focus(const struct nk_context *ctx);
18801862 * ```
@@ -1891,8 +1873,8 @@ NK_API nk_bool nk_window_has_focus(const struct nk_context *ctx);
18911873/**
18921874 * # # nk_window_is_hovered
18931875 * Return if the current window is being hovered
1894- * !!! \warning
1895- * Only call this function between calls `nk_begin_xxx` and `nk_end`
1876+ * \warning Only call this function between calls `nk_begin_xxx` and `nk_end`.
1877+ *
18961878 * ```c
18971879 * nk_bool nk_window_is_hovered(struct nk_context *ctx);
18981880 * ```
@@ -2073,8 +2055,7 @@ NK_API void nk_window_set_focus(struct nk_context *ctx, const char *name);
20732055/**
20742056 * # # nk_window_set_scroll
20752057 * Sets the scroll offset for the current window
2076- * !!! \warning
2077- * Only call this function between calls `nk_begin_xxx` and `nk_end`
2058+ * \warning Only call this function between calls `nk_begin_xxx` and `nk_end`
20782059 *
20792060 * ```c
20802061 * void nk_window_set_scroll(struct nk_context *ctx, nk_uint offset_x, nk_uint offset_y);
@@ -2472,8 +2453,7 @@ enum nk_widget_alignment {
24722453
24732454/**
24742455 * Sets the currently used minimum row height.
2475- * !!! \warning
2476- * The passed height needs to include both your preferred row height
2456+ * \warning The passed height needs to include both your preferred row height
24772457 * as well as padding. No internal padding is added.
24782458 *
24792459 * ```c
@@ -3070,9 +3050,8 @@ NK_API void nk_group_set_scroll(struct nk_context*, const char *id, nk_uint x_of
30703050 * or hidden and therefore does not need to be filled with content or `true(1)`
30713051 * if visible and required to be filled.
30723052 *
3073- * !!! Note
3074- * The tree header does not require and layouting function and instead
3075- * calculates a auto height based on the currently used font size
3053+ * \note The tree header does not require and layouting function and instead
3054+ * calculates a auto height based on the currently used font size
30763055 *
30773056 * The tree ending functions only need to be called if the tree content is
30783057 * actually visible. So make sure the tree push function is guarded by `if`
@@ -3110,8 +3089,7 @@ NK_API void nk_group_set_scroll(struct nk_context*, const char *id, nk_uint x_of
31103089/**
31113090 * # # nk_tree_push
31123091 * Starts a collapsible UI section with internal state management
3113- * !!! \warning
3114- * To keep track of the runtime tree collapsible state this function uses
3092+ * \warning To keep track of the runtime tree collapsible state this function uses
31153093 * defines `__FILE__` and `__LINE__` to generate a unique ID. If you want
31163094 * to call this function in a loop please use `nk_tree_push_id` or
31173095 * `nk_tree_push_hashed` instead.
@@ -3175,8 +3153,7 @@ NK_API nk_bool nk_tree_push_hashed(struct nk_context*, enum nk_tree_type, const
31753153/**
31763154 * # # nk_tree_image_push
31773155 * Start a collapsible UI section with image and label header
3178- * !!! \warning
3179- * To keep track of the runtime tree collapsible state this function uses
3156+ * \warning To keep track of the runtime tree collapsible state this function uses
31803157 * defines `__FILE__` and `__LINE__` to generate a unique ID. If you want
31813158 * to call this function in a loop please use `nk_tree_image_push_id` or
31823159 * `nk_tree_image_push_hashed` instead.
@@ -3590,8 +3567,7 @@ NK_API nk_bool nk_color_pick(struct nk_context*, struct nk_colorf*, enum nk_colo
35903567
35913568 * # # nk_property_int
35923569 * Integer property directly modifying a passed in value
3593- * !!! \warning
3594- * To generate a unique property ID using the same label make sure to insert
3570+ * \warning To generate a unique property ID using the same label make sure to insert
35953571 * a `#` at the beginning. It will not be shown but guarantees correct behavior.
35963572 *
35973573 * ```c
@@ -3615,8 +3591,7 @@ NK_API nk_bool nk_property_int(struct nk_context*, const char *name, int min, in
36153591/**
36163592 * # # nk_property_float
36173593 * Float property directly modifying a passed in value
3618- * !!! \warning
3619- * To generate a unique property ID using the same label make sure to insert
3594+ * \warning To generate a unique property ID using the same label make sure to insert
36203595 * a `#` at the beginning. It will not be shown but guarantees correct behavior.
36213596 *
36223597 * ```c
@@ -3640,8 +3615,7 @@ NK_API nk_bool nk_property_float(struct nk_context*, const char *name, float min
36403615/**
36413616 * # # nk_property_double
36423617 * Double property directly modifying a passed in value
3643- * !!! \warning
3644- * To generate a unique property ID using the same label make sure to insert
3618+ * \warning To generate a unique property ID using the same label make sure to insert
36453619 * a `#` at the beginning. It will not be shown but guarantees correct behavior.
36463620 *
36473621 * ```c
@@ -3665,8 +3639,7 @@ NK_API nk_bool nk_property_double(struct nk_context*, const char *name, double m
36653639/**
36663640 * # # nk_propertyi
36673641 * Integer property modifying a passed in value and returning the new value
3668- * !!! \warning
3669- * To generate a unique property ID using the same label make sure to insert
3642+ * \warning To generate a unique property ID using the same label make sure to insert
36703643 * a `#` at the beginning. It will not be shown but guarantees correct behavior.
36713644 *
36723645 * ```c
@@ -3688,8 +3661,7 @@ NK_API int nk_propertyi(struct nk_context*, const char *name, int min, int val,
36883661/**
36893662 * # # nk_propertyf
36903663 * Float property modifying a passed in value and returning the new value
3691- * !!! \warning
3692- * To generate a unique property ID using the same label make sure to insert
3664+ * \warning To generate a unique property ID using the same label make sure to insert
36933665 * a `#` at the beginning. It will not be shown but guarantees correct behavior.
36943666 *
36953667 * ```c
@@ -3711,8 +3683,7 @@ NK_API float nk_propertyf(struct nk_context*, const char *name, float min, float
37113683/**
37123684 * # # nk_propertyd
37133685 * Float property modifying a passed in value and returning the new value
3714- * !!! \warning
3715- * To generate a unique property ID using the same label make sure to insert
3686+ * \warning To generate a unique property ID using the same label make sure to insert
37163687 * a `#` at the beginning. It will not be shown but guarantees correct behavior.
37173688 *
37183689 * ```c
0 commit comments