[Qt-interest] Qt's include class style in doxygen documentation

Antonio L. Rodriguez nefarita at gmail.com
Mon May 11 14:01:40 CEST 2009


Hello:

I'm trying to document a Qt project using Doxygen. I like the way Qt
includes class headers, by specifying only its name in the include
directive:

    #include <QList>

instead of

    #include <qlist.h>

This is done by creating a file named as the class, containing the
corresponding include directive for the class header file. Doxygen
seems to deal badly with this kind of header including. I tried to
specify the include file name in the @class directive:

   /*!
   @class MyClass MyClass MyClass
   ...
   */
   class MyClass { ... }

But this does not seem to work correctly. Doxygen does not recognize
the include class file name, and hides the example code to include it,
in the class documentation briefing. If I leave it empty:

   /*!
   @class MyClass
   ...
   */
   class MyClass { ... }

Doxygen displays the include directive with the name of the file
containing the header specification for the class (qlist,h).

Qt documentation seems to be written in Doxygen, and they manage to
work around this problem correctly. Anyone knows how?

Thanks in advance, Antonio.



More information about the Qt-interest-old mailing list