c++qtdocumentationdoxygennokia

Documentation for Qt documentation comments? Qt + Doxygen?

Where can I find documentation for Qt documentation comments? I'm referring to how Qt uses a specific style for documentation comments, like so:

/*!
    \class MyClassName
    \brief The MyClassName class is used as an example on Stack Overflow.

    This class serves a few functions, the most important being:

    \list
        \i So people can understand my question.
        \i So people can have a few laughs at the comedy in my example.
    \endlist
 */

...you get the picture. So where can I find information about all the switches, like \class, \list, \brief, etc. Also, what tool(s) do I use to generate documentation files from these comments in my source files? Does Doxygen support this syntax?

Solution

  • Don't use qdoc. It is deprecated. Use Doxygen, which is based on qdoc anyway.

    That said, the documentation (in qdoc format :-D ) is here.