docs/doxygen/Doxyfile_chm

   1 #############################################################################
   2 ## Name:        Doxyfile.chm
   3 ## Purpose:     Doxygen configuration file for generating CHM only
   4 ## Author:      Francesco Montorsi
   5 ## RCS-ID:      $Id$
   6 ## Licence:     wxWindows licence
   7 #############################################################################
   8
   9 @INCLUDE = Doxyfile_inc
  10
  11 # HTML Help Compiler (hhc.exe) is the compiler used to produce CHM files from
  12 # the HTML sources. You are required to install HHC to generate this format.
  13 #
  14 # Windows:
  15 #   You can download it for free from MS website:
  16 #   <http://www.microsoft.com/downloads/details.aspx?FamilyID=00535334-c8a6-452f-9aa0-d597d16580cc&displaylang=en>
  17 #   Then set the HHC_PATH environment variable to the folder where you
  18 #   installed HHC. See <http://www.computerhope.com/issues/ch000549.htm>
  19 #   for more info about how to set env variables in WinXP or newer.
  20 #
  21 # Unix:
  22 #   You can install the Windows version of the compiler under WINE
  23 #   <http://www.winehq.org/> following the instructions placed here:
  24 #   <http://appdb.winehq.org/objectManager.php?sClass=application&iId=2140>
  25 #   Then place the hhc.exe executable in your PATH. You can add to your
  26 #   ~/.bashrc (if you use bash):
  27 #     PATH=$PATH:~/.wine/drive_c/Program Files/HTML Help Workshop
  28 #     export PATH
  29
  30 #---------------------------------------------------------------------------
  31 # Generation switches
  32 #---------------------------------------------------------------------------
  33
  34 # NOTE: GENERATE_HTML must be set to YES otherwise doxygen won't generate the
  35 #       index.hhp file and the CHM compilation will fail!
  36 GENERATE_HTML          = YES
  37 GENERATE_HTMLHELP      = YES
  38