Menu
How can I force Doxygen to show full include path?
What do I mean:
I have a class foo::bar::bee defined in bee.hpp in following directory structure:
foo
foo/bar
foo/bar/bee.hpp
Doxygen, when it documents foo::bar::bee class tells that you need to include <bee.hpp>, but for my software I need <foo/bar/bee.hpp>
How can I cause Doxygen to do this? Is there any option to provide "Include flags" like "-I" so doxygen would know where the base is?
Notes:
FULL_PATH_NAMES is already set to default YES
Thanks.
Answer
Set:
STRIP_FROM_INC_PATH = relative/path/to/include/directory
767
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.
Putting the command @brief will generate a short description of the function when you generate the doxygen documentation. That short description can be extended if you want. Follow this answer to receive notifications.
Then, you simply run Doxygen, which generates an html folder. Now you go to that folder and click on the index. html file. The documentation for your code is now in an easy to read html file.
To add content to the mainpage, use the doxygen special command \mainpage.
Taken directly from the hints in DoxyWizard:
STRIP_FROM_INC_PATH
The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the path mentioned in the documentation of a class, which tells the reader which header file to include in order to use a class. If left blank only the name of the header file containing the class definition is used. Otherwise one should specify the include paths that are normally passed to the compiler using the -I flag.
110
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
