c++ - //![0] en código fuente Qt

comments qdoc

Question

¿Cuál es el significado de la //! [n] //! [n] ( n = 0, 1, 2 ...) ¿marcado en las fuentes C ++ / QML en los proyectos de ejemplo de Qt?

Por ejemplo:

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

A pesar del error común, esta es una sintaxis qdoc , no doxygen. Este comentario es para fines de documentación en el Proyecto Qt para marcar fragmentos de ejemplo que se van a representar. Realmente no está bien documentado, pero here puede encontrar el código correspondiente que implementa esta función.

Como usuario final de Qt, no necesita lidiar con él demasiado a menos que comience a contribuir al Proyecto Qt en sí mismo o intente reutilizar qdoc para su propio proyecto, lo que sería ciertamente extraño en este punto.