diff options
author | Topi Reinio <topi.reinio@digia.com> | 2015-11-04 12:47:51 +0100 |
---|---|---|
committer | Topi Reiniƶ <topi.reinio@theqtcompany.com> | 2015-11-23 14:15:40 +0000 |
commit | 85ffad3142cd4c3baa0bb77b0674a17287b01534 (patch) | |
tree | d0ab865a944d837b965546248b19e1ab69e99a82 /src/quick3d/quick3d/items | |
parent | ed9628c87fac466ee6106d12996373ddf56f2c73 (diff) |
Doc: Fix QDoc warnings and do further cleanup
Fix the documentation issues that still remained broken after
renaming the namespaces/QML modules. Do further cleanup and
minor doc editing.
Change-Id: Iff38c8c1b99e7f712dc3f9ad07ecd37a747b3a26
Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@digia.com>
Diffstat (limited to 'src/quick3d/quick3d/items')
-rw-r--r-- | src/quick3d/quick3d/items/quick3dnodeinstantiator.cpp | 23 |
1 files changed, 11 insertions, 12 deletions
diff --git a/src/quick3d/quick3d/items/quick3dnodeinstantiator.cpp b/src/quick3d/quick3d/items/quick3dnodeinstantiator.cpp index f4021b999..50f39130a 100644 --- a/src/quick3d/quick3d/items/quick3dnodeinstantiator.cpp +++ b/src/quick3d/quick3d/items/quick3dnodeinstantiator.cpp @@ -222,7 +222,6 @@ void Quick3DNodeInstantiatorPrivate::makeModel() /*! \qmltype NodeInstantiator - \instantiates Quick3DNodeInstantiator \inqmlmodule Qt3D.Core \brief Dynamically creates nodes. \since 5.5 @@ -249,7 +248,7 @@ Quick3DNodeInstantiator::~Quick3DNodeInstantiator() } /*! - \qmlsignal Qt3DCore::NodeInstantiator::objectAdded(int index, QtObject node) + \qmlsignal Qt3D.Core::NodeInstantiator::objectAdded(int index, QtObject node) This signal is emitted when a node is added to the NodeInstantiator. The \a index parameter holds the index which the node has been given, and the \a node @@ -259,11 +258,11 @@ Quick3DNodeInstantiator::~Quick3DNodeInstantiator() */ /*! - \qmlsignal Qt3DCore::NodeInstantiator::objectRemoved(int index, QtObject object) + \qmlsignal Qt3D.Core::NodeInstantiator::objectRemoved(int index, QtObject object) This signal is emitted when an object is removed from the Instantiator. The \a index parameter holds the index which the object had been given, and the \a object - parameter holds the \l QtObject that has been removed. + parameter holds the \l [QML] {QtQml::}{QtObject} that has been removed. Do not keep a reference to \a object if it was created by this Instantiator, as in these cases it will be deleted shortly after the signal is handled. @@ -271,7 +270,7 @@ Quick3DNodeInstantiator::~Quick3DNodeInstantiator() The corresponding handler is \c onObjectRemoved. */ /*! - \qmlproperty bool Qt3DCore::NodeInstantiator::active + \qmlproperty bool Qt3D.Core::NodeInstantiator::active When active is \c true, and the delegate component is ready, the Instantiator will create objects according to the model. When active is \c false, no objects @@ -296,7 +295,7 @@ void Quick3DNodeInstantiator::setActive(bool newVal) } /*! - \qmlproperty bool Qt3DCore::NodeInstantiator::asynchronous + \qmlproperty bool Qt3D.Core::NodeInstantiator::asynchronous When asynchronous is true the Instantiator will attempt to create objects asynchronously. This means that objects may not be available immediately, @@ -304,7 +303,7 @@ void Quick3DNodeInstantiator::setActive(bool newVal) You can use the objectAdded signal to respond to items being created. - Default is false. + Default is \c false. */ bool Quick3DNodeInstantiator::isAsync() const { @@ -323,7 +322,7 @@ void Quick3DNodeInstantiator::setAsync(bool newVal) /*! - \qmlproperty int Qt3DCore::NodeInstantiator::count + \qmlproperty int Qt3D.Core::NodeInstantiator::count \readonly The number of objects the Instantiator is currently managing. @@ -336,7 +335,7 @@ int Quick3DNodeInstantiator::count() const } /*! - \qmlproperty QtQml::Component Qt3DCore::NodeInstantiator::delegate + \qmlproperty QtQml::Component Qt3D.Core::NodeInstantiator::delegate \default The component used to create all objects. @@ -373,7 +372,7 @@ void Quick3DNodeInstantiator::setDelegate(QQmlComponent *c) } /*! - \qmlproperty variant Qt3DCore::NodeInstantiator::model + \qmlproperty variant Qt3D.Core::NodeInstantiator::model This property can be set to any of the supported \l {qml-data-models}{data models}: @@ -448,7 +447,7 @@ void Quick3DNodeInstantiator::setModel(const QVariant &v) } /*! - \qmlproperty QtQml::QtObject Qt3DCore::NodeInstantiator::object + \qmlproperty QtQml::QtObject Qt3D.Core::NodeInstantiator::object \readonly This is a reference to the first created object, intended as a convenience @@ -463,7 +462,7 @@ QObject *Quick3DNodeInstantiator::object() const } /*! - \qmlmethod QtQml::QtObject Qt3DCore::NodeInstantiator::objectAt(int index) + \qmlmethod QtQml::QtObject Qt3D.Core::NodeInstantiator::objectAt(int index) Returns a reference to the object with the given \a index. */ |