Documentation for Qt documentation comments? Qt + Doxygen?

Question

Where can I find documentation for Qt documentation comments? I mean, how Qt uses a certain style for documentation comments, for example:

/*!
    \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, such as \ class, \ list, \ brief, etc. Also, what tools do I use to create documentation files from these comments in my source files? Does Doxygen support this syntax?

Answer 1

Do not use qdoc. He is out of date . Use Doxygen, which is anyway based on qdoc.

, ( qdoc:-D) .

Answer 2

Doxygen

- ( HTML) / (LaTeX) . RTF (MS-Word), PostScript, PDF, HTML Unix. , .

doxygen . , . , , .

http://www.stack.nl/~dimitri/doxygen/

Answer 3

doxygen, qt: Qt QT_AUTOBRIEF Doxyfile. doxygen, QT. Doxygen, QT, Doxygen. Doxygen.

, , QT, , d-, ?

Qt: The /*! text */ /*! text */ comment "Qt Style" doxygen. ! Doxygen. , doxygen.

QT_AUTOBRIEF: "QT_AUTOBRIEF" Doxyfile TRUE, Qt \ .

doygen:

QT_AUTOBRIEF YES, doxygen ( ) Qt . NO, , Qt ( , \).

Answer 4

You can take a look at the Qt source code for Qt documentation comments ...

Qt - SRC - 4.6.3

I used DOxygen for documentation, and it works fine for me, although the documentation standards are not related to Qt. I suggest you try and decide.