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 license
   7 #############################################################################
   8
   9 @INCLUDE = Doxyfile_inc
  10
  11 #---------------------------------------------------------------------------
  12 # Generation switches
  13 #---------------------------------------------------------------------------
  14
  15 GENERATE_HTMLHELP      = YES
  16
  17 # NOTE: the following must be set to YES otherwise doxygen won't generate the
  18 #       index.hhp file and the CHM compilation will fail!
  19 GENERATE_HTML          = YES
  20 GENERATE_XML           = NO
  21
  22 GENERATE_LATEX         = NO
  23 GENERATE_RTF           = NO
  24 GENERATE_MAN           = NO
  25 GENERATE_PERLMOD       = NO
  26 GENERATE_AUTOGEN_DEF   = NO
  27 GENERATE_TAGFILE       =
  28
  29 # Notes about the HTML HELP COMPILER (hhc):
  30 # hhc is the compiler used to produce CHM files from the HTML sources.
  31 #
  32 # => for Windows:
  33 #    you can download it for free from MS website:
  34 #      http://www.microsoft.com/downloads/details.aspx?FamilyID=00535334-c8a6-452f-9aa0-d597d16580cc&displaylang=en
  35 #    then set the HHC_PATH environment variable to the folder where you
  36 #    installed HHC; see e.g. http://www.computerhope.com/issues/ch000549.htm
  37 #    for more info about how to set env variables in WinXP or newer.
  38 #
  39 # => for Unix:
  40 #    you can install the Windows version of the compiler under WINE
  41 #    (http://www.winehq.org/) following the instructions placed here:
  42 #      http://appdb.winehq.org/objectManager.php?sClass=application&iId=2140
  43 #    then you can place hhc.exe executable in your PATH; e.g. you can add to
  44 #    your ~/.bashrc (if you use bash):
  45 #      PATH=$PATH:~/.wine/drive_c/Programmi/HTMLHelpWorkshop
  46 #      export PATH
  47 #
  48 HHC_LOCATION           = hhc.exe