I am trying to add examples to python code.
Where do I have to put the @example filename
, so that it shows in the class/module/package help, at the moment I just get an example list but no links form the classdocs to the examples.
I tried putting the @example
in the class doc (I use doxypy to allow tags in docstrings), after the class, and just below teh top comment in the file after the @package
.
While this is a pressing issue, there is another question, can I make doxygen simply parse all examples from the examplefolder and create auto links between the classes and the examples without adding tags?
I have the following structure: projectcode/aTreeOfPackagesAndModules
and examples/aTreeOfPackagesAndModules
. The trees have axactly the same layout and the example files for each package have the exact same path/filename except of projectcode
/ examples
dirs beeing exchanged. can I get arround adding example tags?