You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
-[Development tips and tricks](#development-tips-and-tricks)
13
13
-[Compiling for debugging](#compiling-for-debugging)
14
14
-[Compiling for gprof profiling](#compiling-for-gprof-profiling)
@@ -118,10 +118,17 @@ public:
118
118
} // namespace foo
119
119
```
120
120
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).
123
125
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.
125
132
126
133
For example, to describe a function use:
127
134
```c++
@@ -154,7 +161,7 @@ int var; //!< Detailed description after the member
154
161
```
155
162
156
163
or
157
-
```cpp
164
+
```c++
158
165
//! Description before the member
159
166
int var;
160
167
```
@@ -174,15 +181,15 @@ Not OK (used plenty in the current source, but not picked up):
174
181
//
175
182
```
176
183
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.
181
186
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.
184
188
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:
0 commit comments