diff options
author | Antti Määttä <antti.maatta@qt.io> | 2016-09-06 16:30:36 +0300 |
---|---|---|
committer | Antti Määttä <antti.maatta@qt.io> | 2017-01-10 07:09:37 +0000 |
commit | 88f6841a26cf0819891708a1927b849f3df45728 (patch) | |
tree | bc43bb3c09d9d98a3da234bf731c660a6c9a77f4 | |
parent | 0345c518a41d5b0d00415d320b644e6c1c09b183 (diff) |
Update EntityLoader docs
Change-Id: I5b87cc9a581267fab5a0c482f243f9e1d611423a
Reviewed-by: Tomi Korpipää <tomi.korpipaa@qt.io>
Reviewed-by: Sean Harmer <sean.harmer@kdab.com>
-rw-r--r-- | src/quick3d/quick3d/items/quick3dentityloader.cpp | 11 |
1 files changed, 10 insertions, 1 deletions
diff --git a/src/quick3d/quick3d/items/quick3dentityloader.cpp b/src/quick3d/quick3d/items/quick3dentityloader.cpp index 9f305d977..9c82db7ad 100644 --- a/src/quick3d/quick3d/items/quick3dentityloader.cpp +++ b/src/quick3d/quick3d/items/quick3dentityloader.cpp @@ -93,7 +93,14 @@ private: /*! \qmltype EntityLoader \inqmlmodule Qt3D.Core + \inherits Entity \since 5.5 + \brief Provides the facility to load entities from qml source + + An EntityLoader provides the facitily to load predefined set of entities + from qml source file. EntityLoader itself is an entity and the loaded entity + tree is set as a child of the loader. The loaded entity tree root can be + accessed with EntityLoader::entity property. */ Quick3DEntityLoader::Quick3DEntityLoader(QNode *parent) : QEntity(*new Quick3DEntityLoaderPrivate, parent) @@ -107,7 +114,8 @@ Quick3DEntityLoader::~Quick3DEntityLoader() } /*! - \qmlproperty QtQml::QtObject Qt3DCore::EntityLoader::entity + \qmlproperty QtQml::QtObject EntityLoader::entity + Holds the loaded entity tree root. \readonly */ QObject *Quick3DEntityLoader::entity() const @@ -118,6 +126,7 @@ QObject *Quick3DEntityLoader::entity() const /*! \qmlproperty url Qt3DCore::EntityLoader::source + Holds the source url. */ QUrl Quick3DEntityLoader::source() const { |