Browse Source

Clean up the script and documentation for doc build.

Yao Wei Tjong 姚伟忠 10 years ago
parent
commit
03fc1f13c5
2 changed files with 7 additions and 10 deletions
  1. 5 8
      Docs/CMakeLists.txt
  2. 2 2
      Docs/GettingStarted.dox

+ 5 - 8
Docs/CMakeLists.txt

@@ -41,15 +41,11 @@ endmacro ()
 unset (CMAKE_FIND_ROOT_PATH)
 # Find Doxygen and DOT packages
 if (URHO3D_DOCS)
-    set (DOXYGEN_OPT REQUIRED)
-else ()
-    set (DOXYGEN_OPT QUIET)
-endif ()
-find_package (Doxygen ${DOXYGEN_OPT})
-if (URHO3D_DOCS)
-    # It is not a fatal error when DOT is not found, instead just switching off the Doxygen's HAVE_DOT option
-    find_package_handle_standard_args (Dot REQUIRED_VARS DOXYGEN_DOT_EXECUTABLE)
+    set (REQUIRED REQUIRED)
 endif ()
+find_package (Doxygen ${REQUIRED})
+# It is not a error when DOT is not found, instead just switching off the Doxygen's HAVE_DOT option
+find_package_handle_standard_args (Dot REQUIRED_VARS DOXYGEN_DOT_EXECUTABLE)
 
 if (DOXYGEN_FOUND)      # When DOT is not found, the documentation build should still proceed without using DOT
     # Generate platform specific Doxyfile automatically
@@ -71,6 +67,7 @@ if (DOXYGEN_FOUND)      # When DOT is not found, the documentation build should
         endforeach ()
         if (MSVC_HELP)
             find_package (HTMLHelp)
+            # It is not a error when HTML help compiler is not found, instead just switching off the Doxygen's HHC option
             find_package_handle_standard_args (HTMLHelp REQUIRED_VARS HTML_HELP_COMPILER)
         endif ()
         configure_file (${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.in ${CMAKE_CURRENT_BINARY_DIR}/generated/Doxyfile)

+ 2 - 2
Docs/GettingStarted.dox

@@ -279,9 +279,9 @@ Urho3D should be built as a shared library if your application consists of multi
 
 \section Building_Docs Documentation build
 
-If "URHO3D_DOCS" build option is set then a normal build would not only build Urho3D binaries but also Urho3D documentation automatically. If the option is not set then the documentation can still be built by manually invoking 'make doc' command or using its equivalent built-in target in IDE.
+If "URHO3D_DOCS" or "URHO3D_DOCS_QUIET" build option is set then a normal build would not only build Urho3D binaries but also Urho3D documentation automatically. If the option is not set then the documentation can still be built by manually invoking 'make doc' command or using its equivalent built-in target in IDE.
 
-The prerequisites are Doxygen and Graphviz. Tools to dump the \ref ScriptAPI "AngelScript API" for the default \ref Script "scripting" subsystem and the \ref LuaScriptAPI "LuaScript API" (when the LuaScript subsystem is also enabled) are being built at the same time when all the native tools are built.
+The additional prerequisite for documentation build is Doxygen. Also Graphviz (optional) if you wish to generate graphical diagrams in the documentation. MSVC users on Windows host system may install HTML help compiler tool (optional) in order to get the compressed help file (*.chm). When optional tool is not available in the host system, the corresponding build process is skipped accordingly. The internal host tools to dump the \ref ScriptAPI "AngelScript API" for the default \ref Script "scripting" subsystem and the \ref LuaScriptAPI "LuaScript API" (when the LuaScript subsystem is also enabled) are being built at the same time when all the native tools are built. When the build tree is being configured not to build any host tools then the 'doc' target will simply instruct Doxygen to process the existing API dump files that are already pre-generated in the repository.
 
 \section Building_Clang_tools Clang-tools build (EXPERIMENTAL)