search

cppalliance / mrdocs

MrDocs: A Clang/LLVM tool for building reference documentation from C++ code and javadoc comments.
https://mrdocs.com
Other
75 stars 16 forks source link

Support describing concepts in source-to-asciidoc transfomation #675

Open akrzemi1 opened 1 day ago

akrzemi1 commented 1 day ago

My current documentation (which I create manually) provides the definition of the concept, and then, for every constraint, a description is provided: https://github.com/akrzemi1/markable/blob/master/documentation/reference.adoc#concept-mark_policy

Does something like this works, or could be made to work, in mrdocs?

alandefreitas commented 1 day ago

Yes. We already extract the concepts (https://github.com/cppalliance/mrdocs/blob/develop/include/mrdocs/Metadata/Concept.hpp) and the XML generator already includes this information (https://github.com/cppalliance/mrdocs/blob/develop/test-files/golden-tests/concept.cpp / https://github.com/cppalliance/mrdocs/blob/develop/test-files/golden-tests/concept.xml). But that's recent work, so there's no asciidoc template yet.