warn-as-error option

#feat

Author: alandefreitas

docs/mrdocs.schema.json

@@ -450,6 +450,16 @@
       "title": "Verbose output",
       "type": "boolean"
     },
+    "warn-as-error": {
+      "default": false,
+      "description": "When set to `true`, MrDocs treats warnings as errors and stops the generation of the documentation.",
+      "enum": [
+        true,
+        false
+      ],
+      "title": "Treat warnings as errors",
+      "type": "boolean"
+    },
     "warn-broken-ref": {
       "default": true,
       "description": "When set to `true`, MrDocs outputs a warning message if a reference in the documentation is broken.",

src/lib/Lib/ConfigOptions.json

@@ -513,6 +513,13 @@
         "details": "When set to `true`, MrDocs outputs a warning message if a reference in the documentation is broken.",
         "type": "bool",
         "default": true
+      },
+      {
+        "name": "warn-as-error",
+        "brief": "Treat warnings as errors",
+        "details": "When set to `true`, MrDocs treats warnings as errors and stops the generation of the documentation.",
+        "type": "bool",
+        "default": false
       }
     ]
   },

src/lib/Metadata/Finalizers/JavadocFinalizer.hpp

@@ -170,7 +170,8 @@ class JavadocFinalizer
         Args&&... args) const
     {
         MRDOCS_CHECK_OR(corpus_.config->warnings);
-        return log(report::Level::warn, format, std::forward<Args>(args)...);
+        auto const level = !corpus_.config->warnAsError ? report::Level::warn : report::Level::error;
+        return log(level, format, std::forward<Args>(args)...);
     }
 
     void