diff options
author | fanquake <fanquake@gmail.com> | 2020-01-11 11:53:16 +0800 |
---|---|---|
committer | fanquake <fanquake@gmail.com> | 2020-01-11 12:20:15 +0800 |
commit | e258ce792a4849927a6db51786732d71cbbb65fc (patch) | |
tree | 31599f87964e332c1d4d9fd72f72ac0d30d988e2 /src/random.h | |
parent | f8c69677a1a899a662e02cff20b79dbe924f05dd (diff) | |
parent | 498cdbb42616bc1e6c44492c907678b4dce41870 (diff) |
Merge #17907: doc: Fix improper Doxygen inline comments
498cdbb42616bc1e6c44492c907678b4dce41870 Fix improper Doxygen inline comments (Ben Woosley)
Pull request description:
The proper syntax is `//!<`
http://www.doxygen.nl/manual/docblocks.html#memberdoc
Identified via `-Wdocumentation`:
```
In file included from ./util/system.h:26:
./util/settings.h:74:41: error: not a Doxygen trailing comment [-Werror,-Wdocumentation]
const SettingsValue* begin() const; //<! Pointer to first non-negated value.
^~~~
///<
./util/settings.h:75:41: error: not a Doxygen trailing comment [-Werror,-Wdocumentation]
const SettingsValue* end() const; //<! Pointer to end of values.
^~~~
///<
./util/settings.h:76:41: error: not a Doxygen trailing comment [-Werror,-Wdocumentation]
bool empty() const; //<! True if there are any non-negated values.
^~~~
///<
./util/settings.h:77:41: error: not a Doxygen trailing comment [-Werror,-Wdocumentation]
bool last_negated() const; //<! True if the last value is negated.
^~~~
///<
./util/settings.h:78:41: error: not a Doxygen trailing comment [-Werror,-Wdocumentation]
size_t negated() const; //<! Number of negated values.
^~~~
///<
```
ACKs for top commit:
fanquake:
ACK 498cdbb42616bc1e6c44492c907678b4dce41870
Tree-SHA512: 2851fc1cbbcf700d198d82ce4923b2ef4a700f8ce19dff431ecf24f4e6fecda9fed1b4b4d148f3c1adfb6b0c6bff5d5315ee01bbcd855eb3d83e1a69b0c98893
Diffstat (limited to 'src/random.h')
0 files changed, 0 insertions, 0 deletions