CODEWITHSUNDEEP
c++qtcomments
egor7
egor7

Reputation: 4950

QT special comments //: //[num] etc

What means this special comments in qt examples folder?

I know about "//:" this is a comment than would be taken to a translation program if the next line contains tr("").

The code between //[] seems to be taken to the generated html documentation.

Is there a document with full description of special comments?

Upvotes: 4

Views: 746

Answers (2)

jwernerny
jwernerny

Reputation: 7048

Qt uses Doxygen Special Commands in it's code comments. [Okay, to be correct, Doxygen extends Qt's comment special commands.] The special commands are used to control the generation of the documentation when it is run on the code. The Trolls who maintain Qt have their own tool they use to generate documents from the code. Doxygen was written to give us mere mortals a tool we could use.

One of the things you can do with Doxygen (and I assume Qt's tool) is include example code in the documentation. Often, only part of the code is needed, so there are some special commands that can be used to control what portion of the file is displayed (e.g. \line). They rely on finding markers in the code. IMHO, the // [xx] are simply those markers.

Upvotes: 5

spraff
spraff

Reputation: 33445

This is the document for translation comments, no mention of //[num] though....

Upvotes: 1

Related Questions