@@ -65,6 +65,7 @@ Make sure you have these programs installed:
65
65
* git
66
66
* [ clang-tidy] ( #clang-tidy ) (optional)
67
67
* [ cppcheck] ( #cppcheck ) (optional)
68
+ * [ Doxygen] ( #doxygen ) (optional)
68
69
69
70
` cmake-init ` consists of a single file that can be run using Python. Python was
70
71
chosen for this, because it is cross-platform, convenient for this use-case and
@@ -111,6 +112,18 @@ use it locally, but it is recommended.
111
112
reason for this is that only [ Makefiles and Ninja] [ 9 ] are supported with CMake
112
113
for use with cppcheck. For other generators, this feature is a no-op.
113
114
115
+ ### Doxygen
116
+
117
+ [ Doxygen] [ 11 ] is a tool to generate documentation from annotated source code.
118
+ In conjunction with it, [ m.css] [ 12 ] is used for presenting the generated
119
+ documentation.
120
+
121
+ The generated projects will have a ` docs ` target in developer mode, which can
122
+ be used to build the documentation into the ` <binary-dir>/docs/html ` directory.
123
+
124
+ After Doxygen is installed, please make sure the ` doxygen ` executable exists in
125
+ the ` PATH ` , otherwise you might get confusing error messages.
126
+
114
127
## Usage
115
128
116
129
* ` cmake-init <path> `
@@ -152,3 +165,5 @@ indirectly from the use or non-use of these files.
152
165
[ 8 ] : http://cppcheck.sourceforge.net/
153
166
[ 9 ] : https://cmake.org/cmake/help/latest/prop_tgt/LANG_CPPCHECK.html
154
167
[ 10 ] : https://github.com/microsoft/vcpkg
168
+ [ 11 ] : https://www.doxygen.nl/
169
+ [ 12 ] : https://mcss.mosra.cz/
0 commit comments