Re: [Doxygen-users] Can doxygen do this (including not only examples, but also their output )?
Brought to you by:
dimitri
From: Stephan P. <ste...@gm...> - 2014-05-20 07:42:11
|
Hi Peter, > We[1] use a combination of doxygen (for API) and Sphinx[2] for more > expository docs, such as tutorial and manual. thanks for pointing out Sphinx, I had not heard of it until now. > In particular, it's > straightforward Sphinx to integrate portions of an example program > along with the output. Sphinx uses make to generate the > documentation, so it's also straightforward to build and run the > example code as part of building the documentation. Sounds good. When you make changes to example programs which changes their output, then rerun your make-based documentation creation process, is the changed output automatically reflected in the docs? The way I do it in my old Yodl-based documentation is that an example program has for instance the line printf("###include###\n"); at the position where a chunk of output should be displayed. A Perl script would then take the source code and the program's output and replace the printf("###include###\n") lines with the chunks of output. Is your Sphinx-based system similar? I'm just trying get a head start on understanding which features of Sphinx I need to look at to judge how this could be done. Thanks and all the best, Stephan |