Rename Comment to DocComment in the Slice Compilers
#3170
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
| @@ -321,7 +321,7 @@ Slice::filterMcppWarnings(const string& message) | |||
| } | |||
|
|
|||
| void | |||
| Slice::printGeneratedHeader(IceInternal::Output& out, const string& path, const string& comment) | |||
There was a problem hiding this comment.
This variable was named commentStyle in the header file:
printGeneratedHeader(IceInternal::Output& out, const std::string& path, const std::string& commentStyle = "//");
I fixed this to use the same name. Header and source files should use the same name IMO.
externl
approved these changes
Nov 20, 2024
Comment on lines
-119
to
-124
| bool keepComments = true; | ||
|
|
||
| for (const auto& file : files) | ||
| { | ||
| Slice::PreprocessorPtr icecpp = Slice::Preprocessor::create("icecpp", file, cppArgs); | ||
| FILE* cppHandle = icecpp->preprocess(keepComments, "-D__SLICE2PY__"); |
There was a problem hiding this comment.
I just happened across this while rging for \bComment.
It definitely looks like an unused variable, but maybe there was some IcePy magic reason for it to exist?
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 #3141 by changing all types and 'public' functions that talk about 'Comment' to talk about 'DocComment's instead.
There were plenty of local variables named
comment. I left these alone. It's already very clear from the context that these are doc-comments.