Browse Source

Comments about IMGUI_DISABLE_TEST_WINDOWS (#1240, #169)

omar 8 years ago
parent
commit
100d30a0a1
2 changed files with 12 additions and 4 deletions
  1. 2 1
      imconfig.h
  2. 10 3
      imgui_demo.cpp

+ 2 - 1
imconfig.h

@@ -20,7 +20,8 @@
 //#define IMGUI_DISABLE_WIN32_DEFAULT_CLIPBOARD_FUNCS
 //#define IMGUI_DISABLE_WIN32_DEFAULT_IME_FUNCS
 
-//---- Don't implement help and test window functionality (ShowUserGuide()/ShowStyleEditor()/ShowTestWindow() methods will be empty)
+//---- Don't implement test window functionality (ShowTestWindow()/ShowStyleEditor()/ShowUserGuide() methods will be empty)
+//---- It is very strongly recommended to NOT disable the test windows. Please read the comment at the top of imgui_demo.cpp to learn why.
 //#define IMGUI_DISABLE_TEST_WINDOWS
 
 //---- Don't define obsolete functions names

+ 10 - 3
imgui_demo.cpp

@@ -2,10 +2,17 @@
 // (demo code)
 
 // Message to the person tempted to delete this file when integrating ImGui into their code base:
-// Do NOT remove this file from your project! It is useful reference code that you and other users will want to refer to.
+// Don't do it! Do NOT remove this file from your project! It is useful reference code that you and other users will want to refer to.
 // Everything in this file will be stripped out by the linker if you don't call ImGui::ShowTestWindow().
-// During development, you can call ImGui::ShowTestWindow() in your code to learn about various features of ImGui.
-// Removing this file from your project is hindering your access to documentation, likely leading you to poorer usage of the library.
+// During development, you can call ImGui::ShowTestWindow() in your code to learn about various features of ImGui. Have it wired in a debug menu!
+// Removing this file from your project is hindering access to documentation for everyone in your team, likely leading you to poorer usage of the library.
+
+// Note that you can #define IMGUI_DISABLE_TEST_WINDOWS in imconfig.h for the same effect.
+// If you want to link core ImGui in your public builds but not those test windows, #define IMGUI_DISABLE_TEST_WINDOWS in imconfig.h and those functions will be empty.
+// For any other case, if you have ImGui available you probably want this to be available for reference and execution.
+
+// Thank you,
+// -Your beloved friend, imgui_demo.cpp (that you won't delete)
 
 #if defined(_MSC_VER) && !defined(_CRT_SECURE_NO_WARNINGS)
 #define _CRT_SECURE_NO_WARNINGS