From 2c66c8d3c5acebfe846576e208699571eceba82d Mon Sep 17 00:00:00 2001 From: SpaiR Date: Mon, 31 Aug 2020 00:29:14 +0300 Subject: [PATCH] [Doc] Fix javadocs --- README.md | 2 +- imgui-binding/src/main/java/imgui/ImGuiIO.java | 4 ++-- imgui-binding/src/main/java/imgui/ImGuiPlatformIO.java | 4 ++-- .../imgui/callback/ImPlatformFuncViewportSuppBoolean.java | 2 +- .../java/imgui/callback/ImPlatformFuncViewportSuppFloat.java | 2 +- .../java/imgui/callback/ImPlatformFuncViewportSuppImVec2.java | 2 +- imgui-binding/src/main/java/imgui/flag/ImDrawListFlags.java | 2 +- 7 files changed, 9 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 9a415b2..7fa52f1 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ # imgui-java -[![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) +[![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) 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/). diff --git a/imgui-binding/src/main/java/imgui/ImGuiIO.java b/imgui-binding/src/main/java/imgui/ImGuiIO.java index 9e54a67..9d65d8e 100644 --- a/imgui-binding/src/main/java/imgui/ImGuiIO.java +++ b/imgui-binding/src/main/java/imgui/ImGuiIO.java @@ -654,7 +654,7 @@ public final class ImGuiIO { /** * Disable default OS parenting to main viewport for secondary viewports. - * By default, viewports are marked with ParentViewportId = , + * By default, viewports are marked with ParentViewportId = main_viewport, * expecting the platform back-end to setup a parent/child relationship between the OS windows (some back-end may ignore this). * Set to true if you want the default to be 0, then all viewports will be top-level OS windows. */ @@ -664,7 +664,7 @@ public final class ImGuiIO { /** * Disable default OS parenting to main viewport for secondary viewports. - * By default, viewports are marked with ParentViewportId = , + * By default, viewports are marked with ParentViewportId = main_viewport, * expecting the platform back-end to setup a parent/child relationship between the OS windows (some back-end may ignore this). * Set to true if you want the default to be 0, then all viewports will be top-level OS windows. */ diff --git a/imgui-binding/src/main/java/imgui/ImGuiPlatformIO.java b/imgui-binding/src/main/java/imgui/ImGuiPlatformIO.java index fd42d08..df042b4 100644 --- a/imgui-binding/src/main/java/imgui/ImGuiPlatformIO.java +++ b/imgui-binding/src/main/java/imgui/ImGuiPlatformIO.java @@ -23,7 +23,7 @@ import imgui.callback.ImPlatformFuncViewportSuppImVec2; * About the coordinates system: * - When multi-viewports are enabled, all Dear ImGui coordinates become absolute coordinates (same as OS coordinates!) * - So e.g. ImGui::SetNextWindowPos(ImVec2(0,0)) will position a window relative to your primary monitor! - * - If you want to position windows relative to your main application viewport, use ImGui::GetMainViewport()->Pos as a base position. + * - If you want to position windows relative to your main application viewport, use ImGui::GetMainViewport().Pos as a base position. * Steps to use multi-viewports in your application, when using a default back-end from the examples/ folder: * - Application: Enable feature with 'io.ConfigFlags |= ImGuiConfigFlags_ViewportsEnable'. * - Back-end: The back-end initialization will setup all necessary ImGuiPlatformIO's functions and update monitors info every frame. @@ -471,7 +471,7 @@ public final class ImGuiPlatformIO extends ImGuiStruct { /** * // . . . R . // (Optional) Clear framebuffer, setup render target, - * then render the viewport->DrawData. 'render_arg' is the value passed to RenderPlatformWindowsDefault(). + * then render the viewport.DrawData. 'render_arg' is the value passed to RenderPlatformWindowsDefault(). */ public native void setRendererRenderWindow(ImPlatformFuncViewport func); /* IM_RENDERER_FUNC_VIEWPORT_METHOD_TMPL(RenderWindow) diff --git a/imgui-binding/src/main/java/imgui/callback/ImPlatformFuncViewportSuppBoolean.java b/imgui-binding/src/main/java/imgui/callback/ImPlatformFuncViewportSuppBoolean.java index fd87715..30cae75 100644 --- a/imgui-binding/src/main/java/imgui/callback/ImPlatformFuncViewportSuppBoolean.java +++ b/imgui-binding/src/main/java/imgui/callback/ImPlatformFuncViewportSuppBoolean.java @@ -3,7 +3,7 @@ package imgui.callback; import imgui.ImGuiViewport; /** - * Callback to represent ImGuiPlatformIO function with args: (ImGuiViewport*) -> Boolean + * Callback to represent ImGuiPlatformIO function with args: (ImGuiViewport*) - Boolean */ public abstract class ImPlatformFuncViewportSuppBoolean { public abstract boolean get(ImGuiViewport vp); diff --git a/imgui-binding/src/main/java/imgui/callback/ImPlatformFuncViewportSuppFloat.java b/imgui-binding/src/main/java/imgui/callback/ImPlatformFuncViewportSuppFloat.java index 781f81a..67e4e7a 100644 --- a/imgui-binding/src/main/java/imgui/callback/ImPlatformFuncViewportSuppFloat.java +++ b/imgui-binding/src/main/java/imgui/callback/ImPlatformFuncViewportSuppFloat.java @@ -3,7 +3,7 @@ package imgui.callback; import imgui.ImGuiViewport; /** - * Callback to represent ImGuiPlatformIO function with args: (ImGuiViewport*) -> Boolean + * Callback to represent ImGuiPlatformIO function with args: (ImGuiViewport*) - Boolean */ public abstract class ImPlatformFuncViewportSuppFloat { public abstract float get(ImGuiViewport vp); diff --git a/imgui-binding/src/main/java/imgui/callback/ImPlatformFuncViewportSuppImVec2.java b/imgui-binding/src/main/java/imgui/callback/ImPlatformFuncViewportSuppImVec2.java index 33ecedc..1bfcafa 100644 --- a/imgui-binding/src/main/java/imgui/callback/ImPlatformFuncViewportSuppImVec2.java +++ b/imgui-binding/src/main/java/imgui/callback/ImPlatformFuncViewportSuppImVec2.java @@ -4,7 +4,7 @@ import imgui.ImGuiViewport; import imgui.ImVec2; /** - * Callback to represent ImGuiPlatformIO function with args: (ImGuiViewport*) -> ImVec2 + * Callback to represent ImGuiPlatformIO function with args: (ImGuiViewport*) - ImVec2 */ public abstract class ImPlatformFuncViewportSuppImVec2 { public abstract void get(ImGuiViewport vp, ImVec2 dstImVec2); diff --git a/imgui-binding/src/main/java/imgui/flag/ImDrawListFlags.java b/imgui-binding/src/main/java/imgui/flag/ImDrawListFlags.java index 7670845..d1aaecc 100644 --- a/imgui-binding/src/main/java/imgui/flag/ImDrawListFlags.java +++ b/imgui-binding/src/main/java/imgui/flag/ImDrawListFlags.java @@ -22,7 +22,7 @@ public final class ImDrawListFlags { */ public static final int AntiAliasedFill = 1 << 2; /** - * 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 << 3; }