Special Comments QT //: // [num], etc.

Question

What does this special comment mean in the qt examples folder?

I know about "//:", this is a comment that will be transferred to the translation program if the next line contains tr ("").

The code between // [] is represented in the generated html-documentation.

Is there a document with a full description of special comments?

Answer 1

Qt uses Doxygen Special Commands in it code comments. [Well, to be precise, Doxygen extends the Qt special comment commands.] Special commands are used to control the creation of documentation when it is executed in code. Trolls that have Qt have their own tool, which they use to create documents from code. Doxygen was written to give us a mere mortal tool that we could use.

One of the things you can do with Doxygen (and I assume the Qt tool) includes example code in the documentation. Often only a part of the code is required, so there are some special commands that can be used to control which part of the file is displayed (for example, \line ). They rely on finding markers in code. IMHO, // [xx] - these are just these markers.

Answer 2

This is a commentary document for translation , without mentioning //[num] though ....