warn-unnamed-param option

#feat

Author: alandefreitas

docs/mrdocs.schema.json

@@ -540,6 +540,16 @@
       "title": "Warn if parameters are not documented",
       "type": "boolean"
     },
+    "warn-unnamed-param": {
+      "default": false,
+      "description": "When set to `true`, MrDocs outputs a warning message if a documented function has a parameter that is not named.",
+      "enum": [
+        true,
+        false
+      ],
+      "title": "Warn if documented functions have unnamed parameters",
+      "type": "boolean"
+    },
     "warnings": {
       "default": true,
       "description": "When set to `true`, MrDocs outputs warning messages during the generation of the documentation. It is usually recommended to enable warnings while writing the documentation.",

src/lib/Lib/ConfigOptions.json

@@ -521,6 +521,13 @@
         "type": "bool",
         "default": true
       },
+      {
+        "name": "warn-unnamed-param",
+        "brief": "Warn if documented functions have unnamed parameters",
+        "details": "When set to `true`, MrDocs outputs a warning message if a documented function has a parameter that is not named.",
+        "type": "bool",
+        "default": false
+      },
       {
         "name": "warn-if-undoc-enum-val",
         "brief": "Warn if enum values are not documented",

src/lib/Metadata/Finalizers/JavadocFinalizer.cpp

@@ -648,6 +648,7 @@ emitWarnings()
     warnDocErrors();
     warnNoParamDocs();
     warnUndocEnumValues();
+    warnUnnamedParams();
 
     // Print to the console
     auto const level = !corpus_.config->warnAsError ? report::Level::warn : report::Level::error;
@@ -840,4 +841,53 @@ warnUndocEnumValues()
     }
 }
 
+void
+JavadocFinalizer::
+warnUnnamedParams()
+{
+    MRDOCS_CHECK_OR(corpus_.config->warnUnnamedParam);
+    for (auto const& I : corpus_.info_)
+    {
+        MRDOCS_CHECK_OR_CONTINUE(I->isFunction());
+        MRDOCS_CHECK_OR_CONTINUE(I->Extraction == ExtractionMode::Regular);
+        MRDOCS_CHECK_OR_CONTINUE(I->javadoc);
+        warnUnnamedParams(dynamic_cast<FunctionInfo const&>(*I));
+    }
+}
+
+void
+JavadocFinalizer::
+warnUnnamedParams(FunctionInfo const& I)
+{
+    auto orderSuffix = [](std::size_t const i) -> std::string
+    {
+        if (i == 0)
+        {
+            return "st";
+        }
+        if (i == 1)
+        {
+            return "nd";
+        }
+        if (i == 2)
+        {
+            return "rd";
+        }
+        return "th";
+    };
+
+    for (std::size_t i = 0; i < I.Params.size(); ++i)
+    {
+        if (I.Params[i].Name.empty())
+        {
+            this->warn(
+                *getPrimaryLocation(I),
+                "{}: {}{} parameter is unnamed",
+                corpus_.Corpus::qualifiedName(I),
+                i + 1,
+                orderSuffix(i));
+        }
+    }
+}
+
 } // clang::mrdocs

src/lib/Metadata/Finalizers/JavadocFinalizer.hpp

@@ -246,6 +246,12 @@ class JavadocFinalizer
 
     void
     warnUndocEnumValues();
+
+    void
+    warnUnnamedParams();
+
+    void
+    warnUnnamedParams(FunctionInfo const& I);
 };
 
 } // clang::mrdocs