1 .. -*- coding: utf-8 -*-

     2 

     3 ==========

     4  Doxygen.

     5 ==========

     6 .. contents::

     7 

     8 Installing.

     9 ===========

    10 ::

    11 

    12   $ sudo apt-get install doxygen

    13   $ sudo apt-get install doxygen-gui

    14 

    15 Graphical wizard called as::

    16 

    17   $ doxywizard

    18 

    19 Doxygen simple workflow.

    20 ========================

    21 ::

    22 

    23   $ cd $proj

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

    25 

    26 Edit $proj.cfg. Some essential settings::

    27 

    28   PROJECT_NAME     = my-proj

    29   OUTPUT_DIRECTORY = my

    30   OUTPUT_LANGUAGE  = English

    31   INPUT            = my.h my.hpp dir/

    32   INPUT_ENCODING   = UTF-8

    33   FILE_PATTERNS    =

    34   RECURSIVE        = NO

    35   GENERATE_HTML    = YES

    36 

    37 Generate .chm from doxygen.

    38 ===========================

    39 

    40 Check doxygen config file for::

    41 

    42   GENERATE_HTMLHELP  = YES

    43   CHM_FILE           = my.chm

    44   CHM_INDEX_ENCODING = Windows-1251

    45 

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

    47 

    48   $ doxygen $proj.cfg

    49   $ cd $proj/html     # here gone doxygen html output

    50   $ hhc.exe index.hhp

    51