aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorAndrea Comand <andrea@comand.me>2017-12-26 18:12:04 +0100
committerAndrea Comand <andrea@comand.me>2018-01-25 19:43:19 +0100
commita777244e48227db6d3fd06cd2500cc007dacfb10 (patch)
tree05cc6087e08c492f207670d99f6f66505f14c63b /doc
parent2ae7cf8ef5be67e085abc1b1dc71bc44865a71b3 (diff)
Build: Add a makefile target for Doxygen documentation
You can now build the doxygen documentation with `make docs` and clean it with `make clean-docs`. Fixes: #11949
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
---------------------------