Skip to content

Commit 51a2ec7

Browse files
committed
[doxygen] add target to build docs: 'make docdist'
1 parent 91be77c commit 51a2ec7

15 files changed

+2759
-1
lines changed

Makefile.am

+2-1
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ SUBDIRS = \
3434
examples \
3535
third_party \
3636
src \
37+
doc \
3738
tests \
3839
$(NULL)
3940

@@ -42,7 +43,7 @@ PRETTY_SUBDIRS = \
4243
$(NULL)
4344

4445
EXTRA_DIST = \
45-
CODE_OF_CONDUCT.md \
46+
CODE_OF_CONDUCT.md \
4647
CONTRIBUTING.md \
4748
Makefile-Android \
4849
Makefile-bootstrap \

configure.ac

+1
Original file line numberDiff line numberDiff line change
@@ -2080,6 +2080,7 @@ src/lib/support/Makefile
20802080
src/lib/support/tests/Makefile
20812081
src/platform/Makefile
20822082
tests/Makefile
2083+
doc/Makefile
20832084
])
20842085

20852086
#

docs/BUILDING.md doc/BUILDING.md

File renamed without changes.

doc/ChipDoxygenLayout.xml

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

0 commit comments

Comments
 (0)