Radium-Engine icon indicating copy to clipboard operation
Radium-Engine copied to clipboard

Add support for cmake snippets in documentation

Open nmellado opened this issue 4 years ago • 3 comments

See details and link here: https://github.com/STORM-IRIT/Radium-Engine/pull/591#discussion_r459696611

nmellado avatar Jul 23 '20 20:07 nmellado

For quicker access, here is the link : http://jesnault.fr/website/document-your-cmake-code-within-doxygen/

MathiasPaulin avatar Jul 23 '20 20:07 MathiasPaulin

This issue has been automatically marked as stale because it has not had recent activity. It will be closed in 14 days if no further activity occurs. Thank you for your contributions.

stale[bot] avatar Oct 22 '20 02:10 stale[bot]

Another option is to use the \dontinclude command (https://doxygen.nl/manual/commands.html#cmddontinclude)

The main limitation I have observed is that files with the same name will not be parsed (only the first one is retained, depending on the ordering of doxygen variable EXAMPLE_PATH). As such, I don't know how to document any other file CMakeLists.txt than the main one (if the project root is the first one included), but this will work for all the other cmake files we have in the project, e.g. RadiumSetupFunctions.cmake.

nmellado avatar Sep 05 '22 10:09 nmellado