no real change: just move Docset/CHM/QCH declarations in their own sections

[wxWidgets.git] / docs / doxygen / Doxyfile_chm

diff --git a/docs/doxygen/Doxyfile_chm b/docs/doxygen/Doxyfile_chm
index 325ab1915af4c73b5741639ad346ff6f937dcc1f..bd028989aa452bd94c3bff1fb6050cc68c4dd860 100644 (file)
--- a/docs/doxygen/Doxyfile_chm
+++ b/docs/doxygen/Doxyfile_chm
@@ -3,46 +3,36 @@
 ## Purpose:     Doxygen configuration file for generating CHM only
 ## Author:      Francesco Montorsi
 ## RCS-ID:      $Id$
-## Licence:     wxWindows license
+## Licence:     wxWindows licence
 #############################################################################
 
 @INCLUDE = Doxyfile_inc
 
+# HTML Help Compiler (hhc.exe) is the compiler used to produce CHM files from
+# the HTML sources. You are required to install HHC to generate this format.
+#
+# Windows:
+#   You can download it for free from MS website:
+#   <http://www.microsoft.com/downloads/details.aspx?FamilyID=00535334-c8a6-452f-9aa0-d597d16580cc&displaylang=en>
+#   Then set the HHC_PATH environment variable to the folder where you
+#   installed HHC. See <http://www.computerhope.com/issues/ch000549.htm>
+#   for more info about how to set env variables in WinXP or newer.
+#
+# Unix:
+#   You can install the Windows version of the compiler under WINE
+#   <http://www.winehq.org/> following the instructions placed here:
+#   <http://appdb.winehq.org/objectManager.php?sClass=application&iId=2140>
+#   Then place the hhc.exe executable in your PATH. You can add to your
+#   ~/.bashrc (if you use bash):
+#     PATH=$PATH:~/.wine/drive_c/Program Files/HTML Help Workshop
+#     export PATH
+
 #---------------------------------------------------------------------------
 # Generation switches
 #---------------------------------------------------------------------------
 
-GENERATE_HTMLHELP      = YES
-
-# NOTE: the following must be set to YES otherwise doxygen won't generate the 
+# NOTE: GENERATE_HTML must be set to YES otherwise doxygen won't generate the
 #       index.hhp file and the CHM compilation will fail!
 GENERATE_HTML          = YES
-GENERATE_XML           = NO
-
-GENERATE_LATEX         = NO
-GENERATE_RTF           = NO
-GENERATE_MAN           = NO
-GENERATE_PERLMOD       = NO
-GENERATE_AUTOGEN_DEF   = NO
-GENERATE_TAGFILE       =
+GENERATE_HTMLHELP      = YES
 
-# Notes about the HTML HELP COMPILER (hhc):
-# hhc is the compiler used to produce CHM files from the HTML sources.
-#
-# => for Windows:
-#    you can download it for free from MS website:
-#      http://www.microsoft.com/downloads/details.aspx?FamilyID=00535334-c8a6-452f-9aa0-d597d16580cc&displaylang=en
-#    then set the HHC_PATH environment variable to the folder where you
-#    installed HHC; see e.g. http://www.computerhope.com/issues/ch000549.htm
-#    for more info about how to set env variables in WinXP or newer.
-#
-# => for Unix: 
-#    you can install the Windows version of the compiler under WINE 
-#    (http://www.winehq.org/) following the instructions placed here:
-#      http://appdb.winehq.org/objectManager.php?sClass=application&iId=2140
-#    then you can place hhc.exe executable in your PATH; e.g. you can add to
-#    your ~/.bashrc (if you use bash): 
-#      PATH=$PATH:~/.wine/drive_c/Programmi/HTMLHelpWorkshop
-#      export PATH
-#
-HHC_LOCATION           = hhc.exe