doxygen.rst
author Oleksandr Gavenko <gavenkoa@gmail.com>
Wed, 17 Aug 2011 21:14:54 +0300
changeset 945 972852ff3ade
child 1334 9bf0d5a1f0cf
permissions -rw-r--r--
change mode to 644
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
945
972852ff3ade change mode to 644
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
     1
.. -*- coding: utf-8 -*-
972852ff3ade change mode to 644
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
     2
972852ff3ade change mode to 644
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
     3
==========
972852ff3ade change mode to 644
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
     4
 Doxygen.
972852ff3ade change mode to 644
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
     5
==========
972852ff3ade change mode to 644
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
     6
.. contents::
972852ff3ade change mode to 644
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
     7
972852ff3ade change mode to 644
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
     8
Installing.
972852ff3ade change mode to 644
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
     9
===========
972852ff3ade change mode to 644
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    10
::
972852ff3ade change mode to 644
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    11
972852ff3ade change mode to 644
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    12
  $ sudo apt-get install doxygen
972852ff3ade change mode to 644
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    13
  $ sudo apt-get install doxygen-gui
972852ff3ade change mode to 644
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    14
972852ff3ade change mode to 644
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    15
Graphical wizard called as::
972852ff3ade change mode to 644
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    16
972852ff3ade change mode to 644
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    17
  $ doxywizard
972852ff3ade change mode to 644
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    18
972852ff3ade change mode to 644
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    19
Doxygen simple workflow.
972852ff3ade change mode to 644
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    20
========================
972852ff3ade change mode to 644
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    21
::
972852ff3ade change mode to 644
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    22
972852ff3ade change mode to 644
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    23
  $ cd $proj
972852ff3ade change mode to 644
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    24
  $ doxygen -g $proj.cfg  # generate basic config file
972852ff3ade change mode to 644
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    25
972852ff3ade change mode to 644
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    26
Edit $proj.cfg. Some essential settings::
972852ff3ade change mode to 644
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    27
972852ff3ade change mode to 644
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    28
  PROJECT_NAME     = my-proj
972852ff3ade change mode to 644
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    29
  OUTPUT_DIRECTORY = my
972852ff3ade change mode to 644
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    30
  OUTPUT_LANGUAGE  = English
972852ff3ade change mode to 644
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    31
  INPUT            = my.h my.hpp dir/
972852ff3ade change mode to 644
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    32
  INPUT_ENCODING   = UTF-8
972852ff3ade change mode to 644
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    33
  FILE_PATTERNS    =
972852ff3ade change mode to 644
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    34
  RECURSIVE        = NO
972852ff3ade change mode to 644
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    35
  GENERATE_HTML    = YES
972852ff3ade change mode to 644
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    36
972852ff3ade change mode to 644
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    37
Generate .chm from doxygen.
972852ff3ade change mode to 644
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    38
===========================
972852ff3ade change mode to 644
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    39
972852ff3ade change mode to 644
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    40
Check doxygen config file for::
972852ff3ade change mode to 644
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    41
972852ff3ade change mode to 644
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    42
  GENERATE_HTMLHELP  = YES
972852ff3ade change mode to 644
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    43
  CHM_FILE           = my.chm
972852ff3ade change mode to 644
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    44
  CHM_INDEX_ENCODING = Windows-1251
972852ff3ade change mode to 644
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    45
972852ff3ade change mode to 644
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    46
Run 'doxygen' and 'hhc.exe' on generated 'index.hhp'::
972852ff3ade change mode to 644
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    47
972852ff3ade change mode to 644
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    48
  $ doxygen $proj.cfg
972852ff3ade change mode to 644
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    49
  $ cd $proj/html     # here gone doxygen html output
972852ff3ade change mode to 644
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    50
  $ hhc.exe index.hhp
972852ff3ade change mode to 644
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    51