Tweak formatting of function DocC comments #407
Merged
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
glbrntt
approved these changes
Jul 5, 2023
Motivation: Tweaking the formatting of the DocC comments enables syntax highlighting for parameter names in Xcode Modifications: Whitespace changes, capitalisation changes and added a parameter description for `indexing` in HOACKHeaders `replaceOrAdd`, `add`. Result: More readable DocC comments
rnro
force-pushed
the
cleanup_docc_comment_formatting
branch
from
0e61366 to
4418781
Compare
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.
Motivation:
Tweaking the formatting of the DocC comments enables syntax highlighting for parameter names in Xcode
Modifications:
Whitespace changes, capitalisation changes and added a parameter description for
indexingin HOACKHeadersreplaceOrAdd,add.Result:
More readable DocC comments