aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorJonas Schnelli <dev@jonasschnelli.ch>2018-02-17 18:49:18 +1100
committerJonas Schnelli <dev@jonasschnelli.ch>2018-02-17 18:49:24 +1100
commitdaa84b33540aa3bcb74aa8b0cf08362d688bb4ce (patch)
tree78e80b894eab2329d40de40d420598365c95cf8c /doc
parent23481fa50301201ef5a60675ef899aa6ce94ca03 (diff)
parenta777244e48227db6d3fd06cd2500cc007dacfb10 (diff)
Merge #12029: Build: Add a makefile target for Doxygen documentation
a777244e4 Build: Add a makefile target for Doxygen documentation (Andrea Comand) Pull request description: You can now build the doxygen documentation with `make docs` and clean it with `make clean-docs`. Fixes: #11949 Tree-SHA512: f2361ec7f771227367dd04bba1a444b44e59f13901463a678a5f2f579a10a56d67db2e29552e754e312a1c472a31593b6af189cbaac5cd351a428c57baf5ace7
Diffstat (limited to 'doc')
-rw-r--r--doc/developer-notes.md2
1 files changed, 2 insertions, 0 deletions
diff --git a/doc/developer-notes.md b/doc/developer-notes.md
index 9dc63a1e4b..2ebfb59c08 100644
--- a/doc/developer-notes.md
+++ b/doc/developer-notes.md
@@ -132,6 +132,8 @@ Not OK (used plenty in the current source, but not picked up):
A full list of comment syntaxes picked up by doxygen can be found at http://www.stack.nl/~dimitri/doxygen/manual/docblocks.html,
but if possible use one of the above styles.
+Documentation can be generated with `make docs` and cleaned up with `make clean-docs`.
+
Development tips and tricks
---------------------------