Skip to content

Commit cbe7eb9

Browse files
tpooletpoole
committed
Docs: Improve Doxygen output
1 parent 43acb24 commit cbe7eb9

18 files changed

+7070
-478
lines changed

‎.gitignore‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ profile
5454
**/Builds/MacOSX/**/Index
5555
**/Builds/MacOSX/**/Intermediates.noindex
5656
**/doxygen/doc
57-
**/doxygen/build
57+
**/doxygen/xml
5858
**/.idea
5959
extras/Projucer/JUCECompileEngine.dylib
6060

‎docs/doxygen/Doxyfile‎

Lines changed: 442 additions & 280 deletions
Large diffs are not rendered by default.

‎docs/doxygen/DoxygenLayout.xml‎

Lines changed: 265 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,265 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<doxygenlayout version="1.0">
3+
<!-- Generated by doxygen 1.9.8 -->
4+
<!-- Navigation index tabs for HTML output -->
5+
<navindex>
6+
<tab type="mainpage" visible="yes" title="Modules"/>
7+
<tab type="topics" visible="no" title="" intro=""/>
8+
<tab type="modules" visible="no" title="" intro="">
9+
<tab type="modulelist" visible="no" title="" intro=""/>
10+
<tab type="modulemembers" visible="no" title="" intro=""/>
11+
</tab>
12+
<tab type="namespaces" visible="no" title="Namespaces">
13+
<tab type="namespacelist" visible="yes" title="" intro=""/>
14+
<tab type="namespacemembers" visible="yes" title="" intro=""/>
15+
</tab>
16+
<tab type="concepts" visible="yes" title="Concepts">
17+
</tab>
18+
<tab type="interfaces" visible="no" title="">
19+
<tab type="interfacelist" visible="yes" title="" intro=""/>
20+
<tab type="interfaceindex" visible="$ALPHABETICAL_INDEX" title=""/>
21+
<tab type="interfacehierarchy" visible="yes" title="" intro=""/>
22+
</tab>
23+
<tab type="classes" visible="no" title="">
24+
<tab type="classlist" visible="yes" title="" intro=""/>
25+
<tab type="classindex" visible="$ALPHABETICAL_INDEX" title=""/>
26+
<tab type="hierarchy" visible="yes" title="" intro=""/>
27+
<tab type="classmembers" visible="yes" title="" intro=""/>
28+
</tab>
29+
<tab type="classindex" visible="yes" title="Alphabetical"/>
30+
<tab type="structs" visible="no" title="">
31+
<tab type="structlist" visible="yes" title="" intro=""/>
32+
<tab type="structindex" visible="$ALPHABETICAL_INDEX" title=""/>
33+
</tab>
34+
<tab type="exceptions" visible="no" title="">
35+
<tab type="exceptionlist" visible="yes" title="" intro=""/>
36+
<tab type="exceptionindex" visible="$ALPHABETICAL_INDEX" title=""/>
37+
<tab type="exceptionhierarchy" visible="yes" title="" intro=""/>
38+
</tab>
39+
<tab type="files" visible="no" title="">
40+
<tab type="filelist" visible="yes" title="" intro=""/>
41+
<tab type="globals" visible="yes" title="" intro=""/>
42+
</tab>
43+
<tab type="examples" visible="no" title="" intro=""/>
44+
<tab type="user" visible="yes" title="Tutorials" url="https://juce.com/learn/tutorials"/>
45+
</navindex>
46+
47+
<!-- Layout definition for a class page -->
48+
<class>
49+
<detaileddescription title=""/>
50+
<includes visible="$SHOW_HEADERFILE"/>
51+
<inheritancegraph visible="$CLASS_GRAPH"/>
52+
<collaborationgraph visible="yes"/>
53+
<memberdecl>
54+
<nestedclasses visible="yes" title=""/>
55+
<publictypes title=""/>
56+
<services title=""/>
57+
<interfaces title=""/>
58+
<publicslots title=""/>
59+
<signals title=""/>
60+
<publicmethods title=""/>
61+
<publicstaticmethods title=""/>
62+
<publicattributes title=""/>
63+
<publicstaticattributes title=""/>
64+
<protectedtypes title=""/>
65+
<protectedslots title=""/>
66+
<protectedmethods title=""/>
67+
<protectedstaticmethods title=""/>
68+
<protectedattributes title=""/>
69+
<protectedstaticattributes title=""/>
70+
<packagetypes title=""/>
71+
<packagemethods title=""/>
72+
<packagestaticmethods title=""/>
73+
<packageattributes title=""/>
74+
<packagestaticattributes title=""/>
75+
<properties title=""/>
76+
<events title=""/>
77+
<privatetypes title=""/>
78+
<privateslots title=""/>
79+
<privatemethods title=""/>
80+
<privatestaticmethods title=""/>
81+
<privateattributes title=""/>
82+
<privatestaticattributes title=""/>
83+
<friends title=""/>
84+
<related title="" subtitle=""/>
85+
<membergroups visible="yes"/>
86+
</memberdecl>
87+
<memberdef>
88+
<inlineclasses title=""/>
89+
<typedefs title=""/>
90+
<enums title="Member Enums"/>
91+
<services title=""/>
92+
<interfaces title=""/>
93+
<constructors title="Constructors and Destructors"/>
94+
<functions title="Member Functions"/>
95+
<related title=""/>
96+
<variables title=""/>
97+
<properties title=""/>
98+
<events title=""/>
99+
</memberdef>
100+
<allmemberslink visible="yes"/>
101+
<usedfiles visible="$SHOW_USED_FILES"/>
102+
<authorsection visible="yes"/>
103+
</class>
104+
105+
<!-- Layout definition for a namespace page -->
106+
<namespace>
107+
<briefdescription visible="yes"/>
108+
<memberdecl>
109+
<nestednamespaces visible="yes" title=""/>
110+
<constantgroups visible="yes" title=""/>
111+
<interfaces visible="yes" title=""/>
112+
<classes visible="yes" title=""/>
113+
<concepts visible="yes" title=""/>
114+
<structs visible="yes" title=""/>
115+
<exceptions visible="yes" title=""/>
116+
<typedefs title=""/>
117+
<sequences title=""/>
118+
<dictionaries title=""/>
119+
<enums title=""/>
120+
<functions title=""/>
121+
<variables title=""/>
122+
<membergroups visible="yes"/>
123+
</memberdecl>
124+
<detaileddescription title=""/>
125+
<memberdef>
126+
<inlineclasses title=""/>
127+
<typedefs title=""/>
128+
<sequences title=""/>
129+
<dictionaries title=""/>
130+
<enums title=""/>
131+
<functions title=""/>
132+
<variables title=""/>
133+
</memberdef>
134+
<authorsection visible="yes"/>
135+
</namespace>
136+
137+
<!-- Layout definition for a concept page -->
138+
<concept>
139+
<briefdescription visible="yes"/>
140+
<includes visible="$SHOW_HEADERFILE"/>
141+
<definition visible="yes" title=""/>
142+
<detaileddescription title=""/>
143+
<authorsection visible="yes"/>
144+
</concept>
145+
146+
<!-- Layout definition for a file page -->
147+
<file>
148+
<briefdescription visible="yes"/>
149+
<includes visible="$SHOW_INCLUDE_FILES"/>
150+
<includegraph visible="yes"/>
151+
<includedbygraph visible="yes"/>
152+
<sourcelink visible="yes"/>
153+
<memberdecl>
154+
<interfaces visible="yes" title=""/>
155+
<classes visible="yes" title=""/>
156+
<structs visible="yes" title=""/>
157+
<exceptions visible="yes" title=""/>
158+
<namespaces visible="yes" title=""/>
159+
<concepts visible="yes" title=""/>
160+
<constantgroups visible="yes" title=""/>
161+
<defines title=""/>
162+
<typedefs title=""/>
163+
<sequences title=""/>
164+
<dictionaries title=""/>
165+
<enums title=""/>
166+
<functions title=""/>
167+
<variables title=""/>
168+
<membergroups visible="yes"/>
169+
</memberdecl>
170+
<detaileddescription title=""/>
171+
<memberdef>
172+
<inlineclasses title=""/>
173+
<defines title=""/>
174+
<typedefs title=""/>
175+
<sequences title=""/>
176+
<dictionaries title=""/>
177+
<enums title=""/>
178+
<functions title=""/>
179+
<variables title=""/>
180+
</memberdef>
181+
<authorsection/>
182+
</file>
183+
184+
<!-- Layout definition for a group page -->
185+
<group>
186+
<briefdescription visible="yes"/>
187+
<groupgraph visible="yes"/>
188+
<memberdecl>
189+
<nestedgroups visible="yes" title=""/>
190+
<modules visible="yes" title=""/>
191+
<dirs visible="yes" title=""/>
192+
<files visible="yes" title=""/>
193+
<namespaces visible="yes" title=""/>
194+
<concepts visible="yes" title=""/>
195+
<classes visible="yes" title=""/>
196+
<defines title=""/>
197+
<typedefs title=""/>
198+
<sequences title=""/>
199+
<dictionaries title=""/>
200+
<enums title=""/>
201+
<enumvalues title=""/>
202+
<functions title=""/>
203+
<variables title=""/>
204+
<signals title=""/>
205+
<publicslots title=""/>
206+
<protectedslots title=""/>
207+
<privateslots title=""/>
208+
<events title=""/>
209+
<properties title=""/>
210+
<friends title=""/>
211+
<membergroups visible="yes"/>
212+
</memberdecl>
213+
<detaileddescription title=""/>
214+
<memberdef>
215+
<pagedocs/>
216+
<inlineclasses title=""/>
217+
<defines title=""/>
218+
<typedefs title=""/>
219+
<sequences title=""/>
220+
<dictionaries title=""/>
221+
<enums title=""/>
222+
<enumvalues title=""/>
223+
<functions title=""/>
224+
<variables title=""/>
225+
<signals title=""/>
226+
<publicslots title=""/>
227+
<protectedslots title=""/>
228+
<privateslots title=""/>
229+
<events title=""/>
230+
<properties title=""/>
231+
<friends title=""/>
232+
</memberdef>
233+
<authorsection visible="yes"/>
234+
</group>
235+
236+
<!-- Layout definition for a C++20 module page -->
237+
<module>
238+
<briefdescription visible="yes"/>
239+
<exportedmodules visible="yes"/>
240+
<memberdecl>
241+
<concepts visible="yes" title=""/>
242+
<classes visible="yes" title=""/>
243+
<enums title=""/>
244+
<typedefs title=""/>
245+
<functions title=""/>
246+
<variables title=""/>
247+
<membergroups title=""/>
248+
</memberdecl>
249+
<detaileddescription title=""/>
250+
<memberdecl>
251+
<files visible="yes"/>
252+
</memberdecl>
253+
</module>
254+
255+
<!-- Layout definition for a directory page -->
256+
<directory>
257+
<briefdescription visible="yes"/>
258+
<directorygraph visible="yes"/>
259+
<memberdecl>
260+
<dirs visible="yes"/>
261+
<files visible="yes"/>
262+
</memberdecl>
263+
<detaileddescription title=""/>
264+
</directory>
265+
</doxygenlayout>

‎docs/doxygen/Makefile‎

Lines changed: 0 additions & 15 deletions
This file was deleted.

‎docs/doxygen/README.md‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# JUCE's Doxygen documentation
2+
3+
JUCE's doxygen setup aims to be pretty vanilla Doxygen and can be run like so:
4+
5+
```
6+
doxygen Doxyfile
7+
```
8+
9+
However, `build.py` can be run to generate additional documentation indexes for JUCE modules:
10+
11+
```
12+
python3 build.py
13+
```
14+
15+
## Styles
16+
17+
`HTML_STYLESHEET` is left empty, meaning that Doxygen will generate its default styles.
18+
19+
JUCE specific overrides then live in `css/doxygen-juce-overrides.css`.
20+
21+
Code highlighting is done with [highlight.js](highlightjs.org).

0 commit comments

Comments
 (0)