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