Allow checking which doxygen style is used

kunaltyagi · Sep 14, 2024 · a5c4e0f · a5c4e0f
1 parent 655e0e9
commit a5c4e0f
Show file tree

Hide file tree

Showing 6 changed files with 22 additions and 15 deletions.
diff --git a/nsiqcppstyle_checker.py b/nsiqcppstyle_checker.py
@@ -362,7 +362,9 @@ def t_COMMENT(t):
     r"/\*(.|\n)*?\*/"
     t.lexer.lineno += t.value.count("\n")
     if Search(r"/\*\*\s", t.value):
-        t.additional = "DOXYGEN"
+        t.additional = "DOXYGEN_JAVADOC"
+    elif Search(r"/\*\!\s", t.value):
+        t.additional = "DOXYGEN_QT"
     return t
 
 
@@ -372,9 +374,9 @@ def t_COMMENT(t):
 def t_CPPCOMMENT(t):
     r"//.*"
     if Search(r"^///\b", t.value):
-        t.additional = "DOXYGEN"
+        t.additional = "DOXYGEN_CPP"
     if Search(r"^///<", t.value):
-        t.additional = "DOXYGENPOST"
+        t.additional = "DOXYGEN_POST"
 
     return t
 

diff --git a/rules/RULE_5_2_C_provide_doxygen_class_comment_on_class_def.py b/rules/RULE_5_2_C_provide_doxygen_class_comment_on_class_def.py
@@ -39,8 +39,9 @@ def RunRule(lexer, currentType, fullName, decl, contextStack, typeContext):
         lexer.PushTokenIndex()
         t3 = lexer.GetPrevTokenInTypeList(["LBRACE", "SEMI", "PREPROCESSOR"], False, True)
         lexer.PopTokenIndex()
-        if t2 is not None and t2.additional == "DOXYGEN" and (t3 is None or t2.lexpos > t3.lexpos):
-            return
+        if t2 is not None and (t3 is None or t2.lexpos > t3.lexpos):
+            if t2.additional in ["DOXYGEN_JAVADOC", "DOXYGEN_QT", "DOXYGEN_CPP"]:
+                return
         nsiqcppstyle_reporter.Error(
             t,
             __name__,
@@ -99,12 +100,12 @@ def test4(self):
         self.Analyze(
             "thisfile.c",
             """
-/**
+/*!
  *
  */
 class J {
     int k;
-    /**
+    /*!
      */
     class T {
     }

diff --git a/rules/RULE_5_2_C_provide_doxygen_namespace_comment_on_namespace_def.py b/rules/RULE_5_2_C_provide_doxygen_namespace_comment_on_namespace_def.py
@@ -41,8 +41,9 @@ def RunRule(lexer, currentType, fullName, decl, contextStack, typeContext):
         lexer.PushTokenIndex()
         t3 = lexer.GetPrevTokenInTypeList(["SEMI", "PREPROCESSOR", "LBRACE"], False, True)
         lexer.PopTokenIndex()
-        if t2 is not None and t2.additional == "DOXYGEN" and (t3 is None or t2.lexpos > t3.lexpos):
-            return
+        if t2 is not None and (t3 is None or t2.lexpos > t3.lexpos):
+            if t2.additional in ["DOXYGEN_JAVADOC", "DOXYGEN_QT", "DOXYGEN_CPP"]:
+                return
         nsiqcppstyle_reporter.Error(
             t,
             __name__,

diff --git a/rules/RULE_5_2_C_provide_doxygen_struct_comment_on_struct_def.py b/rules/RULE_5_2_C_provide_doxygen_struct_comment_on_struct_def.py
@@ -39,8 +39,9 @@ def RunRule(lexer, currentType, fullName, decl, contextStack, context):
         lexer.PushTokenIndex()
         t3 = lexer.GetPrevTokenInTypeList(["SEMI", "PREPROCESSOR", "LBRACE"], False, True)
         lexer.PopTokenIndex()
-        if t2 is not None and t2.additional == "DOXYGEN" and (t3 is None or t2.lexpos > t3.lexpos):
-            return
+        if t2 is not None and (t3 is None or t2.lexpos > t3.lexpos):
+            if t2.additional in ["DOXYGEN_JAVADOC", "DOXYGEN_QT", "DOXYGEN_CPP"]:
+                return
         nsiqcppstyle_reporter.Error(
             t,
             __name__,

diff --git a/rules/RULE_5_3_A_provide_doxygen_function_comment_on_function_in_header.py b/rules/RULE_5_3_A_provide_doxygen_function_comment_on_function_in_header.py
@@ -60,8 +60,9 @@ def RunRule(lexer, fullName, decl, contextStack, context):
         lexer.PushTokenIndex()
         t3 = lexer.GetPrevTokenInTypeList(["SEMI", "PREPROCESSOR"], False, True)
         lexer.PopTokenIndex()
-        if t2 is not None and t2.additional == "DOXYGEN" and (t3 is None or t2.lexpos > t3.lexpos):
-            return
+        if t2 is not None and (t3 is None or t2.lexpos > t3.lexpos):
+            if t2.additional in ["DOXYGEN_JAVADOC", "DOXYGEN_QT", "DOXYGEN_CPP"]:
+                return
         nsiqcppstyle_reporter.Error(
             t,
             __name__,

diff --git a/rules/RULE_5_3_A_provide_doxygen_function_comment_on_function_in_impl.py b/rules/RULE_5_3_A_provide_doxygen_function_comment_on_function_in_impl.py
@@ -78,8 +78,9 @@ def RunRule(lexer, fullName, decl, contextStack, context):
         lexer.PushTokenIndex()
         t3 = lexer.GetPrevTokenInTypeList(["SEMI", "PREPROCESSOR"], False, True)
         lexer.PopTokenIndex()
-        if t2 is not None and t2.additional == "DOXYGEN" and (t3 is None or t.lexpos > t3.lexpos):
-            return
+        if t2 is not None and (t3 is None or t.lexpos > t3.lexpos):
+            if t2.additional in ["DOXYGEN_JAVADOC", "DOXYGEN_QT", "DOXYGEN_CPP"]:
+                return
         nsiqcppstyle_reporter.Error(
             t,
             __name__,