Use Triple-Slash Doc-Comment Style in Code Generated by 'slice2cpp' #3206
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
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.
This PR implements part of #1853 (switch to using /// comments for C++).
Now, slice2cpp will always generate /// style comments instead of /** */ comments.
Additionally this PR also cleans up the comments in slice2cpp itself.
For a demo of how this change affects the generated code, see: InsertCreativityHere@69ffaa6.
I checked in the generated code (from ./slice/Ice) before and after this PR, so I could double-check the difference.
This PR is just a re-opening of #3190, now that I've fixed our doc-comments and the Slice scanner's handling of C-comments.