[clang-doc][NFC] Fix missing documentation for EndLineNumber #138051
Conversation
This file contains hidden or 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
|
@llvm/pr-subscribers-clang-tools-extra Author: Paul Kirth (ilovepi) ChangesFull diff: https://github.com/llvm/llvm-project/pull/138051.diff 1 Files Affected:
diff --git a/clang-tools-extra/clang-doc/Representation.h b/clang-tools-extra/clang-doc/Representation.h
index b0b34fc6f08dd..d9b47cff8609d 100644
--- a/clang-tools-extra/clang-doc/Representation.h
+++ b/clang-tools-extra/clang-doc/Representation.h
@@ -262,8 +262,8 @@ struct Location {
std::tie(Other.StartLineNumber, Other.EndLineNumber, Other.Filename);
}
- int StartLineNumber = 0; // Line number of this Location.
- int EndLineNumber = 0;
+ int StartLineNumber = 0; // Line number of this Location.
+ int EndLineNumber = 0; // End line number of this Location.
SmallString<32> Filename; // File for this Location.
bool IsFileInRootDir = false; // Indicates if file is inside root directory
};
|
mysterymath
reviewed
May 7, 2025
| @@ -262,8 +262,8 @@ struct Location { | |||
| std::tie(Other.StartLineNumber, Other.EndLineNumber, Other.Filename); | |||
| } | |||
|
|
|||
| int StartLineNumber = 0; // Line number of this Location. | |||
| int EndLineNumber = 0; | |||
| int StartLineNumber = 0; // Line number of this Location. | |||
There was a problem hiding this comment.
Honestly comments like this are a bit of a pet peeve. None of these have any information that isn't already in the symbol name. I'd say that these comments should either provide some contextual hints about why this information is necessary, a more detailed description of their semantics, etc., or otherwise, should be removed.
There was a problem hiding this comment.
Fair, but I'd say that's fairly typical in LLVM as a whole. The missing comment for this field stands out more to me than the presence of the other comments.
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.
No description provided.