Yes, it is possible. The Doxygen documentation says: To document global objects (functions, typedefs, enum, macros, etc), you must document the file in which they are defined. In other words, there must at least be a /*! \file */ or a /** @file */ line in this file. You can use @defgroup, @addtogroup, and @ingroup … Read more
Out parameters are different from return values. Take this example in C: /** * \param[in] val Value calculations are based off. * \param[out] variable Function output is written to this variable. * * \return Nothing */ void modify_value(int val, int *variable) { val *= 5; int working = val % 44; *variable = working; } … Read more
As per Doxygen 1.8.7 there are three ways to do this: Use a standard markdown hyperlink as described in your original question. Use a @ref and prefix the target with md_ along with any subdirectories. Name the page and use @ref to refer to the name. The first method is straightforward and this will also … Read more
Here’s a comprehensive guide detailing how you can use Doxygen to create full inheritance diagrams that cross-reference multiple projects. This is made possible by leveraging Doxygen’s tag files. Steps in Detail Generate Doxygen Tag Files for Each Project: Tag files are a kind of metadata that Doxygen uses to create links between different sets of … Read more
Yes… you can.. Here is a ready-made “Snippet” you can drag or auto-complete, etc… /** * <#summary#> * @param <#name#> <#how you gonna get it?#> * @param <#name#> <#really, there’s more?#> * @return <#name#> <#what do you want!#> */ Drag that “onto” the snippet “thing” and like, you know.. set it up.. and there ya … Read more
Fontsize is a graph attribute (as well as an edge and node attribute). Doxygen generates a dot file, so, e.g.,: strict digraph { graph [ bgcolor=lightgray, resolution=128, fontname=Arial, fontcolor=blue, fontsize=12 ]; node [ fontname=Arial, fontcolor=blue, fontsize=11]; edge [ fontname=Helvetica, fontcolor=red, fontsize=10 ]; } Specific settings will override generic ones; hence setting fontsize as a node … Read more
Fundamentally, what you ask is impossible in virtually every real-world situation. There are two parts to documenting thrown exceptions. 1) The easy bit. Document the exceptions that are directly thrown in your method. You can do this by hand, but it’s pretty laborious and if you fail to keep the docs in sync wiht the … Read more
Look at the answer for question 17 in the FAQ: http://www.doxygen.nl/manual/faq.html#faq_cmdline, repeated below for convenience: Can I configure doxygen from the command line? Not via command line options, but doxygen can read from stdin, so you can pipe things through it. Here’s an example how to override an option in a configuration file from the … Read more
You don’t need and should not write the name of the file in the @file directive, doxygen reads the name of the file automatically. The problem with writing the name of the file is that when you rename the file you will have to change the @file directive as well. Providing @author and @date information … Read more
Sphinx cannot extract documentation from C++ sources in and by itself. However, there are extensions, most notably Breathe, which utilize Doxygen to extract documentation from C++. I’ve not tested any of these.