doc: Add to Doxygen documentation guidelines #16948
Closed
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
20a9971 to
b55a4a3
Compare
laanwj
reviewed
Sep 25, 2019
6e85299 to
305182e
Compare
ch4ot1c
commented
Oct 2, 2019
| - [Coding Style (C++)](#coding-style-c) | ||
| - [Coding Style (Python)](#coding-style-python) | ||
| - [Coding Style (Doxygen-compatible comments)](#coding-style-doxygen-compatible-comments) | ||
| - [Generating Documentation](#generating-documentation) |
There was a problem hiding this comment.
VSCode plugin "Markdown All in One" updated the ToC automatically, oops - shall we keep?
There was a problem hiding this comment.
TOC updates are welcome, but please keep the original spacing
| Needs rebase |
|
Closing "Up for Grabs". There's a couple of improvements here that could be picked up. |
jonatack
reviewed
Jan 5, 2020
| - [Compiling for gprof profiling](#compiling-for-gprof-profiling) | ||
| - [debug.log](#debuglog) | ||
| - [Testnet and Regtest modes](#testnet-and-regtest-modes) | ||
| - [DEBUG_LOCKORDER](#debuglockorder) |
There was a problem hiding this comment.
The #debug_lockorder link should not have been changed; the changed version no longer works.
There was a problem hiding this comment.
There are a couple improvements in the table of contents, but any unneeded formatting changes can be dropped.
fanquake
added a commit
that referenced
this pull request
Jan 14, 2020
c902c4c doc: Add to Doxygen documentation guidelines (Jon Layton) Pull request description: Completes the up-for-grabs PR #16948. Changes can be tested here: [doc/developer-notes.md](https://github.com/jonatack/bitcoin/blob/doxygen-developer-notes-improvements/doc/developer-notes.md) Co-authored-by: Jon Layton <me@jonl.io> ACKs for top commit: fanquake: ACK c902c4c - quick read, checked the new links work. laanwj: ACK c902c4c Tree-SHA512: 3b4cebba23061ad5243b2288c2006bf8527e74c689223825f96a44014875d15b2ab6ff54b8aa342ca657a14cf6ce3ab7d6e25bea5befd91162bc2645a74ddb7e
sidhujag
pushed a commit
to syscoin/syscoin
that referenced
this pull request
Jan 14, 2020
c902c4c doc: Add to Doxygen documentation guidelines (Jon Layton) Pull request description: Completes the up-for-grabs PR bitcoin#16948. Changes can be tested here: [doc/developer-notes.md](https://github.com/jonatack/bitcoin/blob/doxygen-developer-notes-improvements/doc/developer-notes.md) Co-authored-by: Jon Layton <me@jonl.io> ACKs for top commit: fanquake: ACK c902c4c - quick read, checked the new links work. laanwj: ACK c902c4c Tree-SHA512: 3b4cebba23061ad5243b2288c2006bf8527e74c689223825f96a44014875d15b2ab6ff54b8aa342ca657a14cf6ce3ab7d6e25bea5befd91162bc2645a74ddb7e
sidhujag
pushed a commit
to syscoin-core/syscoin
that referenced
this pull request
Nov 10, 2020
c902c4c doc: Add to Doxygen documentation guidelines (Jon Layton) Pull request description: Completes the up-for-grabs PR bitcoin#16948. Changes can be tested here: [doc/developer-notes.md](https://github.com/jonatack/bitcoin/blob/doxygen-developer-notes-improvements/doc/developer-notes.md) Co-authored-by: Jon Layton <me@jonl.io> ACKs for top commit: fanquake: ACK c902c4c - quick read, checked the new links work. laanwj: ACK c902c4c Tree-SHA512: 3b4cebba23061ad5243b2288c2006bf8527e74c689223825f96a44014875d15b2ab6ff54b8aa342ca657a14cf6ce3ab7d6e25bea5befd91162bc2645a74ddb7e
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add some tips to developer-notes.md, gathered while doing #16947. Also suggests the simpler
:notation for Javadoc arguments and adds@returnand@param[out]example.