Skip to content

Commit 1ba337d

Browse files
committed
Add a requirements section to usage.adoc
1 parent 88954d7 commit 1ba337d

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

docs/modules/ROOT/pages/usage.adoc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -195,6 +195,11 @@ compilation-database: ../CMakeLists.txt
195195
output: ../docs/reference
196196
----
197197

198+
== Requirements
199+
200+
MrDocs requires input to be well-formed C++ code. If the input is ill-formed, MrDocs will attempt to emit at least one diagnostic. However, constructs classified
201+
as "ill-formed, no diagnostic required" under the C++ standard may lead to undefined output.
202+
198203
== Extracting Documentation
199204

200205
Unlike other documentation generators, MrDocs only works with valid {cpp} code.

0 commit comments

Comments
 (0)