Improved Logic and added new test file

Author: 4m4n-x-B4w4ne

clang-tools-extra/clang-tidy/readability/UseCppStyleCommentsCheck.cpp

@@ -70,36 +70,23 @@ class UseCppStyleCommentsCheck::CStyleCommentHandler : public CommentHandler {
             Trimmed.drop_front(2).starts_with("*"));
   }
 
-  bool CheckForInlineComments(Preprocessor &PP, SourceRange Range) {
+  bool CheckForTextAfterComment(Preprocessor &PP, SourceRange Range) {
     const SourceManager &SM = PP.getSourceManager();
-    const SourceLocation CommentStart = Range.getBegin();
     const SourceLocation CommentEnd = Range.getEnd();
 
-    unsigned StartLine = SM.getSpellingLineNumber(CommentStart);
     unsigned EndLine = SM.getSpellingLineNumber(CommentEnd);
-
-    const StringRef Text = Lexer::getSourceText(
-        CharSourceRange::getCharRange(Range), SM, PP.getLangOpts());
-
-    if (StartLine == EndLine) {
-      const SourceLocation LineBegin =
-          SM.translateLineCol(SM.getFileID(CommentStart), StartLine, 1);
-      const SourceLocation LineEnd =
-          SM.translateLineCol(SM.getFileID(CommentEnd), EndLine,
-                              std::numeric_limits<unsigned>::max());
-      const StringRef LineContent = Lexer::getSourceText(
-          CharSourceRange::getCharRange(LineBegin, LineEnd), SM,
-          PP.getLangOpts());
-      const size_t CommentStartOffset =
-          SM.getSpellingColumnNumber(CommentStart) - 1;
-      const StringRef AfterComment =
-          LineContent.drop_front(CommentStartOffset + Text.size());
-
-      if (!AfterComment.trim().empty()) {
-        return true;
-      }
-    }
-    return false;
+    unsigned EndCol = SM.getSpellingColumnNumber(CommentEnd);
+  
+    const SourceLocation LineBegin =
+        SM.translateLineCol(SM.getFileID(CommentEnd),EndLine, EndCol);
+    const SourceLocation LineEnd =
+        SM.translateLineCol(SM.getFileID(CommentEnd), EndLine,
+                            std::numeric_limits<unsigned>::max());
+    const StringRef AfterComment = Lexer::getSourceText(
+        CharSourceRange::getCharRange(LineBegin, LineEnd), SM,
+        PP.getLangOpts());
+
+  return !AfterComment.trim().empty();
   }
 
   bool HandleComment(Preprocessor &PP, SourceRange Range) override {
@@ -121,7 +108,7 @@ class UseCppStyleCommentsCheck::CStyleCommentHandler : public CommentHandler {
       return false;
     }
 
-    if (CheckForInlineComments(PP, Range)) {
+    if (CheckForTextAfterComment(PP, Range)) {
       return false;
     }
 

clang-tools-extra/docs/clang-tidy/checks/readability/use-cpp-style-comments.rst

@@ -41,3 +41,11 @@ Output:
   .. code-block:: c++
 
     int a = /* this is a comment */ 5;
+
+Options
+-------
+
+.. option:: ExcludeDoxygenStyleComments
+
+   A boolean option that determines whether Doxygen-style comments should be excluded.  
+   By default, this option is set to ``false``.  

clang-tools-extra/test/clang-tidy/checkers/readability/use-cpp-style-comments-doxygen.cpp

@@ -0,0 +1,34 @@
+// RUN: %check_clang_tidy -std=c++11 %s readability-use-cpp-style-comments %t -config="{CheckOptions: [{key: readability-use-cpp-style-comments.ExcludeDoxygenStyleComments, value: true}]}"
+
+// Tests for Doxygen comments with ExcludeDoxygenStyleComments enabled
+/**
+ * This is a Doxygen comment for a function.
+ * It should NOT be transformed.
+ */
+void doxygenFunction1();
+
+/*!
+ * This is another Doxygen-style comment.
+ * It should also NOT be transformed.
+ */
+void doxygenFunction2();
+
+/**
+ * Multiline Doxygen comment describing parameters.
+ *
+ * @param x The first parameter.
+ * @param y The second parameter.
+ * @return A result value.
+ */
+int doxygenFunctionWithParams(int x, int y);
+
+/*******************************
+ * Non-Doxygen block comments without markers
+ *******************************/
+void DoxygenBlock();
+
+/*!
+ * This is a single-line Doxygen comment.
+ * Should NOT be transformed.
+ */
+void singleLineDoxygen();

clang-tools-extra/test/clang-tidy/checkers/readability/use-cpp-style-comments.cpp

@@ -1,4 +1,4 @@
-// RUN: %check_clang_tidy -std=c++11 %s readability-use-cpp-style-comments %t -config="{CheckOptions: [{key: readability-use-cpp-style-comments.ExcludeDoxygenStyleComments, value: true}]}"
+// RUN: %check_clang_tidy -std=c++11 %s readability-use-cpp-style-comments %t 
 
 // Single-line full C-style comment
 static const int CONSTANT = 42; /* Important constant value */
@@ -57,35 +57,12 @@ void complexFunction() {
     // CHECK-FIXES: int x = 10; // Inline comment not to be transformed
 }
 
-// Tests for Doxygen comments with ExcludeDoxygenStyleComments enabled
-/**
- * This is a Doxygen comment for a function.
- * It should NOT be transformed.
- */
-void doxygenFunction1();
+/* aaa 
+    bbbb
+    ccc */ int z = 1;
+// There is a text after the comment ends so it should be ignored.
 
-/*!
- * This is another Doxygen-style comment.
- * It should also NOT be transformed.
- */
-void doxygenFunction2();
-
-/**
- * Multiline Doxygen comment describing parameters.
- *
- * @param x The first parameter.
- * @param y The second parameter.
- * @return A result value.
- */
-int doxygenFunctionWithParams(int x, int y);
-
-/*******************************
- * Non-Doxygen block comments without markers
- *******************************/
-void DoxygenBlock();
-
-/*!
- * This is a single-line Doxygen comment.
- * Should NOT be transformed.
- */
-void singleLineDoxygen();
+int y = 10;/* aaa 
+    bbbb
+    ccc */ int z1 = 1;
+// There is a text after the comment ends so it should be ignored.