X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/be151c9a1c6b9f049bbbd2c6a1cea277a29e7e02..a25a17732c2d4d34d5d35a5318053dd8c6e29722:/docs/doxygen/Doxyfile_chm

diff --git a/docs/doxygen/Doxyfile_chm b/docs/doxygen/Doxyfile_chm
index b5c44217a1..dd248609a9 100644
--- a/docs/doxygen/Doxyfile_chm
+++ b/docs/doxygen/Doxyfile_chm
@@ -8,19 +8,31 @@
 
 @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
 #---------------------------------------------------------------------------
 
+# 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_HTMLHELP      = YES
-GENERATE_HTML          = NO
-GENERATE_XML           = NO
-
-GENERATE_LATEX         = NO
-GENERATE_RTF           = NO
-GENERATE_MAN           = NO
-GENERATE_PERLMOD       = NO
-GENERATE_AUTOGEN_DEF   = NO
-GENERATE_TAGFILE       =
 
-HHC_LOCATION           = ~/.wine/drive_c/Programmi/HTMLHelpWorkshop/hhc.exe