Added Options for Doxygen Comments

Author: 4m4n-x-B4w4ne

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

@@ -17,11 +17,15 @@ using namespace clang::ast_matchers;
 namespace clang::tidy::readability {
 class UseCppStyleCommentsCheck::CStyleCommentHandler : public CommentHandler {
 public:
-  CStyleCommentHandler(UseCppStyleCommentsCheck &Check)
+  CStyleCommentHandler(UseCppStyleCommentsCheck &Check, bool ExcludeDoxygen)
       : Check(Check),
         CStyleCommentMatch(
-            "^[ \t]*/\\*+[ \t\r\n]*(.*[ \t\r\n]*)*[ \t\r\n]*\\*+/[ \t\r\n]*$") {
-  }
+            "^[ \t]*/\\*+[ \t\r\n]*(.*[ \t\r\n]*)*[ \t\r\n]*\\*+/[ \t\r\n]*$"),
+        ExcludeDoxygen(ExcludeDoxygen) {}
+
+  void setExcludeDoxygen(bool Exclude) { ExcludeDoxygen = Exclude; }
+
+  bool isExcludeDoxygen() const { return ExcludeDoxygen; }
 
   std::string convertToCppStyleComment(const SourceManager &SM,
                                        const SourceRange &Range) {
@@ -58,6 +62,14 @@ class UseCppStyleCommentsCheck::CStyleCommentHandler : public CommentHandler {
     return Result;
   }
 
+  bool isDoxygenStyleComment(const StringRef &Text) {
+    StringRef Trimmed = Text.ltrim();
+    return Trimmed.starts_with("/**") || Trimmed.starts_with("/*!") ||
+           Trimmed.starts_with("///") || Trimmed.starts_with("//!") ||
+           (Trimmed.starts_with("/*") &&
+            Trimmed.drop_front(2).starts_with("*"));
+  }
+
   bool CheckForInlineComments(Preprocessor &PP, SourceRange Range) {
     const SourceManager &SM = PP.getSourceManager();
     const SourceLocation CommentStart = Range.getBegin();
@@ -100,6 +112,10 @@ class UseCppStyleCommentsCheck::CStyleCommentHandler : public CommentHandler {
     const StringRef Text = Lexer::getSourceText(
         CharSourceRange::getCharRange(Range), SM, PP.getLangOpts());
 
+    if (ExcludeDoxygen && isDoxygenStyleComment(Text)) {
+      return false;
+    }
+
     SmallVector<StringRef> Matches;
     if (!CStyleCommentMatch.match(Text, &Matches)) {
       return false;
@@ -120,13 +136,15 @@ class UseCppStyleCommentsCheck::CStyleCommentHandler : public CommentHandler {
 
 private:
   UseCppStyleCommentsCheck &Check;
+  bool ExcludeDoxygen;
   llvm::Regex CStyleCommentMatch;
 };
 
 UseCppStyleCommentsCheck::UseCppStyleCommentsCheck(StringRef Name,
                                                    ClangTidyContext *Context)
     : ClangTidyCheck(Name, Context),
-      Handler(std::make_unique<CStyleCommentHandler>(*this)) {}
+      Handler(std::make_unique<CStyleCommentHandler>(
+          *this, Options.get("ExcludeDoxygenStyleComments", false))) {}
 
 void UseCppStyleCommentsCheck::registerPPCallbacks(
     const SourceManager &SM, Preprocessor *PP, Preprocessor *ModuleExpanderPP) {
@@ -135,5 +153,10 @@ void UseCppStyleCommentsCheck::registerPPCallbacks(
 
 void UseCppStyleCommentsCheck::check(const MatchFinder::MatchResult &Result) {}
 
+void UseCppStyleCommentsCheck::storeOptions(ClangTidyOptions::OptionMap &Opts) {
+  Options.store(Opts, "ExcludeDoxygenStyleComments",
+                Handler->isExcludeDoxygen());
+}
+
 UseCppStyleCommentsCheck::~UseCppStyleCommentsCheck() = default;
-} // namespace clang::tidy::readability
+} // namespace clang::tidy::readability

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

@@ -15,6 +15,8 @@
 namespace clang::tidy::readability {
 /// Detects C Style comments and suggests to use C++ style comments instead.
 ///
+/// Optionally excludes Doxygen-style comments.
+///
 /// For the user-facing documentation see:
 /// http://clang.llvm.org/extra/clang-tidy/checks/readability/use-cpp-style-comments.html
 class UseCppStyleCommentsCheck : public ClangTidyCheck {
@@ -32,9 +34,13 @@ class UseCppStyleCommentsCheck : public ClangTidyCheck {
 
   void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
 
+  void storeOptions(ClangTidyOptions::OptionMap &Opts) override;
+
 private:
   class CStyleCommentHandler;
   std::unique_ptr<CStyleCommentHandler> Handler;
+  const bool ExcludeDoxygenStyleComments =
+      Options.get("ExcludeDoxygenStyleComments", false);
 };
 } // namespace clang::tidy::readability
 

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 -- --
+// 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}]}"
 
 // Single-line full C-style comment
 static const int CONSTANT = 42; /* Important constant value */
@@ -24,16 +24,6 @@ void processData(int data /* input data */,
     fnWithSomeBools(/*ControlsA=*/ true, /*ControlsB=*/ false);
 }
 
-// Multiline comment with asterisk styling
-/*******************************
- * Block comment with asterisks
- * Should be converted to C++ style
- *******************************/
-// CHECK-MESSAGES: :[[@LINE-4]]:1: warning: use C++ style comments '//' instead of C style comments '/*...*/' [readability-use-cpp-style-comments]
-// CHECK-FIXES: // ******************************
-// CHECK-FIXES: // * Block comment with asterisks
-// CHECK-FIXES: // * Should be converted to C++ style
-// CHECK-FIXES: // ******************************
 int calculateSomething() { return 1;}
 // Comment at end of complex line
 int complexCalculation = calculateSomething(); /* Result of complex calculation */
@@ -66,3 +56,36 @@ void complexFunction() {
     // CHECK-MESSAGES: :[[@LINE-1]]:17: warning: use C++ style comments '//' instead of C style comments '/*...*/' [readability-use-cpp-style-comments]
     // 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();
+
+/*!
+ * 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();