Doxygen libs #1493
Merged
Doxygen libs #1493
Conversation
This commit takes descriptions for src/lib and moves them into our doxygen hierarchy. I've covered everything from lib/cc through lib/sandbox here.
We need to use this kind of trickery to make directory links work in out-of-tree builds.
This commit was generated with:
find src -name '*.dox' |xargs perl -i -pe 's{\\ref src/(\S+) \"\S+}{\\refdir{$1}};'
This one was missed by the perl script in the last commit because it spanned a newline.
(This copies documentation from doc/HACKING/design, and edits for concisensess and clarity.)
Pull Request Test Coverage Report for Build 7051
|
dgoulet-tor
reviewed
Nov 5, 2019
| @@ -1,4 +1,5 @@ | |||
| /** | |||
| @dir /feature/hs | |||
| @brief feature/hs | |||
| @brief feature/hs: v3 (current) onion service protocol | |||
I would be super greatful if you would put here a ref to the rend-spec-v3.txt :D like it was done above:
| - `ext` -- Code maintained elsewhere that we include in the Tor | ||
| source distribution. | ||
|
|
||
| - \refdir{lib} -- Lower-level utility code, not necessarily |
Not sure refdir outputs properly:
I get:
./src/lib "lib" – Lower-level utility code, not necessarily tor-specific.
Hm. It works for me -- let's see how it works when we build the website.
| design paper and the specifications at https://spec.torproject.org/ . | ||
|
|
||
| For more information about Tor's coding standards and some helpful | ||
| development tools, see doc/HACKING in the Tor repository. |
Probably would be nice to have a ref to doc/HACKING so user can click on.
| @@ -1,4 +1,5 @@ | |||
| /** | |||
| @dir /feature/rend | |||
| @brief feature/rend | |||
| @brief feature/rend: version 2 (old) hidden services | |||
Same goes for this with rend-spec.txt.
| @dir /feature/dirauth | ||
| @brief feature/dirauth: Directory authority implementation. | ||
|
|
||
| This module handles running Tor as a directory authority. |
Maybe ref to dir-spec.txt.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
No description provided.
The text was updated successfully, but these errors were encountered: