@@ -168,7 +168,7 @@ Refer to [/test/functional/README.md#style-guidelines](/test/functional/README.m
168
168
Coding Style (Doxygen-compatible comments)
169
169
------------------------------------------
170
170
171
- Dash Core uses [ Doxygen] ( http ://www.doxygen.nl/) to generate its official documentation.
171
+ Dash Core uses [ Doxygen] ( https ://www.doxygen.nl/) to generate its official documentation.
172
172
173
173
Use Doxygen-compatible comment blocks for functions, methods, and fields.
174
174
@@ -189,7 +189,7 @@ For example, to describe a function use:
189
189
bool function (int arg1, const char * arg2, std::string& arg3)
190
190
```
191
191
192
- A complete list of `@xxx` commands can be found at http ://www.stack .nl/~dimitri/doxygen /manual/commands.html.
192
+ A complete list of `@xxx` commands can be found at https ://www.doxygen .nl/manual/commands.html.
193
193
As Doxygen recognizes the comments by the delimiters (`/**` and `*/` in this case), you don't
194
194
*need* to provide any commands for a comment to be valid; just a description text is fine.
195
195
@@ -229,7 +229,14 @@ Not picked up by Doxygen:
229
229
//
230
230
```
231
231
232
- A full list of comment syntaxes picked up by Doxygen can be found at https://www.stack.nl/~dimitri/doxygen/manual/docblocks.html ,
232
+ Also not picked up by Doxygen:
233
+ ``` c++
234
+ /*
235
+ * ... Description ...
236
+ */
237
+ ```
238
+
239
+ A full list of comment syntaxes picked up by Doxygen can be found at https://www.doxygen.nl/manual/docblocks.html ,
233
240
but the above styles are favored.
234
241
235
242
Recommendations:
@@ -242,7 +249,7 @@ Recommendations:
242
249
243
250
- Backticks aren't required when referring to functions Doxygen already knows
244
251
about; it will build hyperlinks for these automatically. See
245
- http ://www.doxygen.nl/manual/autolink.html for complete info.
252
+ https ://www.doxygen.nl/manual/autolink.html for complete info.
246
253
247
254
- Avoid linking to external documentation; links can break.
248
255
0 commit comments