doxygen.rst
author Oleksandr Gavenko <gavenkoa@gmail.com>
Tue, 26 Oct 2010 11:54:32 +0300
changeset 626 ad96e87bf403
parent 625 85cabce94fda
permissions -rwxr-xr-x
Generate .chm from doxygen.

-*- mode: outline; coding: utf-8 -*-

* Doxygen simple workflow.

  $ cd $proj
  $ doxygen -g $proj.cfg  # generate basic config file

Edit $proj.cfg. Some essential settings:

  PROJECT_NAME     = my-proj
  OUTPUT_DIRECTORY = my
  OUTPUT_LANGUAGE  = English
  INPUT            = my.h my.hpp dir/
  INPUT_ENCODING   = UTF-8
  FILE_PATTERNS    =
  RECURSIVE        = NO
  GENERATE_HTML    = YES

* Generate .chm from doxygen.

Check doxygen config file for:

  GENERATE_HTMLHELP  = YES
  CHM_FILE           = my.chm
  CHM_INDEX_ENCODING = Windows-1251

Run 'doxygen' and 'hhc.exe' on generated 'index.hhp'

  $ doxygen $proj.cfg
  $ cd $proj/html     # here gone doxygen html output
  $ hhc.exe index.hhp