warn-if-undoc-enum-val option

#feat

Author: alandefreitas

docs/mrdocs.schema.json

@@ -460,6 +460,16 @@
       "title": "Warn if documentation has errors",
       "type": "boolean"
     },
+    "warn-if-undoc-enum-val": {
+      "default": true,
+      "description": "When set to `true`, MrDocs outputs a warning message if an enum value is not documented.",
+      "enum": [
+        true,
+        false
+      ],
+      "title": "Warn if enum values are not documented",
+      "type": "boolean"
+    },
     "warn-if-undocumented": {
       "default": true,
       "description": "When set to `true`, MrDocs outputs a warning message if a symbol that passes all filters is not documented.",

src/lib/Lib/ConfigOptions.json

@@ -499,6 +499,13 @@
         "details": "When set to `true`, MrDocs outputs a warning message if a named function parameter is not documented.",
         "type": "bool",
         "default": true
+      },
+      {
+        "name": "warn-if-undoc-enum-val",
+        "brief": "Warn if enum values are not documented",
+        "details": "When set to `true`, MrDocs outputs a warning message if an enum value is not documented.",
+        "type": "bool",
+        "default": true
       }
     ]
   },

src/lib/Metadata/Finalizers/JavadocFinalizer.cpp

@@ -517,6 +517,7 @@ emitWarnings() const
     warnUndocumented();
     warnDocErrors();
     warnNoParamDocs();
+    warnUndocEnumValues();
 }
 
 void
@@ -683,5 +684,24 @@ warnNoParamDocs(FunctionInfo const& I) const
     }
 }
 
+void
+JavadocFinalizer::
+warnUndocEnumValues() const
+{
+    MRDOCS_CHECK_OR(corpus_.config->warnIfUndocEnumVal);
+    for (auto const& I : corpus_.info_)
+    {
+        MRDOCS_CHECK_OR_CONTINUE(I->isEnumConstant());
+        MRDOCS_CHECK_OR_CONTINUE(I->Extraction == ExtractionMode::Regular);
+        MRDOCS_CHECK_OR_CONTINUE(!I->javadoc);
+        auto primaryLoc = getPrimaryLocation(*I);
+        warn(
+            "{}:{}\n"
+            "{}: Missing documentation for enum value",
+            primaryLoc->FullPath,
+            primaryLoc->LineNumber,
+            corpus_.Corpus::qualifiedName(*I));
+    }
+}
 
 } // clang::mrdocs

src/lib/Metadata/Finalizers/JavadocFinalizer.hpp

@@ -187,6 +187,9 @@ class JavadocFinalizer
 
     void
     warnNoParamDocs(FunctionInfo const& I) const;
+
+    void
+    warnUndocEnumValues() const;
 };
 
 } // clang::mrdocs

test-files/golden-tests/metadata/enum.yml

@@ -0,0 +1 @@
+warn-if-undoc-enum-val: false