//! [0] в исходном коде Qt

Question

В чем смысл //! [n] (n = 0, 1, 2...) разметка в источниках C++/QML в примерах проектов Qt?

Например:

//! [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]

Answer 1

Несмотря на распространенное заблуждение, это синтаксис qdoc, а не doxygen. Этот комментарий предназначен для документирования в Qt Project, чтобы пометить примеры фрагментов, которые будут отображаться таким образом. Это не очень хорошо документировано, но здесь вы можете найти соответствующий код, который реализует эту функцию.

Как конечному пользователю Qt, вам не нужно слишком много заниматься этим, если вы не начнете вносить свой вклад в сам проект Qt или не попытаетесь повторно использовать qdoc для своего собственного проекта, что на данный момент было бы странно.