Explorar el Código

Examples: Header comments.

ocornut hace 9 años
padre
commit
94ec3d534e

+ 2 - 2
examples/allegro5_example/imgui_impl_a5.h

@@ -1,7 +1,7 @@
 // ImGui Allegro 5 bindings
-// You can copy and use unmodified imgui_impl_* files in your project. 
+// You can copy and use unmodified imgui_impl_* files in your project. See main.cpp for an example of using this.
 // If you use this binding you'll need to call 4 functions: ImGui_ImplXXXX_Init(), ImGui_ImplXXXX_NewFrame(), ImGui::Render() and ImGui_ImplXXXX_Shutdown().
-// See main.cpp for an example of using this.
+// If you are new to ImGui, see examples/README.txt and documentation at the top of imgui.cpp.
 // https://github.com/ocornut/imgui
 // by @birthggd
 

+ 1 - 0
examples/allegro5_example/main.cpp

@@ -1,4 +1,5 @@
 // ImGui - standalone example application for Allegro 5
+// If you are new to ImGui, see examples/README.txt and documentation at the top of imgui.cpp.
 
 #include <stdint.h>
 #include <allegro5/allegro.h>

+ 2 - 2
examples/directx11_example/imgui_impl_dx11.h

@@ -1,7 +1,7 @@
 // ImGui Win32 + DirectX11 binding
-// You can copy and use unmodified imgui_impl_* files in your project. 
+// You can copy and use unmodified imgui_impl_* files in your project. See main.cpp for an example of using this.
 // If you use this binding you'll need to call 4 functions: ImGui_ImplXXXX_Init(), ImGui_ImplXXXX_NewFrame(), ImGui::Render() and ImGui_ImplXXXX_Shutdown().
-// See main.cpp for an example of using this.
+// If you are new to ImGui, see examples/README.txt and documentation at the top of imgui.cpp.
 // https://github.com/ocornut/imgui
 
 struct ID3D11Device;

+ 1 - 0
examples/directx11_example/main.cpp

@@ -1,4 +1,5 @@
 // ImGui - standalone example application for DirectX 11
+// If you are new to ImGui, see examples/README.txt and documentation at the top of imgui.cpp.
 
 #include <imgui.h>
 #include "imgui_impl_dx11.h"

+ 2 - 2
examples/directx9_example/imgui_impl_dx9.h

@@ -1,7 +1,7 @@
 // ImGui Win32 + DirectX9 binding
-// You can copy and use unmodified imgui_impl_* files in your project. 
+// You can copy and use unmodified imgui_impl_* files in your project. See main.cpp for an example of using this.
 // If you use this binding you'll need to call 4 functions: ImGui_ImplXXXX_Init(), ImGui_ImplXXXX_NewFrame(), ImGui::Render() and ImGui_ImplXXXX_Shutdown().
-// See main.cpp for an example of using this.
+// If you are new to ImGui, see examples/README.txt and documentation at the top of imgui.cpp.
 // https://github.com/ocornut/imgui
 
 struct IDirect3DDevice9;

+ 1 - 0
examples/directx9_example/main.cpp

@@ -1,4 +1,5 @@
 // ImGui - standalone example application for DirectX 9
+// If you are new to ImGui, see examples/README.txt and documentation at the top of imgui.cpp.
 
 #include <imgui.h>
 #include "imgui_impl_dx9.h"

+ 3 - 2
examples/marmalade_example/imgui_impl_marmalade.cpp

@@ -1,11 +1,12 @@
 // ImGui Marmalade binding with IwGx
-// Copyright (C) 2015 by Giovanni Zito
-// This file is part of ImGui
 // You can copy and use unmodified imgui_impl_* files in your project. See main.cpp for an example of using this.
 // If you use this binding you'll need to call 4 functions: ImGui_ImplXXXX_Init(), ImGui_ImplXXXX_NewFrame(), ImGui::Render() and ImGui_ImplXXXX_Shutdown().
 // If you are new to ImGui, see examples/README.txt and documentation at the top of imgui.cpp.
 // https://github.com/ocornut/imgui
 
+// Copyright (C) 2015 by Giovanni Zito
+// This file is part of ImGui
+
 #include <imgui.h>
 #include "imgui_impl_marmalade.h"
 

+ 5 - 4
examples/marmalade_example/imgui_impl_marmalade.h

@@ -1,10 +1,11 @@
 // ImGui Marmalade binding with IwGx
+// You can copy and use unmodified imgui_impl_* files in your project. See main.cpp for an example of using this.
+// If you use this binding you'll need to call 4 functions: ImGui_ImplXXXX_Init(), ImGui_ImplXXXX_NewFrame(), ImGui::Render() and ImGui_ImplXXXX_Shutdown().
+// If you are new to ImGui, see examples/README.txt and documentation at the top of imgui.cpp.
+// https://github.com/ocornut/imgui
+
 // Copyright (C) 2015 by Giovanni Zito
 // This file is part of ImGui
-// You can copy and use unmodified imgui_impl_* files in your project. 
-// If you use this binding you'll need to call 4 functions: ImGui_ImplXXXX_Init(), ImGui_ImplXXXX_NewFrame(), ImGui::Render() and ImGui_ImplXXXX_Shutdown(). 
-// See main.cpp for an example of using this.
-// https://github.com/ocornut/imgui
 
 IMGUI_API bool        ImGui_Marmalade_Init(bool install_callbacks);
 IMGUI_API void        ImGui_Marmalade_Shutdown();

+ 2 - 1
examples/marmalade_example/main.cpp

@@ -1,7 +1,8 @@
 // ImGui - standalone example application for Marmalade
+// If you are new to ImGui, see examples/README.txt and documentation at the top of imgui.cpp.
+
 // Copyright (C) 2015 by Giovanni Zito
 // This file is part of ImGui
-// https://github.com/ocornut/imgui
 
 #include <imgui.h>
 #include "imgui_impl_marmalade.h"

+ 2 - 2
examples/opengl3_example/imgui_impl_glfw_gl3.h

@@ -1,7 +1,7 @@
 // ImGui GLFW binding with OpenGL3 + shaders
-// You can copy and use unmodified imgui_impl_* files in your project. 
+// You can copy and use unmodified imgui_impl_* files in your project. See main.cpp for an example of using this.
 // If you use this binding you'll need to call 4 functions: ImGui_ImplXXXX_Init(), ImGui_ImplXXXX_NewFrame(), ImGui::Render() and ImGui_ImplXXXX_Shutdown().
-// See main.cpp for an example of using this.
+// If you are new to ImGui, see examples/README.txt and documentation at the top of imgui.cpp.
 // https://github.com/ocornut/imgui
 
 struct GLFWwindow;

+ 1 - 0
examples/opengl3_example/main.cpp

@@ -1,4 +1,5 @@
 // ImGui - standalone example application for Glfw + OpenGL 3, using programmable pipeline
+// If you are new to ImGui, see examples/README.txt and documentation at the top of imgui.cpp.
 
 #include <imgui.h>
 #include "imgui_impl_glfw_gl3.h"

+ 3 - 3
examples/opengl_example/imgui_impl_glfw.h

@@ -1,7 +1,7 @@
 // ImGui GLFW binding with OpenGL
-// You can copy and use unmodified imgui_impl_* files in your project. 
-// If you use this binding you'll need to call 4 functions: ImGui_ImplXXXX_Init(), ImGui_ImplXXXX_NewFrame(), ImGui::Render() and ImGui_ImplXXXX_Shutdown(). 
-// See main.cpp for an example of using this.
+// You can copy and use unmodified imgui_impl_* files in your project. See main.cpp for an example of using this.
+// If you use this binding you'll need to call 4 functions: ImGui_ImplXXXX_Init(), ImGui_ImplXXXX_NewFrame(), ImGui::Render() and ImGui_ImplXXXX_Shutdown().
+// If you are new to ImGui, see examples/README.txt and documentation at the top of imgui.cpp.
 // https://github.com/ocornut/imgui
 
 struct GLFWwindow;

+ 1 - 0
examples/opengl_example/main.cpp

@@ -1,4 +1,5 @@
 // ImGui - standalone example application for Glfw + OpenGL 2, using fixed pipeline
+// If you are new to ImGui, see examples/README.txt and documentation at the top of imgui.cpp.
 
 #include <imgui.h>
 #include "imgui_impl_glfw.h"

+ 2 - 2
examples/sdl_opengl3_example/imgui_impl_sdl_gl3.h

@@ -1,7 +1,7 @@
 // ImGui SDL2 binding with OpenGL3
-// You can copy and use unmodified imgui_impl_* files in your project. 
+// You can copy and use unmodified imgui_impl_* files in your project. See main.cpp for an example of using this.
 // If you use this binding you'll need to call 4 functions: ImGui_ImplXXXX_Init(), ImGui_ImplXXXX_NewFrame(), ImGui::Render() and ImGui_ImplXXXX_Shutdown().
-// See main.cpp for an example of using this.
+// If you are new to ImGui, see examples/README.txt and documentation at the top of imgui.cpp.
 // https://github.com/ocornut/imgui
 
 struct SDL_Window;

+ 1 - 0
examples/sdl_opengl3_example/main.cpp

@@ -1,4 +1,5 @@
 // ImGui - standalone example application for SDL2 + OpenGL
+// If you are new to ImGui, see examples/README.txt and documentation at the top of imgui.cpp.
 
 #include <imgui.h>
 #include "imgui_impl_sdl_gl3.h"

+ 2 - 2
examples/sdl_opengl_example/imgui_impl_sdl.h

@@ -1,7 +1,7 @@
 // ImGui SDL2 binding with OpenGL
-// You can copy and use unmodified imgui_impl_* files in your project. 
+// You can copy and use unmodified imgui_impl_* files in your project. See main.cpp for an example of using this.
 // If you use this binding you'll need to call 4 functions: ImGui_ImplXXXX_Init(), ImGui_ImplXXXX_NewFrame(), ImGui::Render() and ImGui_ImplXXXX_Shutdown().
-// See main.cpp for an example of using this.
+// If you are new to ImGui, see examples/README.txt and documentation at the top of imgui.cpp.
 // https://github.com/ocornut/imgui
 
 struct SDL_Window;

+ 1 - 0
examples/sdl_opengl_example/main.cpp

@@ -1,4 +1,5 @@
 // ImGui - standalone example application for SDL2 + OpenGL
+// If you are new to ImGui, see examples/README.txt and documentation at the top of imgui.cpp.
 
 #include <imgui.h>
 #include "imgui_impl_sdl.h"