warnings option

#feat

Author: alandefreitas

docs/mrdocs.schema.json

@@ -439,6 +439,16 @@
       ],
       "title": "Verbose output",
       "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.",
+      "enum": [
+        true,
+        false
+      ],
+      "title": "Enable warning messages",
+      "type": "boolean"
     }
   },
   "required": [],

src/lib/Lib/ConfigOptions.json

@@ -416,18 +416,9 @@
     ]
   },
   {
-    "category": "Miscellaneous",
-    "brief": "Miscellaneous options",
+    "category": "Warnings",
+    "brief": "Warnings and progress messages",
     "options": [
-      {
-        "name": "concurrency",
-        "command-line-only": true,
-        "brief": "Number of threads to use",
-        "details": "The desired level of concurrency: 0 for hardware-suggested.",
-        "type": "unsigned",
-        "default": 0,
-        "min-value": 0
-      },
       {
         "name": "verbose",
         "brief": "Verbose output",
@@ -460,6 +451,28 @@
         ],
         "default": "info"
       },
+      {
+        "name": "warnings",
+        "brief": "Enable warning messages",
+        "details": "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.",
+        "type": "bool",
+        "default": true
+      }
+    ]
+  },
+  {
+    "category": "Miscellaneous",
+    "brief": "Miscellaneous options",
+    "options": [
+      {
+        "name": "concurrency",
+        "command-line-only": true,
+        "brief": "Number of threads to use",
+        "details": "The desired level of concurrency: 0 for hardware-suggested.",
+        "type": "unsigned",
+        "default": 0,
+        "min-value": 0
+      },
       {
         "name": "ignore-map-errors",
         "brief": "Continue if files are not mapped correctly",

src/lib/Metadata/Finalizers/JavadocFinalizer.cpp

@@ -128,7 +128,7 @@ finalize(doc::Reference& ref)
         MRDOCS_ASSERT(current_context_);
         if (auto primaryLoc = getPrimaryLocation(*current_context_))
         {
-            report::warn(
+            warn(
                 "{}:{}\n{}: Failed to resolve reference to '{}'",
                 primaryLoc->FullPath,
                 primaryLoc->LineNumber,
@@ -284,7 +284,7 @@ copyBriefAndDetails(Javadoc& javadoc)
             MRDOCS_ASSERT(current_context_);
             if (auto primaryLoc = getPrimaryLocation(*current_context_))
             {
-                report::warn(
+                warn(
                     "{}:{}\n"
                     "{}: Failed to copy documentation from '{}'\n"
                     "    Note: Symbol '{}' not found.",
@@ -306,7 +306,7 @@ copyBriefAndDetails(Javadoc& javadoc)
         {
             auto ctxPrimaryLoc = getPrimaryLocation(*current_context_);
             auto resPrimaryLoc = getPrimaryLocation(*res);
-            report::warn(
+            warn(
                 "{}:{}\n"
                 "{}: Failed to copy documentation from '{}'.\n"
                 "No documentation available.\n"

src/lib/Metadata/Finalizers/JavadocFinalizer.hpp

@@ -159,6 +159,16 @@ class JavadocFinalizer
                 return corpus_.find(id) != nullptr;
             }));
     }
+
+    template<class... Args>
+    void
+    warn(
+        Located<std::string_view> format,
+        Args&&... args) const
+    {
+        MRDOCS_CHECK_OR(corpus_.config->warnings);
+        return log(report::Level::warn, format, std::forward<Args>(args)...);
+    }
 };
 
 } // clang::mrdocs

test-files/golden-tests/config/auto-brief/auto-brief.yml

@@ -1 +1,2 @@
-auto-brief: true
+auto-brief: true
+warnings: false

test-files/golden-tests/config/auto-brief/no-auto-brief.yml

@@ -1 +1,2 @@
-auto-brief: false
+auto-brief: false
+warnings: false

test-files/golden-tests/javadoc/ref/broken-ref.yml

@@ -0,0 +1 @@
+warnings: false