//! [0] in Qt source code

Question

What is the meaning of the //! [n] (n = 0, 1, 2 ...) markup in the C++/QML sources in the Qt sample projects?

For example:

//! [0]
GLWidget::GLWidget(Helper *helper, QWidget *parent)
    : QGLWidget(QGLFormat(QGL::SampleBuffers), parent), helper(helper)
{
    elapsed = 0;
    setFixedSize(840, 400);
    setAutoFillBackground(false);
}
//! [0]

//! [1]
void GLWidget::animate()
{
    elapsed = (elapsed + qobject_cast<QTimer*>(sender())->interval()) % 1000;
    repaint();
}
//! [1]

//! [2]
void GLWidget::paintEvent(QPaintEvent *event)
{
    QPainter painter;
    painter.begin(this);
    painter.setRenderHint(QPainter::Antialiasing);
    helper->paint(&painter, event, elapsed);
    painter.end();
}
//! [2]

they are just comments.

billz
– billz

2013-07-07 01:06:19 +00:00
Commented Jul 7, 2013 at 1:06 — billz
– billz, Commented Jul 7, 2013 at 1:06
Documentation purposes most likely.

Qaz
– Qaz

2013-07-07 01:14:51 +00:00
Commented Jul 7, 2013 at 1:14 — Qaz
– Qaz, Commented Jul 7, 2013 at 1:14

Kuba hasn't forgotten Monica · Accepted Answer · 2019-07-08 17:30:22Z

31

Despite the common misconception, this is qdoc syntax, not doxygen. This comment is for documentation purposes in the Qt Project to mark example snippets to be rendered so. See the documentation and the corresponding code that implements this feature.

As an end user of Qt, you do not need to deal with it too much unless you start contributing to the Qt Project itself or you are trying to reuse qdoc for your own project, which would be admittedly odd at this point.

edited Jul 8, 2019 at 17:30

Kuba hasn't forgotten Monica

99.1k17 gold badges168 silver badges333 bronze badges

answered Oct 13, 2014 at 21:57

László Papp

53.5k40 gold badges118 silver badges142 bronze badges

Sign up to request clarification or add additional context in comments.

Collectives™ on Stack Overflow

//! [0] in Qt source code

1 Answer 1

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related