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
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
-[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)
@@ -120,10 +120,17 @@ public:
120
120
} // namespace foo
121
121
```
122
122
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).
125
127
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.
127
134
128
135
For example, to describe a function use:
129
136
```c++
@@ -156,7 +163,7 @@ int var; //!< Detailed description after the member
156
163
```
157
164
158
165
or
159
-
```cpp
166
+
```c++
160
167
//! Description before the member
161
168
int var;
162
169
```
@@ -176,15 +183,15 @@ Not OK (used plenty in the current source, but not picked up):
176
183
//
177
184
```
178
185
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.
183
188
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.
186
190
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:
0 commit comments