Browse Source

Doxygen: add layout file and make formatting more sensible

Signed-off-by: Brendan Le Foll <brendan.le.foll@intel.com>
Brendan Le Foll 10 years ago
parent
commit
2aeb9ddea3
2 changed files with 204 additions and 6 deletions
  1. 10
    6
      Doxyfile.in
  2. 194
    0
      DoxygenLayout.xml

+ 10
- 6
Doxyfile.in View File

@@ -129,6 +129,8 @@ ABBREVIATE_BRIEF       = "The $name class" \
129 129
 
130 130
 ALWAYS_DETAILED_SEC    = NO
131 131
 
132
+DETAILS_AT_TOP         = YES
133
+
132 134
 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
133 135
 # inherited members of a class in the documentation of that class as if those
134 136
 # members were ordinary class members. Constructors, destructors and assignment
@@ -510,7 +512,7 @@ HIDE_SCOPE_NAMES       = YES
510 512
 # the files that are included by a file in the documentation of that file.
511 513
 # The default value is: YES.
512 514
 
513
-SHOW_INCLUDE_FILES     = YES
515
+SHOW_INCLUDE_FILES     = NO
514 516
 
515 517
 # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
516 518
 # grouped member an include statement to the documentation, telling the reader
@@ -536,7 +538,7 @@ INLINE_INFO            = YES
536 538
 # name. If set to NO the members will appear in declaration order.
537 539
 # The default value is: YES.
538 540
 
539
-SORT_MEMBER_DOCS       = YES
541
+SORT_MEMBER_DOCS       = NO
540 542
 
541 543
 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
542 544
 # descriptions of file, namespace and class members alphabetically by member
@@ -671,7 +673,7 @@ FILE_VERSION_FILTER    =
671 673
 # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
672 674
 # tag is left empty.
673 675
 
674
-LAYOUT_FILE            = 
676
+LAYOUT_FILE            = @CMAKE_CURRENT_SOURCE_DIR@/DoxygenLayout.xml
675 677
 
676 678
 # The CITE_BIB_FILES tag can be used to specify one or more bib files containing
677 679
 # the reference definitions. This must be a list of .bib files. The .bib
@@ -847,7 +849,9 @@ EXCLUDE_SYMLINKS       = NO
847 849
 # Note that the wildcards are matched against the file with absolute path, so to
848 850
 # exclude all test directories for example use the pattern */test/*
849 851
 
850
-EXCLUDE_PATTERNS       = 
852
+EXCLUDE_PATTERNS       = @PROJECT_SOURCE_DIR@/src/nrf8001/aci* \
853
+                         @PROJECT_SOURCE_DIR@/src/nrf8001/lib* \
854
+                         @PROJECT_SOURCE_DIR@/src/nrf8001/hal* 
851 855
 
852 856
 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
853 857
 # (namespaces, classes, functions, etc.) that should be excluded from the
@@ -886,7 +890,7 @@ EXAMPLE_RECURSIVE      = NO
886 890
 # that contain images that are to be included in the documentation (see the
887 891
 # \image command).
888 892
 
889
-IMAGE_PATH             = 
893
+IMAGE_PATH             = @CMAKE_CURRENT_SOURCE_DIR@/docs/images/
890 894
 
891 895
 # The INPUT_FILTER tag can be used to specify a program that doxygen should
892 896
 # invoke to filter for each input file. Doxygen will invoke the filter program
@@ -2209,7 +2213,7 @@ INCLUDE_GRAPH          = YES
2209 2213
 # The default value is: YES.
2210 2214
 # This tag requires that the tag HAVE_DOT is set to YES.
2211 2215
 
2212
-INCLUDED_BY_GRAPH      = YES
2216
+INCLUDED_BY_GRAPH      = NO
2213 2217
 
2214 2218
 # If the CALL_GRAPH tag is set to YES then doxygen will generate a call
2215 2219
 # dependency graph for every global function or class method.

+ 194
- 0
DoxygenLayout.xml View File

@@ -0,0 +1,194 @@
1
+<doxygenlayout version="1.0">
2
+  <!-- Generated by doxygen 1.8.7 -->
3
+  <!-- Navigation index tabs for HTML output -->
4
+  <navindex>
5
+    <tab type="mainpage" visible="yes" title=""/>
6
+    <tab type="pages" visible="yes" title="" intro=""/>
7
+    <tab type="modules" visible="yes" title="" intro=""/>
8
+    <tab type="namespaces" visible="yes" title="">
9
+    <tab type="namespacelist" visible="yes" title="" intro=""/>
10
+    <tab type="namespacemembers" visible="yes" title="" intro=""/>
11
+    </tab>
12
+    <tab type="classes" visible="yes" title="">
13
+    <tab type="classlist" visible="yes" title="" intro=""/>
14
+    <tab type="classindex" visible="$ALPHABETICAL_INDEX" title=""/> 
15
+    <tab type="hierarchy" visible="yes" title="" intro=""/>
16
+    <tab type="classmembers" visible="yes" title="" intro=""/>
17
+    </tab>
18
+    <tab type="files" visible="yes" title="">
19
+    <tab type="filelist" visible="yes" title="" intro=""/>
20
+    <tab type="globals" visible="yes" title="" intro=""/>
21
+    </tab>
22
+    <tab type="examples" visible="yes" title="" intro=""/>  
23
+  </navindex>
24
+
25
+  <!-- Layout definition for a class page -->
26
+  <class>
27
+    <briefdescription visible="no"/>
28
+    <detaileddescription title=""/>
29
+    <includes visible="$SHOW_INCLUDE_FILES"/>
30
+    <memberdecl>
31
+      <nestedclasses visible="yes" title=""/>
32
+      <publictypes title=""/>
33
+      <services title=""/>
34
+      <interfaces title=""/>
35
+      <publicslots title=""/>
36
+      <signals title=""/>
37
+      <publicmethods title=""/>
38
+      <publicstaticmethods title=""/>
39
+      <publicattributes title=""/>
40
+      <publicstaticattributes title=""/>
41
+      <protectedtypes title=""/>
42
+      <protectedslots title=""/>
43
+      <protectedmethods title=""/>
44
+      <protectedstaticmethods title=""/>
45
+      <protectedattributes title=""/>
46
+      <protectedstaticattributes title=""/>
47
+      <packagetypes title=""/>
48
+      <packagemethods title=""/>
49
+      <packagestaticmethods title=""/>
50
+      <packageattributes title=""/>
51
+      <packagestaticattributes title=""/>
52
+      <properties title=""/>
53
+      <events title=""/>
54
+      <privatetypes title=""/>
55
+      <privateslots title=""/>
56
+      <privatemethods title=""/>
57
+      <privatestaticmethods title=""/>
58
+      <privateattributes title=""/>
59
+      <privatestaticattributes title=""/>
60
+      <friends title=""/>
61
+      <related title="" subtitle=""/>
62
+      <membergroups visible="yes"/>
63
+    </memberdecl>
64
+    <memberdef>
65
+      <inlineclasses title=""/>
66
+      <typedefs title=""/>
67
+      <enums title=""/>
68
+      <services title=""/>
69
+      <interfaces title=""/>
70
+      <constructors title=""/>
71
+      <functions title=""/>
72
+      <related title=""/>
73
+      <variables title=""/>
74
+      <properties title=""/>
75
+      <events title=""/>
76
+    </memberdef>
77
+    <allmemberslink visible="yes"/>
78
+    <inheritancegraph visible="$CLASS_GRAPH"/>
79
+    <collaborationgraph visible="$COLLABORATION_GRAPH"/>
80
+    <usedfiles visible="$SHOW_USED_FILES"/>
81
+    <authorsection visible="yes"/>
82
+  </class>
83
+
84
+  <!-- Layout definition for a namespace page -->
85
+  <namespace>
86
+    <briefdescription visible="yes"/>
87
+    <memberdecl>
88
+      <nestednamespaces visible="yes" title=""/>
89
+      <constantgroups visible="yes" title=""/>
90
+      <classes visible="yes" title=""/>
91
+      <typedefs title=""/>
92
+      <enums title=""/>
93
+      <functions title=""/>
94
+      <variables title=""/>
95
+      <membergroups visible="yes"/>
96
+    </memberdecl>
97
+    <detaileddescription title=""/>
98
+    <memberdef>
99
+      <inlineclasses title=""/>
100
+      <typedefs title=""/>
101
+      <enums title=""/>
102
+      <functions title=""/>
103
+      <variables title=""/>
104
+    </memberdef>
105
+    <authorsection visible="yes"/>
106
+  </namespace>
107
+
108
+  <!-- Layout definition for a file page -->
109
+  <file>
110
+    <briefdescription visible="no"/>
111
+    <includegraph visible="$INCLUDE_GRAPH"/>
112
+    <includes visible="$SHOW_INCLUDE_FILES"/>
113
+    <detaileddescription title="API Description"/>
114
+    <sourcelink visible="yes"/>
115
+    <memberdecl>
116
+      <classes visible="yes" title=""/>
117
+      <namespaces visible="yes" title=""/>
118
+      <functions title=""/>
119
+      <constantgroups visible="yes" title=""/>
120
+      <defines title=""/>
121
+      <typedefs title=""/>
122
+      <enums title=""/>
123
+      <variables title=""/>
124
+      <membergroups visible="yes"/>
125
+    </memberdecl>
126
+    <memberdef>
127
+      <inlineclasses title=""/>
128
+      <functions title=""/>
129
+      <defines title=""/>
130
+      <typedefs title=""/>
131
+      <enums title=""/>
132
+      <variables title=""/>
133
+    </memberdef>
134
+    <includedbygraph visible="$INCLUDED_BY_GRAPH"/>
135
+    <authorsection/>
136
+  </file>
137
+
138
+  <!-- Layout definition for a group page -->
139
+  <group>
140
+    <briefdescription visible="yes"/>
141
+    <groupgraph visible="$GROUP_GRAPHS"/>
142
+    <memberdecl>
143
+      <nestedgroups visible="yes" title=""/>
144
+      <dirs visible="yes" title=""/>
145
+      <files visible="yes" title=""/>
146
+      <namespaces visible="yes" title=""/>
147
+      <classes visible="yes" title=""/>
148
+      <defines title=""/>
149
+      <typedefs title=""/>
150
+      <enums title=""/>
151
+      <enumvalues title=""/>
152
+      <functions title=""/>
153
+      <variables title=""/>
154
+      <signals title=""/>
155
+      <publicslots title=""/>
156
+      <protectedslots title=""/>
157
+      <privateslots title=""/>
158
+      <events title=""/>
159
+      <properties title=""/>
160
+      <friends title=""/>
161
+      <membergroups visible="yes"/>
162
+    </memberdecl>
163
+    <detaileddescription title=""/>
164
+    <memberdef>
165
+      <pagedocs/>
166
+      <inlineclasses title=""/>
167
+      <defines title=""/>
168
+      <typedefs title=""/>
169
+      <enums title=""/>
170
+      <enumvalues title=""/>
171
+      <functions title=""/>
172
+      <variables title=""/>
173
+      <signals title=""/>
174
+      <publicslots title=""/>
175
+      <protectedslots title=""/>
176
+      <privateslots title=""/>
177
+      <events title=""/>
178
+      <properties title=""/>
179
+      <friends title=""/>
180
+    </memberdef>
181
+    <authorsection visible="yes"/>
182
+  </group>
183
+
184
+  <!-- Layout definition for a directory page -->
185
+  <directory>
186
+    <briefdescription visible="yes"/>
187
+    <directorygraph visible="yes"/>
188
+    <memberdecl>
189
+      <dirs visible="yes"/>
190
+      <files visible="yes"/>
191
+    </memberdecl>
192
+    <detaileddescription title=""/>
193
+  </directory>
194
+</doxygenlayout>