diff options
author | Martin Smith <martin.smith@digia.com> | 2015-05-11 14:30:00 +0200 |
---|---|---|
committer | Martin Smith <martin.smith@digia.com> | 2015-05-28 11:52:48 +0000 |
commit | d8cd4b289f5907eb164139037d26390dd41e4e22 (patch) | |
tree | 7cbc98215a2d917cc3ea1283f5d130e0f8f49bcf /src/render/frontend/qlayer.cpp | |
parent | bc3e46b02f345d86010a154326dcce475dc1c25e (diff) |
Doc: Add Qt3D QML and C++ skeleton comments for qdoc
Add documentation structure and qdoc comments for \class,
\qmltype, \property, and \qmlproperty, etc, for the Qt3DRender
C++ and QML modules.
The actual documentation (descriptions) are still missing, but this
allows the QML type documentation to be generated and reduces the
qdoc error count.
Change-Id: I9e96241f07ca2388f1a8cc2a3677fa6d02a2404d
Task-number: QTBUG-46037
Reviewed-by: Martin Smith <martin.smith@digia.com>
Diffstat (limited to 'src/render/frontend/qlayer.cpp')
-rw-r--r-- | src/render/frontend/qlayer.cpp | 34 |
1 files changed, 34 insertions, 0 deletions
diff --git a/src/render/frontend/qlayer.cpp b/src/render/frontend/qlayer.cpp index f9e43d2be..afef8df3f 100644 --- a/src/render/frontend/qlayer.cpp +++ b/src/render/frontend/qlayer.cpp @@ -50,6 +50,26 @@ QLayerPrivate::QLayerPrivate() { } +/*! + \class QLayer + \inmodule Qt3DRender + \since 5.5 + \brief The QLayer class provides ... +*/ + +/*! + \qmltype Layer + \instantiates Qt3D::QLayer + \inherits Component3D + \inqmlmodule Qt3D.Render + \since 5.5 + \brief For ... +*/ + + +/*! \fn void Qt3D::QLayer::copy(const QNode *ref) + Copies the \a ref instance into this one. + */ void QLayer::copy(const QNode *ref) { QComponent::copy(ref); @@ -57,6 +77,10 @@ void QLayer::copy(const QNode *ref) d_func()->m_names = layer->d_func()->m_names; } +/*! \fn Qt3D::QLayer::QLayer(QObject *parent) + Constructs a new QLayer with the specified \a parent. + */ + QLayer::QLayer(QNode *parent) : QComponent(*new QLayerPrivate, parent) { @@ -68,6 +92,16 @@ QLayer::QLayer(QLayerPrivate &dd, QNode *parent) { } +/*! + \property Qt3D::QLayer::names + + */ + +/*! + \qmlproperty stringlist Qt3D.Render::Layer::names + +*/ + QStringList QLayer::names() const { Q_D(const QLayer); |