diff options
| -rw-r--r-- | clang-tools-extra/clang-tidy/readability/NamespaceCommentCheck.cpp | 39 | ||||
| -rw-r--r-- | clang-tools-extra/unittests/clang-tidy/ReadabilityModuleTest.cpp | 10 |
2 files changed, 27 insertions, 22 deletions
diff --git a/clang-tools-extra/clang-tidy/readability/NamespaceCommentCheck.cpp b/clang-tools-extra/clang-tidy/readability/NamespaceCommentCheck.cpp index 76856ee7aa0..61c7b36a06e 100644 --- a/clang-tools-extra/clang-tidy/readability/NamespaceCommentCheck.cpp +++ b/clang-tools-extra/clang-tidy/readability/NamespaceCommentCheck.cpp @@ -82,6 +82,9 @@ void NamespaceCommentCheck::check(const MatchFinder::MatchResult &Result) { // to insert a line break. bool NeedLineBreak = NextTokenIsOnSameLine && Tok.isNot(tok::eof); + SourceRange OldCommentRange(AfterRBrace, AfterRBrace); + StringRef Message = "%0 not terminated with a closing comment"; + // Try to find existing namespace closing comment on the same line. if (Tok.is(tok::comment) && NextTokenIsOnSameLine) { StringRef Comment(Sources.getCharacterData(Loc), Tok.getLength()); @@ -101,20 +104,22 @@ void NamespaceCommentCheck::check(const MatchFinder::MatchResult &Result) { // Otherwise we need to fix the comment. NeedLineBreak = Comment.startswith("/*"); - CharSourceRange OldCommentRange = CharSourceRange::getCharRange( - SourceRange(Loc, Loc.getLocWithOffset(Tok.getLength()))); - diag(Loc, "namespace closing comment refers to a wrong namespace '%0'") - << NamespaceNameInComment - << FixItHint::CreateReplacement( - OldCommentRange, getNamespaceComment(ND, NeedLineBreak)); - return; - } - - // This is not a recognized form of a namespace closing comment. - // Leave line comment on the same line. Move block comment to the next line, - // as it can be multi-line or there may be other tokens behind it. - if (Comment.startswith("//")) + OldCommentRange = + SourceRange(AfterRBrace, Loc.getLocWithOffset(Tok.getLength())); + Message = + (llvm::Twine( + "%0 ends with a comment that refers to a wrong namespace '") + + NamespaceNameInComment + "'").str(); + } else if (Comment.startswith("//")) { + // Assume that this is an unrecognized form of a namespace closing line + // comment. Replace it. NeedLineBreak = false; + OldCommentRange = + SourceRange(AfterRBrace, Loc.getLocWithOffset(Tok.getLength())); + Message = "%0 ends with an unrecognized comment"; + } + // If it's a block comment, just move it to the next line, as it can be + // multi-line or there may be other tokens behind it. } std::string NamespaceName = @@ -122,11 +127,11 @@ void NamespaceCommentCheck::check(const MatchFinder::MatchResult &Result) { ? "anonymous namespace" : ("namespace '" + ND->getNameAsString() + "'"); - diag(AfterRBrace, "%0 not terminated with a closing comment") + diag(AfterRBrace, Message) << NamespaceName - << FixItHint::CreateInsertion(AfterRBrace, - std::string(SpacesBeforeComments, ' ') + - getNamespaceComment(ND, NeedLineBreak)); + << FixItHint::CreateReplacement( + OldCommentRange, std::string(SpacesBeforeComments, ' ') + + getNamespaceComment(ND, NeedLineBreak)); diag(ND->getLocation(), "%0 starts here", DiagnosticIDs::Note) << NamespaceName; } diff --git a/clang-tools-extra/unittests/clang-tidy/ReadabilityModuleTest.cpp b/clang-tools-extra/unittests/clang-tidy/ReadabilityModuleTest.cpp index 8c7007ce291..70e320b6c03 100644 --- a/clang-tools-extra/unittests/clang-tidy/ReadabilityModuleTest.cpp +++ b/clang-tools-extra/unittests/clang-tidy/ReadabilityModuleTest.cpp @@ -75,11 +75,6 @@ TEST(NamespaceCommentCheckTest, CheckExistingComments) { runCheckOnCode<NamespaceCommentCheck>("namespace {\n" "}\n" "// namespace")); - // Leave unknown comments. - EXPECT_EQ("namespace {\n" - "} // namespace // random text", - runCheckOnCode<NamespaceCommentCheck>("namespace {\n" - "} // random text")); } TEST(NamespaceCommentCheckTest, FixWrongComments) { @@ -94,6 +89,11 @@ TEST(NamespaceCommentCheckTest, FixWrongComments) { "} // namespace", runCheckOnCode<NamespaceCommentCheck>("namespace {\n" "} // namespace asdf")); + // Remove unknown comments. + EXPECT_EQ("namespace {\n" + "} // namespace", + runCheckOnCode<NamespaceCommentCheck>("namespace {\n" + "} // random text")); } TEST(BracesAroundStatementsCheck, IfWithComments) { |
