Source code documentation /** unification.
#1209
Open
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
- This commit focuses on structure. It does not change the numerous typos or spelling mistakes. - Consistently rely on "autobrief" feature: Remove `@brief`. - Replace `@value` with `@param`. - Replace `XXX` with `@todo`. - Replace unstructured `Inputs:` text with `@param[in]` and `Outputs:` with `@param[out]`.
|
Thank you! This looks very nice, though it's also very big and will take some time to review, but as long as we can see it's only commentary I think the review should be fast enough anyways. My only concern is conflicts with other PRs, but I can always hand-fix the conflicts. |
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.
@brief.@valuewith@param.XXXwith@todo.Inputs:text with@param[in]andOutputs:with@param[out].