From 94ec3d534e8937c588c5f0aeff83fd75cb9b2a1b Mon Sep 17 00:00:00 2001 From: ocornut Date: Sun, 29 Nov 2015 11:25:15 +0000 Subject: [PATCH] Examples: Header comments. --- examples/allegro5_example/imgui_impl_a5.h | 4 ++-- examples/allegro5_example/main.cpp | 1 + examples/directx11_example/imgui_impl_dx11.h | 4 ++-- examples/directx11_example/main.cpp | 1 + examples/directx9_example/imgui_impl_dx9.h | 4 ++-- examples/directx9_example/main.cpp | 1 + examples/marmalade_example/imgui_impl_marmalade.cpp | 5 +++-- examples/marmalade_example/imgui_impl_marmalade.h | 9 +++++---- examples/marmalade_example/main.cpp | 3 ++- examples/opengl3_example/imgui_impl_glfw_gl3.h | 4 ++-- examples/opengl3_example/main.cpp | 1 + examples/opengl_example/imgui_impl_glfw.h | 6 +++--- examples/opengl_example/main.cpp | 1 + examples/sdl_opengl3_example/imgui_impl_sdl_gl3.h | 4 ++-- examples/sdl_opengl3_example/main.cpp | 1 + examples/sdl_opengl_example/imgui_impl_sdl.h | 4 ++-- examples/sdl_opengl_example/main.cpp | 1 + 17 files changed, 32 insertions(+), 22 deletions(-) diff --git a/examples/allegro5_example/imgui_impl_a5.h b/examples/allegro5_example/imgui_impl_a5.h index ec10fff1..721f510e 100644 --- a/examples/allegro5_example/imgui_impl_a5.h +++ b/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 diff --git a/examples/allegro5_example/main.cpp b/examples/allegro5_example/main.cpp index a901e8c3..ee89c7cb 100644 --- a/examples/allegro5_example/main.cpp +++ b/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 #include diff --git a/examples/directx11_example/imgui_impl_dx11.h b/examples/directx11_example/imgui_impl_dx11.h index e5d44600..1145b897 100644 --- a/examples/directx11_example/imgui_impl_dx11.h +++ b/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; diff --git a/examples/directx11_example/main.cpp b/examples/directx11_example/main.cpp index 1a1d6702..5b38af6d 100644 --- a/examples/directx11_example/main.cpp +++ b/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 #include "imgui_impl_dx11.h" diff --git a/examples/directx9_example/imgui_impl_dx9.h b/examples/directx9_example/imgui_impl_dx9.h index 608626fb..0681b376 100644 --- a/examples/directx9_example/imgui_impl_dx9.h +++ b/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; diff --git a/examples/directx9_example/main.cpp b/examples/directx9_example/main.cpp index ab4839a9..99be4e84 100644 --- a/examples/directx9_example/main.cpp +++ b/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 #include "imgui_impl_dx9.h" diff --git a/examples/marmalade_example/imgui_impl_marmalade.cpp b/examples/marmalade_example/imgui_impl_marmalade.cpp index 65109e41..9f1c9a49 100644 --- a/examples/marmalade_example/imgui_impl_marmalade.cpp +++ b/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 #include "imgui_impl_marmalade.h" diff --git a/examples/marmalade_example/imgui_impl_marmalade.h b/examples/marmalade_example/imgui_impl_marmalade.h index 404556ea..cad73661 100644 --- a/examples/marmalade_example/imgui_impl_marmalade.h +++ b/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(); diff --git a/examples/marmalade_example/main.cpp b/examples/marmalade_example/main.cpp index b0ca2824..c49aa844 100644 --- a/examples/marmalade_example/main.cpp +++ b/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 #include "imgui_impl_marmalade.h" diff --git a/examples/opengl3_example/imgui_impl_glfw_gl3.h b/examples/opengl3_example/imgui_impl_glfw_gl3.h index 33e01c30..818b9ffc 100644 --- a/examples/opengl3_example/imgui_impl_glfw_gl3.h +++ b/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; diff --git a/examples/opengl3_example/main.cpp b/examples/opengl3_example/main.cpp index 39354de9..fb06b2a2 100644 --- a/examples/opengl3_example/main.cpp +++ b/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 #include "imgui_impl_glfw_gl3.h" diff --git a/examples/opengl_example/imgui_impl_glfw.h b/examples/opengl_example/imgui_impl_glfw.h index 05fe6b05..7c1efeef 100644 --- a/examples/opengl_example/imgui_impl_glfw.h +++ b/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; diff --git a/examples/opengl_example/main.cpp b/examples/opengl_example/main.cpp index b6d8dbdc..a844db52 100644 --- a/examples/opengl_example/main.cpp +++ b/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 #include "imgui_impl_glfw.h" diff --git a/examples/sdl_opengl3_example/imgui_impl_sdl_gl3.h b/examples/sdl_opengl3_example/imgui_impl_sdl_gl3.h index ef4757cc..3bbd0a7d 100644 --- a/examples/sdl_opengl3_example/imgui_impl_sdl_gl3.h +++ b/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; diff --git a/examples/sdl_opengl3_example/main.cpp b/examples/sdl_opengl3_example/main.cpp index 4c5d2ee4..5279ed27 100644 --- a/examples/sdl_opengl3_example/main.cpp +++ b/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 #include "imgui_impl_sdl_gl3.h" diff --git a/examples/sdl_opengl_example/imgui_impl_sdl.h b/examples/sdl_opengl_example/imgui_impl_sdl.h index cef9817c..cb65c3b4 100644 --- a/examples/sdl_opengl_example/imgui_impl_sdl.h +++ b/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; diff --git a/examples/sdl_opengl_example/main.cpp b/examples/sdl_opengl_example/main.cpp index a87d0247..f2fbad90 100644 --- a/examples/sdl_opengl_example/main.cpp +++ b/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 #include "imgui_impl_sdl.h"