diff options
author | Tomi Korpipää <tomi.korpipaa@theqtcompany.com> | 2016-01-19 09:30:18 +0200 |
---|---|---|
committer | Pasi Keränen <pasi.keranen@theqtcompany.com> | 2016-01-19 10:51:18 +0000 |
commit | 4aeadb92130ce650bf5f137071d7777783eaa0e8 (patch) | |
tree | 55838592f049a5dfd778f09b2a0cc4c5c950d3d2 | |
parent | e2b88264cc623202362bf6221aaa6717c0a57494 (diff) |
Fixed some documentation warnings
Change-Id: I5055043641a1916dde47ad614d8ab7a5788fd93b
Task-number: QTBUG-46037
Reviewed-by: Miikka Heikkinen <miikka.heikkinen@theqtcompany.com>
Reviewed-by: Pasi Keränen <pasi.keranen@theqtcompany.com>
-rw-r--r-- | src/doc/qt3d.qdocconf | 6 | ||||
-rw-r--r-- | src/doc/src/qt3d-index.qdoc | 4 | ||||
-rw-r--r-- | src/doc/src/qt3d-overview.qdoc | 4 | ||||
-rw-r--r-- | src/doc/src/qt3drender-module.qdoc | 2 | ||||
-rw-r--r-- | src/quick3d/quick3d/items/quick3dnodeinstantiator.cpp | 4 | ||||
-rw-r--r-- | src/quick3d/quick3d/qquaternionanimation.cpp | 2 | ||||
-rw-r--r-- | src/render/defaults/qphongalphamaterial.cpp | 9 | ||||
-rw-r--r-- | src/render/geometry/qabstractbuffer.cpp | 2 | ||||
-rw-r--r-- | src/render/lights/qlight.cpp | 2 |
9 files changed, 16 insertions, 19 deletions
diff --git a/src/doc/qt3d.qdocconf b/src/doc/qt3d.qdocconf index 72f4060a7..d36c1d280 100644 --- a/src/doc/qt3d.qdocconf +++ b/src/doc/qt3d.qdocconf @@ -6,6 +6,12 @@ version = $QT_VERSION examplesinstallpath = qt3d/qt3d +indexes += $QT_INSTALL_DOCS/qtcore/qtcore.index \ + $QT_INSTALL_DOCS/qtgui/qtgui.index \ + $QT_INSTALL_DOCS/qtqml/qtqml.index \ + $QT_INSTALL_DOCS/qtquick/qtquick.index \ + $QT_INSTALL_DOCS/qmake/qmake.index + qhp.projects = Qt3D qhp.Qt3D.file = qt3d.qhp diff --git a/src/doc/src/qt3d-index.qdoc b/src/doc/src/qt3d-index.qdoc index 99a549b9b..4c2ce5a11 100644 --- a/src/doc/src/qt3d-index.qdoc +++ b/src/doc/src/qt3d-index.qdoc @@ -81,8 +81,8 @@ \section1 Overview The high level design and motivation for Qt3D is described in the \l {Qt 3D - Overview}. The Qt 3D Renderer aspect offers support for data-driven - configuration as described in \l {Qt 3D Renderer Framegraph}. + Overview}. The Qt 3D Render aspect offers support for data-driven + configuration as described in \l {Qt 3D Render Framegraph}. \section1 Reference \list diff --git a/src/doc/src/qt3d-overview.qdoc b/src/doc/src/qt3d-overview.qdoc index c77265ed9..331f508e6 100644 --- a/src/doc/src/qt3d-overview.qdoc +++ b/src/doc/src/qt3d-overview.qdoc @@ -157,7 +157,7 @@ and the fragment's depth can be compared with the result of the sampling. If the fragment is further away, then it is in shadow; otherwise it is lit. - For example code, see the \l {Qt3D: Shadow Map QML Example}. + For example code, see the \l {Qt 3D: Shadow Map QML Example}. \section2 Instanced Rendering @@ -183,7 +183,7 @@ To combine support for both C++ and QML APIs with having a fully configurable renderer, the concept of a \e framegraph was introduced. While a \e scenegraph is a data-driven description of \e what to render, a \l - {Qt 3D Renderer Framegraph}{framegraph} is a data-driven description of \e + {Qt 3D Render Framegraph}{framegraph} is a data-driven description of \e how to render it. A framegraph enables developers to choose between a simple forward renderer, diff --git a/src/doc/src/qt3drender-module.qdoc b/src/doc/src/qt3drender-module.qdoc index bae6217fd..7bab5cdf8 100644 --- a/src/doc/src/qt3drender-module.qdoc +++ b/src/doc/src/qt3drender-module.qdoc @@ -63,7 +63,7 @@ \section1 Overview The Qt 3D Render aspect offers support for data-driven configuration as described - in \l {Qt3D Render Framegraph}. + in \l {Qt 3D Render Framegraph}. \section1 Reference \list diff --git a/src/quick3d/quick3d/items/quick3dnodeinstantiator.cpp b/src/quick3d/quick3d/items/quick3dnodeinstantiator.cpp index 50f39130a..a4ab82155 100644 --- a/src/quick3d/quick3d/items/quick3dnodeinstantiator.cpp +++ b/src/quick3d/quick3d/items/quick3dnodeinstantiator.cpp @@ -77,10 +77,6 @@ public: QVector<QPointer<QObject> > m_objects; }; -/*! - \class Qt3DCore::Quick::Quick3DNodeInstantiatorPrivate - \internal -*/ Quick3DNodeInstantiatorPrivate::Quick3DNodeInstantiatorPrivate() : QNodePrivate() , m_componentComplete(true) diff --git a/src/quick3d/quick3d/qquaternionanimation.cpp b/src/quick3d/quick3d/qquaternionanimation.cpp index 986cc8af9..2af0b717a 100644 --- a/src/quick3d/quick3d/qquaternionanimation.cpp +++ b/src/quick3d/quick3d/qquaternionanimation.cpp @@ -41,7 +41,7 @@ QT_BEGIN_NAMESPACE /*! \qmltype QuaternionAnimation - \instantiates QQuaternionAnimation + \instantiates Qt3DCore::Quick::QQuaternionAnimation \inherits PropertyAnimation \inqmlmodule Qt3D \since 5.6 diff --git a/src/render/defaults/qphongalphamaterial.cpp b/src/render/defaults/qphongalphamaterial.cpp index 494c77e1b..a55e13f9b 100644 --- a/src/render/defaults/qphongalphamaterial.cpp +++ b/src/render/defaults/qphongalphamaterial.cpp @@ -186,8 +186,7 @@ void QPhongAlphaMaterialPrivate::handleAlphaChanged(const QVariant &var) \class Qt3DRender::QPhongAlphaMaterial \brief The QPhongAlphaMaterial class provides a default implementation of - the phong lighting effect with alpha -. + the phong lighting effect with alpha. \inmodule Qt3DRenderer \since 5.5 @@ -207,8 +206,6 @@ void QPhongAlphaMaterialPrivate::handleAlphaChanged(const QVariant &var) */ /*! - \fn Qt3DRender::QPhongAlphaMaterial::QPhongAlphaMaterial(QNode *parent) - Constructs a new QPhongAlphaMaterial instance with parent object \a parent. */ QPhongAlphaMaterial::QPhongAlphaMaterial(QNode *parent) @@ -219,8 +216,6 @@ QPhongAlphaMaterial::QPhongAlphaMaterial(QNode *parent) } /*! - \fn Qt3DRender::QPhongAlphaMaterial::~QPhongAlphaMaterial() - Destroys the QPhongAlphaMaterial. */ QPhongAlphaMaterial::~QPhongAlphaMaterial() @@ -250,7 +245,7 @@ QColor QPhongAlphaMaterial::diffuse() const } /*! - \property QColor Qt3DRender::QPhongAlphaMaterial::specular + \property Qt3DRender::QPhongAlphaMaterial::specular Holds the specular color. */ diff --git a/src/render/geometry/qabstractbuffer.cpp b/src/render/geometry/qabstractbuffer.cpp index d0ec75451..1d3673c38 100644 --- a/src/render/geometry/qabstractbuffer.cpp +++ b/src/render/geometry/qabstractbuffer.cpp @@ -42,7 +42,7 @@ QT_BEGIN_NAMESPACE namespace Qt3DRender { /*! - \class Qt3DCore::QAbstractBufferPrivate + \class Qt3DRender::QAbstractBufferPrivate \internal */ diff --git a/src/render/lights/qlight.cpp b/src/render/lights/qlight.cpp index 77cf4efe1..ee912ed00 100644 --- a/src/render/lights/qlight.cpp +++ b/src/render/lights/qlight.cpp @@ -45,7 +45,7 @@ namespace Qt3DRender /*! * \qmltype Light * \inqmlmodule Qt3D.Render - * \instantiates QLight + * \instantiates Qt3DRender::QLight * \brief Encapsulate a QLight object in a Qt 3D scene. * \since 5.6 */ |