file inclusion question

[fnrizzi]

Hi! I am using the m.css and I have the following issue: i have a mardown document that I compile with the ./doxygen and I would like to include in my markdown file some code from a .cpp file. I could copy and past the code, but that is redundant and I have to redo it everytime the cpp file changes.

I was wondering if the file inclusion explained here: https://mcss.mosra.cz/plugins/math-and-code/#advanced-file-inclusion is also available for doxygen/markdown? If not, is there a way i can mix rst code and markdown to obtain that capability?

Or do you have any other suggestion to solver my problem? Thanks!

[mosra]

(Sorry for embarrassingly late replies, finally got a chance to get back to this project.)

This is achievable using vanilla Doxygen functionality -- please see the @snippet, @include, @skip, @until and @skipline builtin commands. Especially the @snippet command is very powerful, allowing you to include exact delimited pieces of code, while still keeping the code itself compilable.

For an overwhelming exhaustive usage example, here's what I do in Magnum:

• C++ snippet code delimited with comments -- note that this code is compiled as part of my test suite to ensure the syntax is alright and up-to-date, the DOXYGEN_ELLIPSIS() is for the compiler just a pass-through #define DOXYGEN_ELLIPSIS(...) __VA_ARGS__ but in the output it gets replaced with just … to hide unnecessary complexity
• A docblock referencing this snippet
• A Doxyfile EXAMPLE_PATH option to point to where the snippets are
• A snippet pre-processing hook that turns the DOXYGEN_ELLIPSIS() macro into a literal ellipsis
• The resulting generated documentation