Mirrors/overte-thingvellir
3
0
Fork 0
mirror of https://thingvellir.net/git/overte synced 2025-03-27 23:52:03 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

Add Doxygen comments information

Browse source
This commit is contained in:
David Rowe 2021-05-20 09:51:51 +12:00
parent 6afb8044ea
commit 6e3c680487
2 changed files with 14 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
CODING_STANDARD.md
View file

@ -948,7 +948,7 @@ In an international environment English is the preferred language.
#### [4.3.2] Use // for all comments, including multi-line comments.
An exception to this rule applies for jsdoc or Doxygen comments.
An exception to this rule applies to JSDoc and Doxygen comments.
```cpp
// Comment spanning
@ -1008,3 +1008,11 @@ These types of comments are explicitly not allowed. If you need to break up sect
//--------------------------------------------------------------------------------
```
#### [4.3.6] Doxygen comments should use "///"
Use the `///` style of [Doxygen](https://www.doxygen.nl/index.html) comments when documenting public interfaces.
Some editors can automatically create a Doxygen documentation stub if you type `///` in the line above the item to be
documented.
**Visual Studio:** To configure Visual Studio's Doxygen commenting behavior, search for "Doxygen" in Tools > Options.

5
tools/doxygen/README.md
View file

@ -12,6 +12,11 @@ Make a `/build/doxygen/` directory.
If you want to run Doxygen from a command prompt, add the Doxygen install's `/bin` directory to your system PATH.
## Documenting
See section 4.3.6 of the [*Coding Standard*](../../CODING_STANDARD.md).
## Running
### Using the Doxywizard GUI