diff options
author | Topi Reinio <topi.reinio@theqtcompany.com> | 2016-01-25 09:34:15 +0100 |
---|---|---|
committer | Topi Reiniƶ <topi.reinio@theqtcompany.com> | 2016-01-26 09:13:10 +0000 |
commit | 9e62c61e42c321f8b4c258ada90e1bf6acb039b1 (patch) | |
tree | bccbb183c85731fa8c51afd77c0bc59ebe1f0021 | |
parent | c1cdd1c8f4a50e4f7131b65dc67f6dedd5826de2 (diff) |
Doc: Fix documentation macro and other issues
QDoc doesn't allow a macro that expands into an empty string:
src/core/nodes/qcomponent.cpp:189: warning:
Unknown command '\TODO'
Linking issues that are fixed by adding a dependency to Qt GUI:
src/input/frontend/qkeyevent.cpp:121: warning:
Can't link to 'QKeyEvent::nativeScanCode()'
src/input/frontend/qkeyevent.cpp:141: warning:
Can't link to 'QKeySequence::StandardKey'
src/quick3d/quick3d/qquaternionanimation.cpp:42: warning:
Can't link to 'QQuaternion'
Other fixed warnings:
src/input/frontend/qmousecontroller.cpp:54: warning:
Unknown command '\intantiates'
src/quick3d/quick3d/qquaternionanimation.cpp:42: warning:
C++ class Qt3DCore::Quick::QQuaternionAnimation not found
src/render/materialsystem/qparametermapping.cpp:85: warning:
Undocumented enum item 'UniformBufferObject'
Undocumented enum item 'ShaderStorageBufferObject'
examples/qt3d/wireframe/doc/src/wireframe.qdoc:28: warning:
Can't link to 'BasicCamera'
Change-Id: Iea8f591bd09f0b8895dc568a48f2bfe80f2fe73d
Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@digia.com>
-rw-r--r-- | examples/qt3d/wireframe/doc/src/wireframe.qdoc | 2 | ||||
-rw-r--r-- | src/doc/qt3d.qdocconf | 4 | ||||
-rw-r--r-- | src/input/frontend/qmousecontroller.cpp | 2 | ||||
-rw-r--r-- | src/quick3d/quick3d/qquaternionanimation.cpp | 1 | ||||
-rw-r--r-- | src/render/materialsystem/qparametermapping.cpp | 3 |
5 files changed, 6 insertions, 6 deletions
diff --git a/examples/qt3d/wireframe/doc/src/wireframe.qdoc b/examples/qt3d/wireframe/doc/src/wireframe.qdoc index 79d649188..078d81250 100644 --- a/examples/qt3d/wireframe/doc/src/wireframe.qdoc +++ b/examples/qt3d/wireframe/doc/src/wireframe.qdoc @@ -136,7 +136,7 @@ \printuntil ] - The \l BasicCamera type is a trivial wrapper around the built-in \l Camera + The BasicCamera type is a trivial wrapper around the built-in \l Camera type that represents a virtual camera. It has properties for such things as the near and far planes, field of view, aspect ratio, projection type, position, and orientation: diff --git a/src/doc/qt3d.qdocconf b/src/doc/qt3d.qdocconf index ef352e4bb..bb51fa725 100644 --- a/src/doc/qt3d.qdocconf +++ b/src/doc/qt3d.qdocconf @@ -38,7 +38,7 @@ qhp.Qt3D.subprojects.qmltypes.sortPages = true tagfile = qt3d.tags -depends += qtcore qtqml qtquick qtdoc +depends += qtcore qtgui qtqml qtquick qtdoc headerdirs += . \ ../render \ @@ -68,7 +68,7 @@ examples.fileextensions += "*.fraq *.geom *.vert" examples.imageextensions += "*.png" #excludedirs += -macro.TODO = "" +macro.TODO = " " imagedirs += images \ ../../examples/qt3d/shadow-map-qml/doc/images \ ../../examples/qt3d/basicshapes-cpp/doc/images \ diff --git a/src/input/frontend/qmousecontroller.cpp b/src/input/frontend/qmousecontroller.cpp index e22719455..bc38b624e 100644 --- a/src/input/frontend/qmousecontroller.cpp +++ b/src/input/frontend/qmousecontroller.cpp @@ -51,7 +51,7 @@ QMouseControllerPrivate::QMouseControllerPrivate() } /*! * \qmltype MouseController - * \intantiates Qt3DInput::QMouseController + * \instantiates Qt3DInput::QMouseController * \inqmlmodule Qt3D.Input * \since 5.5 * \brief Delegates mouse events to the attached MouseInput objects. diff --git a/src/quick3d/quick3d/qquaternionanimation.cpp b/src/quick3d/quick3d/qquaternionanimation.cpp index 5dc63995c..872f299ec 100644 --- a/src/quick3d/quick3d/qquaternionanimation.cpp +++ b/src/quick3d/quick3d/qquaternionanimation.cpp @@ -41,7 +41,6 @@ QT_BEGIN_NAMESPACE /*! \qmltype QuaternionAnimation - \instantiates Qt3DCore::Quick::QQuaternionAnimation \inherits PropertyAnimation \inqmlmodule Qt3D.Core \since 5.6 diff --git a/src/render/materialsystem/qparametermapping.cpp b/src/render/materialsystem/qparametermapping.cpp index 4a9aaddff..0d755dffc 100644 --- a/src/render/materialsystem/qparametermapping.cpp +++ b/src/render/materialsystem/qparametermapping.cpp @@ -89,7 +89,8 @@ QParameterMapping::QParameterMapping(QNode *parent) \value Attribute \value StandardUniform \value FragmentOutput - + \value UniformBufferObject + \value ShaderStorageBufferObject */ /*! \internal */ |