From 261e7cbdc5188534d35ab94531bafc6e3f9f6398 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vladim=C3=ADr=20Vondru=C5=A1?= Date: Wed, 31 Jul 2013 01:15:42 +0200 Subject: [PATCH] Trade: improved documentation, removed redundancy. --- src/Trade/ObjectData2D.h | 19 +++++++++++-------- src/Trade/ObjectData3D.h | 19 +++++++++++-------- 2 files changed, 22 insertions(+), 16 deletions(-) diff --git a/src/Trade/ObjectData2D.h b/src/Trade/ObjectData2D.h index e80f2a01a..65a61a7f1 100644 --- a/src/Trade/ObjectData2D.h +++ b/src/Trade/ObjectData2D.h @@ -38,16 +38,21 @@ namespace Magnum { namespace Trade { /** @brief Two-dimensional object data -Provides access to object transformation and hierarchy. See also -MeshObjectData2D, which is specialized for objects with mesh instance type. -@see ObjectData3D +Provides access to object transformation and hierarchy. +@see MeshObjectData2D, ObjectData3D */ class MAGNUM_EXPORT ObjectData2D { public: - /** @brief Instance type */ + /** @brief Type of instance held by this object */ enum class InstanceType: UnsignedByte { Camera, /**< Camera instance (see CameraData) */ - Mesh, /**< Three-dimensional mesh instance (see MeshData2D) */ + + /** + * Three-dimensional mesh instance. The data can be cast to + * MeshObjectData2D to provide more information. + */ + Mesh, + Empty /**< Empty */ }; @@ -90,10 +95,8 @@ class MAGNUM_EXPORT ObjectData2D { /** * @brief Instance type - * @return Type of instance held by this object * - * If the instance is of type InstanceType::Mesh, the instance can be - * casted to MeshObjectData2D and provide more information. + * @see instance() */ InstanceType instanceType() const { return _instanceType; } diff --git a/src/Trade/ObjectData3D.h b/src/Trade/ObjectData3D.h index fbe5c47cd..884cafb94 100644 --- a/src/Trade/ObjectData3D.h +++ b/src/Trade/ObjectData3D.h @@ -38,17 +38,22 @@ namespace Magnum { namespace Trade { /** @brief Three-dimensional object data -Provides access to object transformation and hierarchy. See also -MeshObjectData3D, which is specialized for objects with mesh instance type. -@see ObjectData2D +Provides access to object transformation and hierarchy. +@see MeshObjectData3D, ObjectData2D */ class MAGNUM_EXPORT ObjectData3D { public: - /** @brief Instance type */ + /** @brief Type of instance held by this object */ enum class InstanceType: UnsignedByte { Camera, /**< Camera instance (see CameraData) */ Light, /**< Light instance (see LightData) */ - Mesh, /**< Three-dimensional mesh instance (see MeshData3D) */ + + /** + * Three-dimensional mesh instance. The data can be cast to + * MeshObjectData3D to provide more information. + */ + Mesh, + Empty /**< Empty */ }; @@ -91,10 +96,8 @@ class MAGNUM_EXPORT ObjectData3D { /** * @brief Instance type - * @return Type of instance held by this object * - * If the instance is of type InstanceType::Mesh, the instance can be - * casted to MeshObjectData3D and provide more information. + * @see instance() */ InstanceType instanceType() const { return _instanceType; }