From fce8952ca87054abdb4cc07e853a789d1bbd5f4a Mon Sep 17 00:00:00 2001 From: Gennaro Prota Date: Fri, 3 Oct 2025 17:28:50 +0200 Subject: [PATCH] Add a requirements section to usage.adoc --- docs/modules/ROOT/pages/usage.adoc | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/modules/ROOT/pages/usage.adoc b/docs/modules/ROOT/pages/usage.adoc index 473aa42977..6e2d201974 100644 --- a/docs/modules/ROOT/pages/usage.adoc +++ b/docs/modules/ROOT/pages/usage.adoc @@ -195,6 +195,11 @@ compilation-database: ../CMakeLists.txt output: ../docs/reference ---- +== Requirements + +MrDocs requires input to be well-formed {cpp} code. If the input is ill-formed, MrDocs will attempt to emit at least one diagnostic. However, constructs classified +as "ill-formed, no diagnostic required" under the {cpp} standard may lead to undefined output. + == Extracting Documentation Unlike other documentation generators, MrDocs only works with valid {cpp} code.