Skip to content

Commit fd83c57

Browse files
author
MarcoFalke
committed
Merge #14832: docs: Add more Doxygen information to Developer Notes
a62e667 docs: Add more Doxygen information to Developer Notes (Jon Layton) Pull request description: Update information about Doxygen in `doc/developer-notes.md`. Alternatively, this could have its own file (like `doc/web-documentation.md`), since there are installation steps included. For example, I had to run: ``` brew install doxygen graphviz ``` on MacOS, otherwise failures occurred. This information could also be linked to the `doc/release-process.md`. Tree-SHA512: 5d77ee83e1b96fde036482b502f676a90a56f3f667753545a7cfba5c2e3b825644bb4cf0f8a84b7f9ba92fa5f2e1cd6ef1e27a94277f43d012355df741f7dd2f
2 parents f51aeac + a62e667 commit fd83c57

File tree

1 file changed

+19
-12
lines changed

1 file changed

+19
-12
lines changed

doc/developer-notes.md

Lines changed: 19 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ Developer Notes
77
- [Developer Notes](#developer-notes)
88
- [Coding Style (General)](#coding-style-general)
99
- [Coding Style (C++)](#coding-style-c)
10-
- [Doxygen comments](#doxygen-comments)
1110
- [Coding Style (Python)](#coding-style-python)
11+
- [Coding Style (Doxygen-compatible comments)](#coding-style-doxygen-compatible-comments)
1212
- [Development tips and tricks](#development-tips-and-tricks)
1313
- [Compiling for debugging](#compiling-for-debugging)
1414
- [Compiling for gprof profiling](#compiling-for-gprof-profiling)
@@ -120,10 +120,17 @@ public:
120120
} // namespace foo
121121
```
122122

123-
Doxygen comments
124-
-----------------
123+
Coding Style (Python)
124+
---------------------
125+
126+
Refer to [/test/functional/README.md#style-guidelines](/test/functional/README.md#style-guidelines).
125127

126-
To facilitate the generation of documentation, use doxygen-compatible comment blocks for functions, methods and fields.
128+
Coding Style (Doxygen-compatible comments)
129+
------------------------------------------
130+
131+
Bitcoin Core uses [Doxygen](http://www.doxygen.nl/) to generate its official documentation.
132+
133+
Use Doxygen-compatible comment blocks for functions, methods, and fields.
127134

128135
For example, to describe a function use:
129136
```c++
@@ -156,7 +163,7 @@ int var; //!< Detailed description after the member
156163
```
157164

158165
or
159-
```cpp
166+
```c++
160167
//! Description before the member
161168
int var;
162169
```
@@ -176,15 +183,15 @@ Not OK (used plenty in the current source, but not picked up):
176183
//
177184
```
178185

179-
A full list of comment syntaxes picked up by doxygen can be found at http://www.stack.nl/~dimitri/doxygen/manual/docblocks.html,
180-
but if possible use one of the above styles.
181-
182-
Documentation can be generated with `make docs` and cleaned up with `make clean-docs`.
186+
A full list of comment syntaxes picked up by Doxygen can be found at https://www.stack.nl/~dimitri/doxygen/manual/docblocks.html,
187+
but the above styles are favored.
183188

184-
Coding Style (Python)
185-
---------------------
189+
Documentation can be generated with `make docs` and cleaned up with `make clean-docs`. The resulting files are located in `doc/doxygen/html`; open `index.html` to view the homepage.
186190

187-
Refer to [/test/functional/README.md#style-guidelines](/test/functional/README.md#style-guidelines).
191+
Before running `make docs`, you will need to install dependencies `doxygen` and `dot`. For example, on MacOS via Homebrew:
192+
```
193+
brew install doxygen --with-graphviz
194+
```
188195

189196
Development tips and tricks
190197
---------------------------

0 commit comments

Comments
 (0)