-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathdoxygenREADME
40 lines (32 loc) · 1.11 KB
/
doxygenREADME
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
Doxygen Documentation
---------------------
To document c++ http://www.stack.nl/~dimitri/doxygen/manual/docblocks.html#cppblock
Special commands: https://www.stack.nl/~dimitri/doxygen/manual/commands.html
To create doxy file:
doxygen -g
Changes:
- PROJECT_NAME = "Options"
- PROJECT_NUMBER = 1.0
- PROJECT_BRIEF = "Option Library Framework"
- OPTIMIZE_OUTPUT_FOR_C = YES
- BUILTIN_STL_SUPPORT = YES
- QUIET = YES
- SOURCE_BROWSER = YES
- HTML_COLORSTYLE_SAT = 50
- GENERATE_LATEX = NO (change to YES to generate latex)
- HIDE_UNDOC_RELATIONS = NO
- HAVE_DOT = YES
- UML_LOOK = YES
- UML_LIMIT_NUM_FIELDS = 0
- DOT_FONTSIZE = 12
- HTML_DYNAMIC_SECTIONS = YES
- EXTRACT_PRIVATE = YES (change to NO show just the public interface)
- RECURSIVE = YES
- EXCLUDE = README.md \
.git \
html \
example.cc
- EXCLUDE_PATTERNS = *moc*
- HTML_TIMESTAMP = YES
- CLASS_GRAPH = YES
- GENERATE_LEGEND = NO