Create skeleton for doxygen comments #41
Merged
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.
This commit creates a skeleton for Doxygen comments. It highlights locations where doxygen comments should appear with simple placeholder comments, most of which need to be improved. This PR is meant as a discussion base for agreeing on an appropriate content level and layout of these comments and is thus a work in progress.
Currently, all comments are one-liners and thus follow the
\\!
syntax. However, multi-line comments can be created withEvery function with the
override
keyword inherits the virtual function's doxygen comment and thus does not need its own docstring unless there are mention-worthy differences.