Skip to content

Commit 9754e3d

Browse files
vivien-applevivien-apple
authored
Get Doxygen documentation to be independent of the build system (#2703)
1 parent daefdc4 commit 9754e3d

9 files changed

+222
-343
lines changed

‎.gitignore

+3
Original file line numberDiff line numberDiff line change
@@ -62,3 +62,6 @@ TAGS
6262
# Python bytecodes
6363
__pycache__
6464
*.pyc
65+
66+
# Doxygen outputs
67+
docs/html

‎Makefile.am

-19
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,6 @@ SUBDIRS = \
3434
examples \
3535
third_party \
3636
src \
37-
docs \
3837
$(NULL)
3938

4039
PRETTY_SUBDIRS = \
@@ -215,24 +214,6 @@ dist-hook: $(distdir)/.dist-version
215214
distclean-local:
216215
$(MAKE) -C $(srcdir) -f Makefile-bootstrap clean-repos
217216

218-
#
219-
# Top-level convenience target for making documentation.
220-
#
221-
222-
.PHONY: doc
223-
doc: $(BUILT_SOURCES)
224-
$(MAKE) -C docs $(@)
225-
226-
#
227-
# Top-level convenience target for making a documentation-only
228-
# distribution whose results appear at the top level of the build tree
229-
# in the same fashion that the distribution would be for 'make dist'.
230-
#
231-
232-
.PHONY: docdist
233-
docdist: $(BUILT_SOURCES)
234-
$(MAKE) -C docs docdistdir=$(abs_builddir) $(@)
235-
236217
#
237218
# Top-level convenience target for making a tools-only distribution
238219
# whose resuls appear at the top level of the build tree in the same

‎README.md

+24-25
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Connected Home over IP
1+
# Connected Home over IP {#mainpage}
22

33
![Main](https://github.com/project-chip/connectedhomeip/workflows/Builds/badge.svg)
44
![Examples](https://github.com/project-chip/connectedhomeip/workflows/Examples/badge.svg)
@@ -137,39 +137,38 @@ scalability.
137137
# How to Contribute
138138

139139
We welcome your contributions to Project Connected Home over IP. Read our
140-
contribution guidelines
141-
[here](https://github.com/project-chip/connectedhomeip/blob/master/CONTRIBUTING.md).
140+
contribution guidelines [here](./CONTRIBUTING.md).
142141

143142
# Building and Developing in Project
144143

145144
Instructions about how to build Project Connected Home over IP can be found
146-
[here](./docs/README.md#building-and-developing).
145+
[here](./docs/README.md).
147146

148147
# Directory Structure
149148

150149
The Connected Home over IP repository is structured as follows:
151150

152-
| File / Folder | Contents |
153-
| ---------------------- | -------------------------------------------------------------------------------------------------------------------- |
154-
| `.default-version` | Default Project CHIP version if none is available via source code control tags, `.dist-version`, or `.local-version` |
155-
| `bootstrap` | GNU autotools bootstrap script for the Project CHIP build system |
156-
| `bootstrap-configure` | Convenience script that will bootstrap the Project CHIP build system, via `bootstrap`, and invoke `configure` |
157-
| `build/` | Build system support content and build output directories |
158-
| `BUILDING.md` | More detailed information on configuring and building Project CHIP for different targets |
159-
| `CODE_OF_CONDUCT.md` | Code of Conduct for Project CHIP, and contributions to it |
160-
| `CONTRIBUTING.md` | Guidelines for contributing to Project CHIP |
161-
| `CONTRIBUTORS.md` | Contributors to Project CHIP |
162-
| `docs/` | Documentation |
163-
| `examples/` | Example firmware applications that demonstrate use of Project CHIP technology |
164-
| `integrations/` | Third party integrations related to this project |
165-
| `integrations/docker/` | Docker scripts and Dockerfiles |
166-
| `LICENSE` | Project CHIP [License file](./LICENSE) (Apache 2.0) |
167-
| `Makefile-Android` | Convenience makefile for building Project CHIP against Android |
168-
| `Makefile-Standalone` | Convenience makefile for building Project CHIP as a standalone package on desktop and server systems |
169-
| `README.md` | This file |
170-
| `src/` | Implementation of Project CHIP |
171-
| `third_party/` | Third-party code used by Project CHIP |
172-
| `tools/` | Tools needed to work with the Project CHIP repo |
151+
| File / Folder | Contents |
152+
| ------------------------------------ | -------------------------------------------------------------------------------------------------------------------- |
153+
| `.default-version` | Default Project CHIP version if none is available via source code control tags, `.dist-version`, or `.local-version` |
154+
| `bootstrap` | GNU autotools bootstrap script for the Project CHIP build system |
155+
| `bootstrap-configure` | Convenience script that will bootstrap the Project CHIP build system, via `bootstrap`, and invoke `configure` |
156+
| `build/` | Build system support content and build output directories |
157+
| [BUILDING.md](./docs/BUILDING.md) | More detailed information on configuring and building Project CHIP for different targets |
158+
| `CODE_OF_CONDUCT.md` | Code of Conduct for Project CHIP, and contributions to it |
159+
| [CONTRIBUTING.md](./CONTRIBUTING.md) | Guidelines for contributing to Project CHIP |
160+
| `CONTRIBUTORS.md` | Contributors to Project CHIP |
161+
| `docs/` | Documentation |
162+
| `examples/` | Example firmware applications that demonstrate use of Project CHIP technology |
163+
| `integrations/` | Third party integrations related to this project |
164+
| `integrations/docker/` | Docker scripts and Dockerfiles |
165+
| `LICENSE` | Project CHIP [License file](./LICENSE) (Apache 2.0) |
166+
| `Makefile-Android` | Convenience makefile for building Project CHIP against Android |
167+
| `Makefile-Standalone` | Convenience makefile for building Project CHIP as a standalone package on desktop and server systems |
168+
| `README.md` | This file |
169+
| `src/` | Implementation of Project CHIP |
170+
| `third_party/` | Third-party code used by Project CHIP |
171+
| `tools/` | Tools needed to work with the Project CHIP repo |
173172

174173
# License
175174

‎configure.ac

-10
Original file line numberDiff line numberDiff line change
@@ -896,14 +896,6 @@ AC_DEFINE_UNQUOTED([CHIP_ENABLE_CHIPOBLE_TEST],[${CHIP_ENABLE_CHIPOBLE_TEST}],[D
896896
# Documentation
897897
#
898898

899-
# Determine whether or not documentation (via Doxygen) should be built
900-
# or not, with 'auto' as the default and establish a default support
901-
# value for GraphViz 'dot' support.
902-
903-
NL_ENABLE_DOCS([auto],[NO])
904-
905-
AM_CONDITIONAL(CHIP_BUILD_DOCS, [test "${nl_cv_build_docs}" = "yes"])
906-
907899
#
908900
# Network Technology Layer
909901
#
@@ -2552,7 +2544,6 @@ fi
25522544
#
25532545
AC_CONFIG_FILES([
25542546
Makefile
2555-
docs/Makefile
25562547
examples/Makefile
25572548
third_party/Makefile
25582549
third_party/lwip/Makefile
@@ -2650,7 +2641,6 @@ AC_MSG_NOTICE([
26502641
Python extension directory : ${pyexecdir:--}
26512642
Verhoeff support : ${enable_verhoeff}
26522643
Pairing code decoding support : ${enable_pairing_code_decoding}
2653-
Documentation support : ${nl_cv_build_docs}
26542644
Clang-format : ${CLANG_FORMAT:--}
26552645
Doxygen : ${DOXYGEN:--}
26562646
GraphViz dot : ${DOT:--}

‎docs/ChipDoxygenLayout.xml

+40-21
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,40 @@
11
<doxygenlayout version="1.0">
2-
<!-- Generated by doxygen 1.8.6 -->
2+
<!-- Generated by doxygen 1.8.18 -->
33
<!-- Navigation index tabs for HTML output -->
44
<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>
5+
<tab type="mainpage" visible="yes" title=""/>
6+
<tab type="pages" visible="yes" title="" intro=""/>
7+
<tab type="namespaces" visible="yes" title="">
8+
<tab type="namespacelist" visible="yes" title="" intro=""/>
9+
<tab type="namespacemembers" visible="yes" title="" intro=""/>
10+
</tab>
11+
<tab type="interfaces" visible="yes" title="">
12+
<tab type="interfacelist" visible="yes" title="" intro=""/>
13+
<tab type="interfaceindex" visible="$ALPHABETICAL_INDEX" title=""/>
14+
<tab type="interfacehierarchy" visible="yes" title="" intro=""/>
2215
</tab>
2316
<tab type="classes" visible="yes" title="">
2417
<tab type="classlist" visible="yes" title="" intro=""/>
25-
<tab type="classindex" visible="$ALPHABETICAL_INDEX" title=""/>
18+
<tab type="classindex" visible="$ALPHABETICAL_INDEX" title=""/>
2619
<tab type="hierarchy" visible="yes" title="" intro=""/>
2720
<tab type="classmembers" visible="yes" title="" intro=""/>
2821
</tab>
22+
<tab type="structs" visible="yes" title="">
23+
<tab type="structlist" visible="yes" title="" intro=""/>
24+
<tab type="structindex" visible="$ALPHABETICAL_INDEX" title=""/>
25+
</tab>
26+
<tab type="exceptions" visible="yes" title="">
27+
<tab type="exceptionlist" visible="yes" title="" intro=""/>
28+
<tab type="exceptionindex" visible="$ALPHABETICAL_INDEX" title=""/>
29+
<tab type="exceptionhierarchy" visible="yes" title="" intro=""/>
30+
</tab>
2931
<tab type="files" visible="yes" title="">
3032
<tab type="filelist" visible="yes" title="" intro=""/>
3133
<tab type="globals" visible="yes" title="" intro=""/>
3234
</tab>
33-
<tab type="examples" visible="yes" title="" intro=""/>
35+
<tab type="examples" visible="yes" title="" intro=""/>
3436
</navindex>
3537

36-
3738
<!-- Layout definition for a class page -->
3839
<class>
3940
<briefdescription visible="yes"/>
@@ -99,8 +100,13 @@
99100
<memberdecl>
100101
<nestednamespaces visible="yes" title=""/>
101102
<constantgroups visible="yes" title=""/>
103+
<interfaces visible="yes" title=""/>
102104
<classes visible="yes" title=""/>
105+
<structs visible="yes" title=""/>
106+
<exceptions visible="yes" title=""/>
103107
<typedefs title=""/>
108+
<sequences title=""/>
109+
<dictionaries title=""/>
104110
<enums title=""/>
105111
<functions title=""/>
106112
<variables title=""/>
@@ -110,6 +116,8 @@
110116
<memberdef>
111117
<inlineclasses title=""/>
112118
<typedefs title=""/>
119+
<sequences title=""/>
120+
<dictionaries title=""/>
113121
<enums title=""/>
114122
<functions title=""/>
115123
<variables title=""/>
@@ -125,11 +133,16 @@
125133
<includedbygraph visible="$INCLUDED_BY_GRAPH"/>
126134
<sourcelink visible="yes"/>
127135
<memberdecl>
136+
<interfaces visible="yes" title=""/>
128137
<classes visible="yes" title=""/>
138+
<structs visible="yes" title=""/>
139+
<exceptions visible="yes" title=""/>
129140
<namespaces visible="yes" title=""/>
130141
<constantgroups visible="yes" title=""/>
131142
<defines title=""/>
132143
<typedefs title=""/>
144+
<sequences title=""/>
145+
<dictionaries title=""/>
133146
<enums title=""/>
134147
<functions title=""/>
135148
<variables title=""/>
@@ -140,6 +153,8 @@
140153
<inlineclasses title=""/>
141154
<defines title=""/>
142155
<typedefs title=""/>
156+
<sequences title=""/>
157+
<dictionaries title=""/>
143158
<enums title=""/>
144159
<functions title=""/>
145160
<variables title=""/>
@@ -159,6 +174,8 @@
159174
<classes visible="yes" title=""/>
160175
<defines title=""/>
161176
<typedefs title=""/>
177+
<sequences title=""/>
178+
<dictionaries title=""/>
162179
<enums title=""/>
163180
<enumvalues title=""/>
164181
<functions title=""/>
@@ -178,6 +195,8 @@
178195
<inlineclasses title=""/>
179196
<defines title=""/>
180197
<typedefs title=""/>
198+
<sequences title=""/>
199+
<dictionaries title=""/>
181200
<enums title=""/>
182201
<enumvalues title=""/>
183202
<functions title=""/>

0 commit comments

Comments
 (0)