Browse Source

Add support for help documentation generation for QtCreator.

Yao Wei Tjong 姚伟忠 11 years ago
parent
commit
e58e57776e
2 changed files with 11 additions and 11 deletions
  1. 1 1
      Docs/CMakeLists.txt
  2. 10 10
      Docs/Doxyfile.in

+ 1 - 1
Docs/CMakeLists.txt

@@ -47,7 +47,7 @@ if (DOXYGEN_FOUND)
         else ()
         else ()
             set (EXCLUDE_GRAPHICS_API OpenGL)
             set (EXCLUDE_GRAPHICS_API OpenGL)
         endif ()
         endif ()
-        foreach (IDE XCODE MSVC Eclipse)
+        foreach (IDE XCODE MSVC Eclipse CodeBlocks)
             enable_help (${IDE})
             enable_help (${IDE})
         endforeach ()
         endforeach ()
         configure_file (${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.in ${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile)
         configure_file (${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.in ${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile)

+ 10 - 10
Docs/Doxyfile.in

@@ -995,17 +995,17 @@ DOCSET_FEEDNAME        = "Urho3D Documentation"
 # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen 
 # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen 
 # will append .docset to the name.
 # will append .docset to the name.
 
 
-DOCSET_BUNDLE_ID       = com.github.urho3d.documentation.@CPACK_PACKAGE_VERSION_MAJOR@.@CPACK_PACKAGE_VERSION_MINOR@
+DOCSET_BUNDLE_ID       = com.github.urho3d.Urho3D.@URHO3D_VERSION@
 
 
 # When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify 
 # When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify 
 # the documentation publisher. This should be a reverse domain-name style 
 # the documentation publisher. This should be a reverse domain-name style 
 # string, e.g. com.mycompany.MyDocSet.documentation.
 # string, e.g. com.mycompany.MyDocSet.documentation.
 
 
-DOCSET_PUBLISHER_ID    = org.doxygen.Publisher
+DOCSET_PUBLISHER_ID    = com.github.urho3d.Urho3D
 
 
 # The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.
 # The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.
 
 
-DOCSET_PUBLISHER_NAME  = Publisher
+DOCSET_PUBLISHER_NAME  = urho3d
 
 
 # If the GENERATE_HTMLHELP tag is set to YES, additional index files 
 # If the GENERATE_HTMLHELP tag is set to YES, additional index files 
 # will be generated that can be used as input for tools like the 
 # will be generated that can be used as input for tools like the 
@@ -1019,14 +1019,14 @@ GENERATE_HTMLHELP      = @MSVC_HELP@
 # can add a path in front of the file if the result should not be 
 # can add a path in front of the file if the result should not be 
 # written to the html output directory.
 # written to the html output directory.
 
 
-CHM_FILE               = Urho3D_Documentation_@CPACK_PACKAGE_VERSION_MAJOR@_@CPACK_PACKAGE_VERSION_MINOR@.chm
+CHM_FILE               = Urho3D_Documentation_@URHO3D_VERSION@.chm
 
 
 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can 
 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can 
 # be used to specify the location (absolute path including file name) of 
 # be used to specify the location (absolute path including file name) of 
 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run 
 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run 
 # the HTML help compiler on the generated index.hhp.
 # the HTML help compiler on the generated index.hhp.
 
 
-HHC_LOCATION           = 
+HHC_LOCATION           = C:\Program Files\HTML Help Workshop\hhc.exe
 
 
 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag 
 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag 
 # controls if a separate .chi index file is generated (YES) or that 
 # controls if a separate .chi index file is generated (YES) or that 
@@ -1056,19 +1056,19 @@ TOC_EXPAND             = NO
 # that can be used as input for Qt's qhelpgenerator to generate a 
 # that can be used as input for Qt's qhelpgenerator to generate a 
 # Qt Compressed Help (.qch) of the generated HTML documentation.
 # Qt Compressed Help (.qch) of the generated HTML documentation.
 
 
-GENERATE_QHP           = NO
+GENERATE_QHP           = @CodeBlocks_HELP@
 
 
 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can 
 # If the QHG_LOCATION tag is specified, the QCH_FILE tag can 
 # be used to specify the file name of the resulting .qch file. 
 # be used to specify the file name of the resulting .qch file. 
 # The path specified is relative to the HTML output folder.
 # The path specified is relative to the HTML output folder.
 
 
-QCH_FILE               = 
+QCH_FILE               = com.github.urho3d.Urho3D.@URHO3D_VERSION@
 
 
 # The QHP_NAMESPACE tag specifies the namespace to use when generating 
 # The QHP_NAMESPACE tag specifies the namespace to use when generating 
 # Qt Help Project output. For more information please see 
 # Qt Help Project output. For more information please see 
 # http://doc.trolltech.com/qthelpproject.html#namespace
 # http://doc.trolltech.com/qthelpproject.html#namespace
 
 
-QHP_NAMESPACE          = org.doxygen.Project
+QHP_NAMESPACE          = com.github.urho3d.Urho3D
 
 
 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating 
 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating 
 # Qt Help Project output. For more information please see 
 # Qt Help Project output. For more information please see 
@@ -1102,7 +1102,7 @@ QHP_SECT_FILTER_ATTRS  =
 # If non-empty doxygen will try to run qhelpgenerator on the generated 
 # If non-empty doxygen will try to run qhelpgenerator on the generated 
 # .qhp file.
 # .qhp file.
 
 
-QHG_LOCATION           = 
+QHG_LOCATION           = /usr/bin/qhelpgenerator
 
 
 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files  
 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files  
 # will be generated, which together with the HTML files, form an Eclipse help 
 # will be generated, which together with the HTML files, form an Eclipse help 
@@ -1119,7 +1119,7 @@ GENERATE_ECLIPSEHELP   = @Eclipse_HELP@
 # the directory name containing the HTML and XML files should also have 
 # the directory name containing the HTML and XML files should also have 
 # this name.
 # this name.
 
 
-ECLIPSE_DOC_ID         = com.github.urho3d.documentation.@CPACK_PACKAGE_VERSION_MAJOR@.@CPACK_PACKAGE_VERSION_MINOR@
+ECLIPSE_DOC_ID         = com.github.urho3d.Urho3D.@URHO3D_VERSION@
 
 
 # The DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) 
 # The DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) 
 # at top of each HTML page. The value NO (the default) enables the index and 
 # at top of each HTML page. The value NO (the default) enables the index and