Menu
I am using doxygen to document my code. I found I can easily find all the classes since there is a tab calles "classes". But I cannot get all the free functions listed together. I have to go to the tab "files" to look for them. Can I put all free functions together in doxygen documentation?
810
How can I make doxygen ignore some code fragment? The new and easiest way is to add one comment block with a \cond command at the start and one comment block with a \endcond command at the end of the piece of code that should be ignored. This should be within the same file of course.
You can put example source code in a special path defined in the doxygen config under EXAMPLE_PATH , and then insert examples with the @example tag. Doxygen will then generate an extra page containing the source of the example. It will also set a link to it from the class documentation containing the example tag.
Doxygen will put members into the group whose definition has the highest "priority": e.g. An explicit \ingroup overrides an implicit grouping definition via @{ @} . Conflicting grouping definitions with the same priority trigger a warning, unless one definition was for a member without any explicit documentation.
There is a method to group items in pages and the method involve some comment writing from your side. There is not yet available an automated way to group free functions together. Still using the grouping option, you can place all items you want into a given page in documentation. More about this and some examples at the Doxygen page: Doxygen/manual/grouping
53
If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!
Donate Us With
