diff --git a/imgui-binding/src/main/java/imgui/ImFont.java b/imgui-binding/src/main/java/imgui/ImFont.java index f712a2f..5095962 100644 --- a/imgui-binding/src/main/java/imgui/ImFont.java +++ b/imgui-binding/src/main/java/imgui/ImFont.java @@ -54,14 +54,14 @@ public final class ImFont implements ImDestroyable { // TODO IndexAdvanceX /** - * = FallbackGlyph->AdvanceX + * = FallbackGlyph.AdvanceX */ public native float getFallbackAdvanceX(); /* return IM_FONT->FallbackAdvanceX; */ /** - * = FallbackGlyph->AdvanceX + * = FallbackGlyph.AdvanceX */ public native void setFallbackAdvanceX(float fallbackAdvanceX); /* IM_FONT->FallbackAdvanceX = fallbackAdvanceX; diff --git a/imgui-binding/src/main/java/imgui/ImFontAtlas.java b/imgui-binding/src/main/java/imgui/ImFontAtlas.java index 224c4e3..403b67f 100644 --- a/imgui-binding/src/main/java/imgui/ImFontAtlas.java +++ b/imgui-binding/src/main/java/imgui/ImFontAtlas.java @@ -18,7 +18,7 @@ import java.nio.ByteOrder; * - If you pass a 'glyph_ranges' array to AddFont*** functions, you need to make sure that your array persist up until the * atlas is build (when calling GetTexData*** or Build()). We only copy the pointer, not the data. * - Important: By default, AddFontFromMemoryTTF() takes ownership of the data. Even though we are not writing to it, we will free the pointer on destruction. - * You can set font_cfg->FontDataOwnedByAtlas=false to keep ownership of your data and it won't be freed, + * You can set font_cfg.FontDataOwnedByAtlas=false to keep ownership of your data and it won't be freed, * - Even though many functions are suffixed with "TTF", OTF data is supported just as well. * - This is an old API and it is currently awkward for those and and various other reasons! We will address them in the future! */ @@ -124,7 +124,7 @@ public final class ImFontAtlas implements ImDestroyable { /** * Note: Transfer ownership of 'ttf_data' to ImFontAtlas! Will be deleted after destruction of the atlas. - * Set font_cfg->FontDataOwnedByAtlas=false to keep ownership of your data and it won't be freed. + * Set font_cfg.FontDataOwnedByAtlas=false to keep ownership of your data and it won't be freed. */ public ImFont addFontFromMemoryTTF(final byte[] fontData, final float sizePixels) { return new ImFont(nAddFontFromMemoryTTF(fontData, fontData.length, sizePixels)); @@ -137,7 +137,7 @@ public final class ImFontAtlas implements ImDestroyable { /** * Note: Transfer ownership of 'ttf_data' to ImFontAtlas! Will be deleted after destruction of the atlas. - * Set font_cfg->FontDataOwnedByAtlas=false to keep ownership of your data and it won't be freed. + * Set font_cfg.FontDataOwnedByAtlas=false to keep ownership of your data and it won't be freed. */ public ImFont addFontFromMemoryTTF(final byte[] fontData, final float sizePixels, final ImFontConfig imFontConfig) { return new ImFont(nAddFontFromMemoryTTF(fontData, fontData.length, sizePixels, imFontConfig.ptr)); @@ -149,7 +149,7 @@ public final class ImFontAtlas implements ImDestroyable { /** * Note: Transfer ownership of 'ttf_data' to ImFontAtlas! Will be deleted after destruction of the atlas. - * Set font_cfg->FontDataOwnedByAtlas=false to keep ownership of your data and it won't be freed. + * Set font_cfg.FontDataOwnedByAtlas=false to keep ownership of your data and it won't be freed. */ public ImFont addFontFromMemoryTTF(final byte[] fontData, final float sizePixels, final short[] glyphRanges) { return new ImFont(nAddFontFromMemoryTTF(fontData, fontData.length, sizePixels, glyphRanges)); @@ -161,7 +161,7 @@ public final class ImFontAtlas implements ImDestroyable { /** * Note: Transfer ownership of 'ttf_data' to ImFontAtlas! Will be deleted after destruction of the atlas. - * Set font_cfg->FontDataOwnedByAtlas=false to keep ownership of your data and it won't be freed. + * Set font_cfg.FontDataOwnedByAtlas=false to keep ownership of your data and it won't be freed. */ public ImFont addFontFromMemoryTTF(final byte[] fontData, final float sizePixels, final ImFontConfig imFontConfig, final short[] glyphRanges) { return new ImFont(nAddFontFromMemoryTTF(fontData, fontData.length, sizePixels, imFontConfig.ptr, glyphRanges)); @@ -445,14 +445,14 @@ public final class ImFontAtlas implements ImDestroyable { // Read docs/FONTS.txt for more details about using colorful icons. /** - * Id needs to be >= 0x110000. Id >= 0x80000000 are reserved for ImGui and ImDrawList + * Id needs to be {@code >=} 0x110000. Id {@code >=} 0x80000000 are reserved for ImGui and ImDrawList */ public native int addCustomRectRegular(int id, int width, int height); /* return IM_FONT_ATLAS->AddCustomRectRegular((unsigned int)id, width, height); */ /** - * Id needs to be < 0x110000 to register a rectangle to map into a specific font. + * Id needs to be {@code <} 0x110000 to register a rectangle to map into a specific font. */ public int addCustomRectFontGlyph(final ImFont imFont, final short id, final int width, final int height, final float advanceX) { return nAddCustomRectFontGlyph(imFont.ptr, id, width, height, advanceX); @@ -463,7 +463,7 @@ public final class ImFontAtlas implements ImDestroyable { */ /** - * Id needs to be < 0x110000 to register a rectangle to map into a specific font. + * Id needs to be {@code <} 0x110000 to register a rectangle to map into a specific font. */ public int addCustomRectFontGlyph(final ImFont imFont, final short id, final int width, final int height, final float advanceX, final float offsetX, final float offsetY) { return nAddCustomRectFontGlyph(imFont.ptr, id, width, height, advanceX, offsetX, offsetY); diff --git a/imgui-binding/src/main/java/imgui/ImFontConfig.java b/imgui-binding/src/main/java/imgui/ImFontConfig.java index c6e5a4f..1bae50a 100644 --- a/imgui-binding/src/main/java/imgui/ImFontConfig.java +++ b/imgui-binding/src/main/java/imgui/ImFontConfig.java @@ -284,14 +284,14 @@ public final class ImFontConfig implements ImDestroyable { */ /** - * Brighten (>1.0f) or darken (<1.0f) font output. Brightening small fonts may be a good workaround to make them more readable. + * Brighten ({@code >}1.0f) or darken ({@code <}1.0f) font output. Brightening small fonts may be a good workaround to make them more readable. */ public native float getRasterizerMultiply(); /* return IM_FONT_CONFIG->RasterizerMultiply; */ /** - * Brighten (>1.0f) or darken (<1.0f) font output. Brightening small fonts may be a good workaround to make them more readable. + * Brighten ({@code >}1.0f) or darken ({@code <}1.0f) font output. Brightening small fonts may be a good workaround to make them more readable. */ public native void setRasterizerMultiply(float rasterizerMultiply); /* IM_FONT_CONFIG->RasterizerMultiply = rasterizerMultiply; diff --git a/imgui-binding/src/main/java/imgui/ImGuiIO.java b/imgui-binding/src/main/java/imgui/ImGuiIO.java index fef192f..b22e1c9 100644 --- a/imgui-binding/src/main/java/imgui/ImGuiIO.java +++ b/imgui-binding/src/main/java/imgui/ImGuiIO.java @@ -313,7 +313,7 @@ public final class ImGuiIO { /** * Enable resizing of windows from their edges and from the lower-left corner. - * This requires (io.BackendFlags & ImGuiBackendFlags_HasMouseCursors) because it needs mouse cursor feedback. + * This requires (io.BackendFlags {@code &} ImGuiBackendFlags_HasMouseCursors) because it needs mouse cursor feedback. * (This used to be a per-window ImGuiWindowFlags_ResizeFromAnySide flag) */ public native boolean getConfigWindowsResizeFromEdges(); /* @@ -322,7 +322,7 @@ public final class ImGuiIO { /** * Enable resizing of windows from their edges and from the lower-left corner. - * This requires (io.BackendFlags & ImGuiBackendFlags_HasMouseCursors) because it needs mouse cursor feedback. + * This requires (io.BackendFlags {@code &} ImGuiBackendFlags_HasMouseCursors) because it needs mouse cursor feedback. * (This used to be a per-window ImGuiWindowFlags_ResizeFromAnySide flag) */ public native void setConfigWindowsResizeFromEdges(boolean configWindowsResizeFromEdges); /* diff --git a/imgui-binding/src/main/java/imgui/ImGuiStyle.java b/imgui-binding/src/main/java/imgui/ImGuiStyle.java index ad484f5..ccaa5f5 100644 --- a/imgui-binding/src/main/java/imgui/ImGuiStyle.java +++ b/imgui-binding/src/main/java/imgui/ImGuiStyle.java @@ -312,14 +312,14 @@ public final class ImGuiStyle implements ImDestroyable { */ /** - * Minimum horizontal spacing between two columns. Preferably > (FramePadding.x + 1). + * Minimum horizontal spacing between two columns. Preferably {@code >} (FramePadding.x + 1). */ public native float getColumnsMinSpacing(); /* return IMGUI_STYLE->ColumnsMinSpacing; */ /** - * Minimum horizontal spacing between two columns. Preferably > (FramePadding.x + 1). + * Minimum horizontal spacing between two columns. Preferably {@code >} (FramePadding.x + 1). */ public native void setColumnsMinSpacing(float columnsMinSpacing); /* IMGUI_STYLE->ColumnsMinSpacing = columnsMinSpacing; diff --git a/imgui-binding/src/main/java/imgui/enums/ImDrawListFlags.java b/imgui-binding/src/main/java/imgui/enums/ImDrawListFlags.java index 9b594d7..aca3b33 100644 --- a/imgui-binding/src/main/java/imgui/enums/ImDrawListFlags.java +++ b/imgui-binding/src/main/java/imgui/enums/ImDrawListFlags.java @@ -15,7 +15,7 @@ public final class ImDrawListFlags { */ public static final int AntiAliasedFill = 1 << 1; /** - * Can emit 'VtxOffset > 0' to allow large meshes. Set when 'ImGuiBackendFlags_RendererHasVtxOffset' is enabled. + * Can emit 'VtxOffset {@code >} 0' to allow large meshes. Set when 'ImGuiBackendFlags_RendererHasVtxOffset' is enabled. */ public static final int AllowVtxOffset = 1 << 2; } diff --git a/imgui-binding/src/main/java/imgui/enums/ImGuiTabBarFlags.java b/imgui-binding/src/main/java/imgui/enums/ImGuiTabBarFlags.java index 3957443..4162a52 100644 --- a/imgui-binding/src/main/java/imgui/enums/ImGuiTabBarFlags.java +++ b/imgui-binding/src/main/java/imgui/enums/ImGuiTabBarFlags.java @@ -22,7 +22,7 @@ public final class ImGuiTabBarFlags { public static final int TabListPopupButton = 1 << 2; /** * Disable behavior of closing tabs (that are submitted with p_open != NULL) with middle mouse button. - * You can still repro this behavior on user's side with if (IsItemHovered() && IsMouseClicked(2)) *p_open = false. + * You can still repro this behavior on user's side with if (IsItemHovered() {@code &&} IsMouseClicked(2)) *p_open = false. */ public static final int NoCloseWithMiddleMouseButton = 1 << 3; /** diff --git a/imgui-binding/src/main/java/imgui/enums/ImGuiTabItemFlags.java b/imgui-binding/src/main/java/imgui/enums/ImGuiTabItemFlags.java index b6aa3d0..2718f4c 100644 --- a/imgui-binding/src/main/java/imgui/enums/ImGuiTabItemFlags.java +++ b/imgui-binding/src/main/java/imgui/enums/ImGuiTabItemFlags.java @@ -19,11 +19,11 @@ public final class ImGuiTabItemFlags { public static final int SetSelected = 1 << 1; /** * Disable behavior of closing tabs (that are submitted with p_open != NULL) with middle mouse button. - * You can still repro this behavior on user's side with if (IsItemHovered() && IsMouseClicked(2)) *p_open = false. + * You can still repro this behavior on user's side with if (IsItemHovered() {@code &&} IsMouseClicked(2)) *p_open = false. */ public static final int NoCloseWithMiddleMouseButton = 1 << 2; /** - * Don't call PushID(tab->ID)/PopID() on BeginTabItem()/EndTabItem() + * Don't call PushID(tab.ID)/PopID() on BeginTabItem()/EndTabItem() */ public static final int NoPushId = 1 << 3; } diff --git a/imgui-binding/src/main/java/imgui/enums/ImGuiWindowFlags.java b/imgui-binding/src/main/java/imgui/enums/ImGuiWindowFlags.java index ab0d3a3..0915c4a 100644 --- a/imgui-binding/src/main/java/imgui/enums/ImGuiWindowFlags.java +++ b/imgui-binding/src/main/java/imgui/enums/ImGuiWindowFlags.java @@ -62,11 +62,11 @@ public final class ImGuiWindowFlags { */ public static final int NoBringToFrontOnFocus = 1 << 13; /** - * Always show vertical scrollbar (even if ContentSize.y < Size.y) + * Always show vertical scrollbar (even if ContentSize.y {@code <} Size.y) */ public static final int AlwaysVerticalScrollbar = 1 << 14; /** - * Always show horizontal scrollbar (even if ContentSize.x < Size.x) + * Always show horizontal scrollbar (even if ContentSize.x {@code <} Size.x) */ public static final int AlwaysHorizontalScrollbar = 1 << 15; /**