| author | Oleksandr Gavenko <gavenkoa@gmail.com> |
| Mon, 22 Feb 2016 12:46:36 +0200 | |
| changeset 1905 | fba288d59662 |
| parent 1334 | 9bf0d5a1f0cf |
| child 1912 | 8b81a8f0f692 |
| permissions | -rw-r--r-- |
|
1334
9bf0d5a1f0cf
Include common header with quick links.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
945
diff
changeset
|
1 |
.. -*- coding: utf-8; -*- |
|
9bf0d5a1f0cf
Include common header with quick links.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
945
diff
changeset
|
2 |
.. include:: HEADER.rst |
| 945 | 3 |
|
4 |
========== |
|
5 |
Doxygen. |
|
6 |
========== |
|
7 |
.. contents:: |
|
|
1905
fba288d59662
Include only local subsections into TOC. This prevent duplication of
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
1334
diff
changeset
|
8 |
:local: |
| 945 | 9 |
|
10 |
Installing. |
|
11 |
=========== |
|
12 |
:: |
|
13 |
||
14 |
$ sudo apt-get install doxygen |
|
15 |
$ sudo apt-get install doxygen-gui |
|
16 |
||
17 |
Graphical wizard called as:: |
|
18 |
||
19 |
$ doxywizard |
|
20 |
||
21 |
Doxygen simple workflow. |
|
22 |
======================== |
|
23 |
:: |
|
24 |
||
25 |
$ cd $proj |
|
26 |
$ doxygen -g $proj.cfg # generate basic config file |
|
27 |
||
28 |
Edit $proj.cfg. Some essential settings:: |
|
29 |
||
30 |
PROJECT_NAME = my-proj |
|
31 |
OUTPUT_DIRECTORY = my |
|
32 |
OUTPUT_LANGUAGE = English |
|
33 |
INPUT = my.h my.hpp dir/ |
|
34 |
INPUT_ENCODING = UTF-8 |
|
35 |
FILE_PATTERNS = |
|
36 |
RECURSIVE = NO |
|
37 |
GENERATE_HTML = YES |
|
38 |
||
39 |
Generate .chm from doxygen. |
|
40 |
=========================== |
|
41 |
||
42 |
Check doxygen config file for:: |
|
43 |
||
44 |
GENERATE_HTMLHELP = YES |
|
45 |
CHM_FILE = my.chm |
|
46 |
CHM_INDEX_ENCODING = Windows-1251 |
|
47 |
||
48 |
Run 'doxygen' and 'hhc.exe' on generated 'index.hhp':: |
|
49 |
||
50 |
$ doxygen $proj.cfg |
|
51 |
$ cd $proj/html # here gone doxygen html output |
|
52 |
$ hhc.exe index.hhp |
|
53 |