Autosection #164
Merged
Autosection #164
Conversation
This file contains 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
With the introduction of directives for extracting documentation for individual symbols, documentation comments not related to any symbols were slightly neglected. The only way to grab them is to use c:autodoc or cpp:autodoc. Introduce directives for extracting documentation for individual text documentation comments, or "top level comments" as referred to in the parser. The obvious downside is having to add means to reference the comments by name, which means parsing documentation comments. To keep it simple, the name shall be from the first alphanumeric character in the comment, inclusive, to the next :, ., or newline, non-inclusive, with no further parsing. Note that this does *not* automatically generate any hyperlink targets or Sphinx domain directives. Use c:autosection and cpp:autosection naming with the idea of extending the directives with the :members: option later to include a section of documentation between top level comments.
Closed
|
Looks good to me ;) Created #166 so we remember the members stuff. |
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.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
#161 with
c:autosectionandcpp:autosectionnaming, and some tweaks on the documentation/examples, but no real functional changes.