diff options
| author | MarcoFalke <falke.marco@gmail.com> | 2019-10-11 16:27:57 -0400 |
|---|---|---|
| committer | MarcoFalke <falke.marco@gmail.com> | 2019-10-11 16:28:03 -0400 |
| commit | 561a7d30478b82f5d46dcf0f16e864a9608004f4 (patch) | |
| tree | 603178408253474be1f1212f34d56024bd5ff357 /src/consensus | |
| parent | f4d93078dde502bb6a77dcc94ac6eafe20e36324 (diff) | |
| parent | 15ac916642f20918f66e32729bb6b0b674e3bc24 (diff) | |
Merge #16947: doc: Doxygen-friendly script/descriptor.h comments
15ac916642f20918f66e32729bb6b0b674e3bc24 doc: Doxygen-friendly descriptor.h comments (Jon Layton)
Pull request description:
Closes #16942.
- Make `Descriptor` overview subtext of `Interface for parsed descriptor objects.`
- Conform to `@param[in, out] argname: Info` in parameter comments. Present in code: https://github.com/bitcoin/bitcoin/blob/feb162d500273040c8a2e5cdd3393edf34dff45b/src/net_processing.cpp#L1001
- Remove redundant argument type, `in` vs `out` mentions
- Removed unnecessary backticks around `IsSolvable()`, since Doxygen builds a link to the known function's docs
- Add backticks to refer to `argname`s
`descriptor.cpp` has more documentation, but Doxygen's output doesn't include anything inside unnamed namespaces for some reason. Tried to access them via searchbar.
Top commit has no ACKs.
Tree-SHA512: 587cc7596de46358a08b0321a7cf08a08785945715dbdce8945d837e1bee0664d1e11b1e47b7be85c4f35262f7ea173fb1f6202efcacc2023e2c6b0bd44133b3
Diffstat (limited to 'src/consensus')
0 files changed, 0 insertions, 0 deletions