Skip to content

Commit a62e667

Browse files
committed
docs: Add more Doxygen information to Developer Notes
1 parent 60b20c8 commit a62e667

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)
@@ -118,10 +118,17 @@ public:
118118
} // namespace foo
119119
```
120120

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

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

126133
For example, to describe a function use:
127134
```c++
@@ -154,7 +161,7 @@ int var; //!< Detailed description after the member
154161
```
155162

156163
or
157-
```cpp
164+
```c++
158165
//! Description before the member
159166
int var;
160167
```
@@ -174,15 +181,15 @@ Not OK (used plenty in the current source, but not picked up):
174181
//
175182
```
176183

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

182-
Coding Style (Python)
183-
---------------------
187+
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.
184188

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

187194
Development tips and tricks
188195
---------------------------

0 commit comments

Comments
 (0)