Ignoring files in project folder for Doxygen
You can use the EXCLUDE_PATTERNS tag in the configuration file: EXCLUDE_PATTERNS = */test/* Taken from here.
doxygen
Difference between param[out] and return in doxygen?
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
how to change default font size for graphviz?
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
Custom tags with Doxygen
The generalization of \bug and \todo is \xrefitem. The solution I suggest is: in Doxyfile: ALIASES += “req=\xrefitem req \”Requirement\” \”Requirements\” ” in documented code: /// \req #42 – The system shall work in any situation
Doxygen \cite producing empty bibliography
I was facing the same problem. There is an perl dependency to generate citation. So you must have both perl and bibtex in the system path. Ignore the example above, that only applies to Latex, for doxygen use (Note: no braces): \cite Hale The .bib file has to be located in doxygen working directory. Bibliographic … Read more
How to include custom files in Doxygen
I having been searching quite a lot before I found the answer, so I thought it would be nice to share! According to this Doxygen gotchas article I finally found that: you need to add a file with the dox extension. Its content should contain C-style comment blocks: /*! \page My test page contents … … Read more
Excluding directories for Doxygen
Note that the wildcards are matched against the file with absolute path So, just use absolute paths for your exclusions 😉 PS: BTW, I have struggled too many times with that. This small mention on the doxyfile’s comment seems to go unnoticed too often. Oops, I missed the detail that you had already tried that. … Read more
Objective-C Documentation Generators: HeaderDoc vs. Doxygen vs. AppleDoc
As the creator and lead developer of doxygen, let me also provide my perspective (obviously biased as well 😉 If you are looking for a 100% faithful replica of Apple’s own documentation style, then AppleDoc is a better choice in that respect. With doxygen you’ll have a hard time to get that exact same look, … Read more
What’s the right way to reference a parameter in Doxygen?
Doxygen provides the command \p for indicating that the next word is a parameter to the function. You would use it like so: … the \p x and \p y coordinates are used to … I believe by default this will be represented using a typewriter font. I don’t think this currently provides any auto-linking … Read more
How to make an introduction page with Doxygen
Have a look at the mainpage command. Also, have a look this answer to another thread: How to include custom files in Doxygen. It states that there are three extensions which doxygen classes as additional documentation files: .dox, .txt and .doc. Files with these extensions do not appear in the file index but can be … Read more