Skip to content

Add a requirements section to usage.adoc #1049

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from
+5 −0
Open

Add a requirements section to usage.adoc #1049

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions docs/modules/ROOT/pages/usage.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Loading