Finally took an afternoon to learn doxygen and have been commenting up the latest project for the past 24 or so hours.
Doxygen is easy to get up to speed with, but there are a couple of gotchas that aren't made clear in the documentation. These are listed below in no particular order.
Standalone pages
This is the first thing one notices when mucking about with doxygen: how can the index.html (aka "Main Page") be modified?
The answer is just as quick to find: create a document with a \mainpage tag. But what document? Surely adding a header file just to create doxygen tags is a bit silly?
Indeed. Instead, create a directory (e.g. doc) and use it for standalone doxygen files. A standalone file is basically a text file consisting of only the C++ comment, e.g.:
/*!
\mainpage The Main Page
\section sec_1 Section 1
...section 1 stuff...
\section sec_2 Section 2
... section 2 stuff...
<HR>
<b>\ref todo%lt;/b>
*/
Name this something like 'main.dox', and add the .dox extension to the FILE_PATTERNS definition in the project Doxyfile:
FILE_PATTERNS += *.dox
These standalone doxygen files are incredibly useful for stuff like installation instructions, HowTos, and FAQs.
They are also useful for defining groups. A file groups.dox can contain group definitions like the following:
/*!
\defgroup outer_group "Outer Group"
This module contains outer-group stuff.
\defgroup inner_group "Inner Group"
\ingroup outer_group
These things are in a group in a group.
*/
This provides a single, easy-to-maintain place for group definitions, so that header files and such just have to use "\ingroup". It seems like pretty good practice to put most files and classes in groups -- it makes for more expedient browsing.
Global namespace
Ok, there's a nice 'Namespaces' folder in the tree pane, and what does it contain? The project namespace. What about all those singletons ill-advisably implemented as globals (purely for narrative effect)?
Turns out there is no way to list the global namespace. This seems like a huge oversight -- if there's one thing you want to know about a project, it's how many lame globals the developers used.
Adding a 'globals' page seems like a good way to circumvent it, except for one slight problem -- if you create a standalone doc with "\page globals Global Namespace" in it, doxygen creates a page in the tree called "Global Namespace" ... with its own internal(?) version of the global namespace in it. This means, basically, that globals defined in your project are not there -- it only contains stuff like (for example) qRegisterMetaType invocations. It looks like 'globals' is an undocumented, and not particularly working, doxygen 'special command'.
A workaround is to use xrefitems. Add a line like the following to doxygen (remember, 'globals" is not an allowed name):
ALIASES += "globalfn=\xrefitem global \"Functions\" \"Globals\""
Now, use code like the following to document your global function:
/*! \fn void GlobalSingletonFactoryMess( bool suck_less )
\globalfn void GlobalSingletonFactoryMess( bool suck_less )
\param suck_less : Make singletons suck less
*/
void GlobalSingletonFactoryMess( bool );
A page called 'Globals' will appear under 'Related Pages', and will contain the function prototype, with a link to its documentation in the appropriate .h file. Of course, it's called a 'Member', but one can't have everything.
Xrefitems
Speaking of xrefitems, see that second argument in the ALIASES line above? The one that's set to "Functions", and is supposedly the header for the section that contains the xref items?
Yeh, that argument does nothing. Doxygen ignores it. Go on, try it. Set it to "Doxygen, please format my hard drive". Or have it make fun of your boss or users. It makes no difference. That text will never appear.
Multiple namespaces in header files
This one is just plain wacky. Or rather, it's just plain lazy. Of the doxygen parser.
Let's say you have a header file where you declare an interface and an abstract base class implementing that interface (never mind why, it's an example):
namespace Mine {
class MyInterface {
public:
virtual ~MyInterface() {}
virtual void doStuff() = 0;
};
} /* close namespace */
/* interface must be registered in gobal namespace */
Q_DECLARE_INTERFACE( Mine::MyInterface, "com.me.Mine.MyInterface/1.0");
namespace Mine {
class MyClass : public QObject, public MyInterface {
Q_OBJECT
Q_INTERFACES(Mine::MyInterface)
public:
MyClass( QObject *parent=0 );
virtual void doStuff();
};
}
Guess what happens? MyClass never appears in the documentation. The second namespace block leaves the doxygen parsers as befuddled as ... your favorite befuddlement simile.
The solution of course is to put the interface class in its own header file, which is no big deal ... but really, you shouldn't *have* to.
Random \example tag links
OK, there's an example in docs/examples/, that dir is safely added to the Doxyfile EXAMPLE_PATH, and the file shows up where it's supposed to in the doc tree under Examples.
Looking at the class for which it is an example, though, you see nothing -- or maybe it gets linked to a few rather arbitrary methods, or to methods outside of the class altogether.
What's going on?
Well, it turns out that doxygen decides to out-clever you, and only put a link to the example file in elements that appear in the example. Thus, if your class never directly appears as a type in the file (e.g.
'PluginManager::plugin("MyPlugin").status()' appears instead of
'Plugin p(PluginManager::plugin("MyPlugin"); p.status()'), then the documentation for your class will not be linked to the example, no matter how close to the \class tag you put the \example tag. Doxy knows best, eh? Surely you have no idea where you want your examples linked from.
The fix is to rewrite the example so that the class/function/whatever appears clearly and distinctly.