#Doxygen makefile example how to#

For me, using Doxygen 1.7.3, the root file for the latex build seems to be 'refman.tex'. The compiler includes all files as desired, as they are all contained in the project defintion. Patel is right - you need to run Doxygen, then Latex of some sort to create the single doc. What to do about this?ītw - the 'usecase' is simple: It's a visual studio project. makefile 74 makefile dependencies 76 MCI functionalities 381 module. It seems my question is related to this, however the only promising answer is the comment by saying it was an issue that has been fixed in doxygen version 1.7.4. Adding Doxygen markup to a file (informally called doxygenating) is very simple. You must edit example/Makefile to reflect your make.inc, or use pkg-config, as described in example/README.txt. example file header with Doxygen comments 51 function with Doxygen. The output XML of Doxygen for ExampleType (file: xml/struct_example_type.xml) is: įloat ExampleType::arrayĪctually, I would expect ARRAY_LENGTH to be replaced by (20u) and optional_char should not be a member of the struct. My changes with regard to the default Doxygen configuration file (using Doxygen 1.8.2) are: INPUT =. This is the listing of example_include.h: #define MY_FALSE (0u) Doxygen supports various styles of formatting your comments.

In this section we look at the contents of the comment block itself.

#Doxygen makefile example how to#

This is the listing of example.h: #include 'example_include.h' The previous section focused on how to make the comments in your code known to doxygen, it explained the difference between a brief and a detailed description, and the use of structural commands. I made up an example consisting of two headers and a Doxygen file: subdir/example.h I do not get the doxygen preprocessor to recursively include files.