Skip to content

Commit 2c66c8d

Browse files
committed
[Doc] Fix javadocs
1 parent a97242e commit 2c66c8d

File tree

7 files changed

+9
-9
lines changed

7 files changed

+9
-9
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# imgui-java
2-
[![Build Status](https://travis-ci.org/SpaiR/imgui-java.svg?branch=master)](https://travis-ci.org/SpaiR/imgui-java) [![javadoc](https://javadoc.io/badge2/io.imgui.java/binding/javadoc.svg)](https://javadoc.io/doc/io.imgui.java/binding) [![JCenter](https://img.shields.io/bintray/v/spair/io.imgui.java/binding.svg?label=binding)](https://bintray.com/spair/io.imgui.java/binding/_latestVersion) [![JCenter](https://img.shields.io/bintray/v/spair/io.imgui.java/lwjgl3.svg?label=lwjgl3)](https://bintray.com/spair/io.imgui.java/lwjgl3/_latestVersion)
2+
[![Build Status](https://travis-ci.org/SpaiR/imgui-java.svg?branch=master)](https://travis-ci.org/SpaiR/imgui-java) [![javadoc](https://javadoc.io/badge2/io.imgui.java/imgui-java-binding/javadoc.svg)](https://javadoc.io/doc/io.imgui.java/imgui-java-binding) [![JCenter](https://img.shields.io/bintray/v/spair/io.imgui.java/imgui-java-binding.svg?label=binding)](https://bintray.com/spair/io.imgui.java/imgui-java-binding/_latestVersion) [![JCenter](https://img.shields.io/bintray/v/spair/io.imgui.java/imgui-java-lwjgl3.svg?label=lwjgl3)](https://bintray.com/spair/io.imgui.java/imgui-java-lwjgl3/_latestVersion)
33

44
JNI based binding for [Dear ImGui](https://github.com/ocornut/imgui) with no dependencies, ready to use pre-compiled binaries and renderer for [LWJGL3](https://www.lwjgl.org/).
55

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -654,7 +654,7 @@ void setClipboardTextStub(void* userData, const char* text) {
654654

655655
/**
656656
* Disable default OS parenting to main viewport for secondary viewports.
657-
* By default, viewports are marked with ParentViewportId = <main_viewport>,
657+
* By default, viewports are marked with ParentViewportId = main_viewport,
658658
* expecting the platform back-end to setup a parent/child relationship between the OS windows (some back-end may ignore this).
659659
* Set to true if you want the default to be 0, then all viewports will be top-level OS windows.
660660
*/
@@ -664,7 +664,7 @@ void setClipboardTextStub(void* userData, const char* text) {
664664

665665
/**
666666
* Disable default OS parenting to main viewport for secondary viewports.
667-
* By default, viewports are marked with ParentViewportId = <main_viewport>,
667+
* By default, viewports are marked with ParentViewportId = main_viewport,
668668
* expecting the platform back-end to setup a parent/child relationship between the OS windows (some back-end may ignore this).
669669
* Set to true if you want the default to be 0, then all viewports will be top-level OS windows.
670670
*/

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
* About the coordinates system:
2424
* - When multi-viewports are enabled, all Dear ImGui coordinates become absolute coordinates (same as OS coordinates!)
2525
* - So e.g. ImGui::SetNextWindowPos(ImVec2(0,0)) will position a window relative to your primary monitor!
26-
* - If you want to position windows relative to your main application viewport, use ImGui::GetMainViewport()->Pos as a base position.
26+
* - If you want to position windows relative to your main application viewport, use ImGui::GetMainViewport().Pos as a base position.
2727
* Steps to use multi-viewports in your application, when using a default back-end from the examples/ folder:
2828
* - Application: Enable feature with 'io.ConfigFlags |= ImGuiConfigFlags_ViewportsEnable'.
2929
* - Back-end: The back-end initialization will setup all necessary ImGuiPlatformIO's functions and update monitors info every frame.
@@ -471,7 +471,7 @@ void RendererStubSetWindowSize(ImGuiViewport* vp, ImVec2 pos) {
471471

472472
/**
473473
* // . . . R . // (Optional) Clear framebuffer, setup render target,
474-
* then render the viewport->DrawData. 'render_arg' is the value passed to RenderPlatformWindowsDefault().
474+
* then render the viewport.DrawData. 'render_arg' is the value passed to RenderPlatformWindowsDefault().
475475
*/
476476
public native void setRendererRenderWindow(ImPlatformFuncViewport func); /*
477477
IM_RENDERER_FUNC_VIEWPORT_METHOD_TMPL(RenderWindow)

imgui-binding/src/main/java/imgui/callback/ImPlatformFuncViewportSuppBoolean.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
import imgui.ImGuiViewport;
44

55
/**
6-
* Callback to represent ImGuiPlatformIO function with args: (ImGuiViewport*) -> Boolean
6+
* Callback to represent ImGuiPlatformIO function with args: (ImGuiViewport*) - Boolean
77
*/
88
public abstract class ImPlatformFuncViewportSuppBoolean {
99
public abstract boolean get(ImGuiViewport vp);

imgui-binding/src/main/java/imgui/callback/ImPlatformFuncViewportSuppFloat.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
import imgui.ImGuiViewport;
44

55
/**
6-
* Callback to represent ImGuiPlatformIO function with args: (ImGuiViewport*) -> Boolean
6+
* Callback to represent ImGuiPlatformIO function with args: (ImGuiViewport*) - Boolean
77
*/
88
public abstract class ImPlatformFuncViewportSuppFloat {
99
public abstract float get(ImGuiViewport vp);

imgui-binding/src/main/java/imgui/callback/ImPlatformFuncViewportSuppImVec2.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
import imgui.ImVec2;
55

66
/**
7-
* Callback to represent ImGuiPlatformIO function with args: (ImGuiViewport*) -> ImVec2
7+
* Callback to represent ImGuiPlatformIO function with args: (ImGuiViewport*) - ImVec2
88
*/
99
public abstract class ImPlatformFuncViewportSuppImVec2 {
1010
public abstract void get(ImGuiViewport vp, ImVec2 dstImVec2);

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ private ImDrawListFlags() {
2222
*/
2323
public static final int AntiAliasedFill = 1 << 2;
2424
/**
25-
* Can emit 'VtxOffset > 0' to allow large meshes. Set when 'ImGuiBackendFlags_RendererHasVtxOffset' is enabled.
25+
* Can emit 'VtxOffset {@code >} 0' to allow large meshes. Set when 'ImGuiBackendFlags_RendererHasVtxOffset' is enabled.
2626
*/
2727
public static final int AllowVtxOffset = 1 << 3;
2828
}

0 commit comments

Comments
 (0)