Skip to content

Commit 162c1cd

Browse files
committed
Fix javadoc
1 parent 42262e1 commit 162c1cd

File tree

9 files changed

+22
-22
lines changed

9 files changed

+22
-22
lines changed

imgui-binding/src/main/java/imgui/ImFont.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -54,14 +54,14 @@ public void destroy() {
5454
// TODO IndexAdvanceX
5555

5656
/**
57-
* = FallbackGlyph->AdvanceX
57+
* = FallbackGlyph.AdvanceX
5858
*/
5959
public native float getFallbackAdvanceX(); /*
6060
return IM_FONT->FallbackAdvanceX;
6161
*/
6262

6363
/**
64-
* = FallbackGlyph->AdvanceX
64+
* = FallbackGlyph.AdvanceX
6565
*/
6666
public native void setFallbackAdvanceX(float fallbackAdvanceX); /*
6767
IM_FONT->FallbackAdvanceX = fallbackAdvanceX;

imgui-binding/src/main/java/imgui/ImFontAtlas.java

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
* - If you pass a 'glyph_ranges' array to AddFont*** functions, you need to make sure that your array persist up until the
1919
* atlas is build (when calling GetTexData*** or Build()). We only copy the pointer, not the data.
2020
* - Important: By default, AddFontFromMemoryTTF() takes ownership of the data. Even though we are not writing to it, we will free the pointer on destruction.
21-
* You can set font_cfg->FontDataOwnedByAtlas=false to keep ownership of your data and it won't be freed,
21+
* You can set font_cfg.FontDataOwnedByAtlas=false to keep ownership of your data and it won't be freed,
2222
* - Even though many functions are suffixed with "TTF", OTF data is supported just as well.
2323
* - This is an old API and it is currently awkward for those and and various other reasons! We will address them in the future!
2424
*/
@@ -124,7 +124,7 @@ public ImFont addFontFromFileTTF(final String filename, final float sizePixels,
124124

125125
/**
126126
* Note: Transfer ownership of 'ttf_data' to ImFontAtlas! Will be deleted after destruction of the atlas.
127-
* Set font_cfg->FontDataOwnedByAtlas=false to keep ownership of your data and it won't be freed.
127+
* Set font_cfg.FontDataOwnedByAtlas=false to keep ownership of your data and it won't be freed.
128128
*/
129129
public ImFont addFontFromMemoryTTF(final byte[] fontData, final float sizePixels) {
130130
return new ImFont(nAddFontFromMemoryTTF(fontData, fontData.length, sizePixels));
@@ -137,7 +137,7 @@ public ImFont addFontFromMemoryTTF(final byte[] fontData, final float sizePixels
137137

138138
/**
139139
* Note: Transfer ownership of 'ttf_data' to ImFontAtlas! Will be deleted after destruction of the atlas.
140-
* Set font_cfg->FontDataOwnedByAtlas=false to keep ownership of your data and it won't be freed.
140+
* Set font_cfg.FontDataOwnedByAtlas=false to keep ownership of your data and it won't be freed.
141141
*/
142142
public ImFont addFontFromMemoryTTF(final byte[] fontData, final float sizePixels, final ImFontConfig imFontConfig) {
143143
return new ImFont(nAddFontFromMemoryTTF(fontData, fontData.length, sizePixels, imFontConfig.ptr));
@@ -149,7 +149,7 @@ public ImFont addFontFromMemoryTTF(final byte[] fontData, final float sizePixels
149149

150150
/**
151151
* Note: Transfer ownership of 'ttf_data' to ImFontAtlas! Will be deleted after destruction of the atlas.
152-
* Set font_cfg->FontDataOwnedByAtlas=false to keep ownership of your data and it won't be freed.
152+
* Set font_cfg.FontDataOwnedByAtlas=false to keep ownership of your data and it won't be freed.
153153
*/
154154
public ImFont addFontFromMemoryTTF(final byte[] fontData, final float sizePixels, final short[] glyphRanges) {
155155
return new ImFont(nAddFontFromMemoryTTF(fontData, fontData.length, sizePixels, glyphRanges));
@@ -161,7 +161,7 @@ public ImFont addFontFromMemoryTTF(final byte[] fontData, final float sizePixels
161161

162162
/**
163163
* Note: Transfer ownership of 'ttf_data' to ImFontAtlas! Will be deleted after destruction of the atlas.
164-
* Set font_cfg->FontDataOwnedByAtlas=false to keep ownership of your data and it won't be freed.
164+
* Set font_cfg.FontDataOwnedByAtlas=false to keep ownership of your data and it won't be freed.
165165
*/
166166
public ImFont addFontFromMemoryTTF(final byte[] fontData, final float sizePixels, final ImFontConfig imFontConfig, final short[] glyphRanges) {
167167
return new ImFont(nAddFontFromMemoryTTF(fontData, fontData.length, sizePixels, imFontConfig.ptr, glyphRanges));
@@ -445,14 +445,14 @@ public ByteBuffer getTexDataAsRGBA32(final ImInt outWidth, final ImInt outHeight
445445
// Read docs/FONTS.txt for more details about using colorful icons.
446446

447447
/**
448-
* Id needs to be >= 0x110000. Id >= 0x80000000 are reserved for ImGui and ImDrawList
448+
* Id needs to be {@code >=} 0x110000. Id {@code >=} 0x80000000 are reserved for ImGui and ImDrawList
449449
*/
450450
public native int addCustomRectRegular(int id, int width, int height); /*
451451
return IM_FONT_ATLAS->AddCustomRectRegular((unsigned int)id, width, height);
452452
*/
453453

454454
/**
455-
* Id needs to be < 0x110000 to register a rectangle to map into a specific font.
455+
* Id needs to be {@code <} 0x110000 to register a rectangle to map into a specific font.
456456
*/
457457
public int addCustomRectFontGlyph(final ImFont imFont, final short id, final int width, final int height, final float advanceX) {
458458
return nAddCustomRectFontGlyph(imFont.ptr, id, width, height, advanceX);
@@ -463,7 +463,7 @@ public int addCustomRectFontGlyph(final ImFont imFont, final short id, final int
463463
*/
464464

465465
/**
466-
* Id needs to be < 0x110000 to register a rectangle to map into a specific font.
466+
* Id needs to be {@code <} 0x110000 to register a rectangle to map into a specific font.
467467
*/
468468
public int addCustomRectFontGlyph(final ImFont imFont, final short id, final int width, final int height, final float advanceX, final float offsetX, final float offsetY) {
469469
return nAddCustomRectFontGlyph(imFont.ptr, id, width, height, advanceX, offsetX, offsetY);

imgui-binding/src/main/java/imgui/ImFontConfig.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -284,14 +284,14 @@ public void setGlyphRanges(final short[] glyphRanges) {
284284
*/
285285

286286
/**
287-
* Brighten (>1.0f) or darken (<1.0f) font output. Brightening small fonts may be a good workaround to make them more readable.
287+
* Brighten ({@code >}1.0f) or darken ({@code <}1.0f) font output. Brightening small fonts may be a good workaround to make them more readable.
288288
*/
289289
public native float getRasterizerMultiply(); /*
290290
return IM_FONT_CONFIG->RasterizerMultiply;
291291
*/
292292

293293
/**
294-
* Brighten (>1.0f) or darken (<1.0f) font output. Brightening small fonts may be a good workaround to make them more readable.
294+
* Brighten ({@code >}1.0f) or darken ({@code <}1.0f) font output. Brightening small fonts may be a good workaround to make them more readable.
295295
*/
296296
public native void setRasterizerMultiply(float rasterizerMultiply); /*
297297
IM_FONT_CONFIG->RasterizerMultiply = rasterizerMultiply;

imgui-binding/src/main/java/imgui/ImGuiIO.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -313,7 +313,7 @@ public void setFontDefault(final ImFont fontDefault) {
313313

314314
/**
315315
* Enable resizing of windows from their edges and from the lower-left corner.
316-
* This requires (io.BackendFlags & ImGuiBackendFlags_HasMouseCursors) because it needs mouse cursor feedback.
316+
* This requires (io.BackendFlags {@code &} ImGuiBackendFlags_HasMouseCursors) because it needs mouse cursor feedback.
317317
* (This used to be a per-window ImGuiWindowFlags_ResizeFromAnySide flag)
318318
*/
319319
public native boolean getConfigWindowsResizeFromEdges(); /*
@@ -322,7 +322,7 @@ public void setFontDefault(final ImFont fontDefault) {
322322

323323
/**
324324
* Enable resizing of windows from their edges and from the lower-left corner.
325-
* This requires (io.BackendFlags & ImGuiBackendFlags_HasMouseCursors) because it needs mouse cursor feedback.
325+
* This requires (io.BackendFlags {@code &} ImGuiBackendFlags_HasMouseCursors) because it needs mouse cursor feedback.
326326
* (This used to be a per-window ImGuiWindowFlags_ResizeFromAnySide flag)
327327
*/
328328
public native void setConfigWindowsResizeFromEdges(boolean configWindowsResizeFromEdges); /*

imgui-binding/src/main/java/imgui/ImGuiStyle.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -312,14 +312,14 @@ public void destroy() {
312312
*/
313313

314314
/**
315-
* Minimum horizontal spacing between two columns. Preferably > (FramePadding.x + 1).
315+
* Minimum horizontal spacing between two columns. Preferably {@code >} (FramePadding.x + 1).
316316
*/
317317
public native float getColumnsMinSpacing(); /*
318318
return IMGUI_STYLE->ColumnsMinSpacing;
319319
*/
320320

321321
/**
322-
* Minimum horizontal spacing between two columns. Preferably > (FramePadding.x + 1).
322+
* Minimum horizontal spacing between two columns. Preferably {@code >} (FramePadding.x + 1).
323323
*/
324324
public native void setColumnsMinSpacing(float columnsMinSpacing); /*
325325
IMGUI_STYLE->ColumnsMinSpacing = columnsMinSpacing;

imgui-binding/src/main/java/imgui/enums/ImDrawListFlags.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ private ImDrawListFlags() {
1515
*/
1616
public static final int AntiAliasedFill = 1 << 1;
1717
/**
18-
* Can emit 'VtxOffset > 0' to allow large meshes. Set when 'ImGuiBackendFlags_RendererHasVtxOffset' is enabled.
18+
* Can emit 'VtxOffset {@code >} 0' to allow large meshes. Set when 'ImGuiBackendFlags_RendererHasVtxOffset' is enabled.
1919
*/
2020
public static final int AllowVtxOffset = 1 << 2;
2121
}

imgui-binding/src/main/java/imgui/enums/ImGuiTabBarFlags.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ private ImGuiTabBarFlags() {
2222
public static final int TabListPopupButton = 1 << 2;
2323
/**
2424
* Disable behavior of closing tabs (that are submitted with p_open != NULL) with middle mouse button.
25-
* You can still repro this behavior on user's side with if (IsItemHovered() && IsMouseClicked(2)) *p_open = false.
25+
* You can still repro this behavior on user's side with if (IsItemHovered() {@code &&} IsMouseClicked(2)) *p_open = false.
2626
*/
2727
public static final int NoCloseWithMiddleMouseButton = 1 << 3;
2828
/**

imgui-binding/src/main/java/imgui/enums/ImGuiTabItemFlags.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,11 @@ private ImGuiTabItemFlags() {
1919
public static final int SetSelected = 1 << 1;
2020
/**
2121
* Disable behavior of closing tabs (that are submitted with p_open != NULL) with middle mouse button.
22-
* You can still repro this behavior on user's side with if (IsItemHovered() && IsMouseClicked(2)) *p_open = false.
22+
* You can still repro this behavior on user's side with if (IsItemHovered() {@code &&} IsMouseClicked(2)) *p_open = false.
2323
*/
2424
public static final int NoCloseWithMiddleMouseButton = 1 << 2;
2525
/**
26-
* Don't call PushID(tab->ID)/PopID() on BeginTabItem()/EndTabItem()
26+
* Don't call PushID(tab.ID)/PopID() on BeginTabItem()/EndTabItem()
2727
*/
2828
public static final int NoPushId = 1 << 3;
2929
}

imgui-binding/src/main/java/imgui/enums/ImGuiWindowFlags.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,11 +62,11 @@ private ImGuiWindowFlags() {
6262
*/
6363
public static final int NoBringToFrontOnFocus = 1 << 13;
6464
/**
65-
* Always show vertical scrollbar (even if ContentSize.y < Size.y)
65+
* Always show vertical scrollbar (even if ContentSize.y {@code <} Size.y)
6666
*/
6767
public static final int AlwaysVerticalScrollbar = 1 << 14;
6868
/**
69-
* Always show horizontal scrollbar (even if ContentSize.x < Size.x)
69+
* Always show horizontal scrollbar (even if ContentSize.x {@code <} Size.x)
7070
*/
7171
public static final int AlwaysHorizontalScrollbar = 1 << 15;
7272
/**

0 commit comments

Comments
 (0)