Browse Source

Trade: doc++

pull/165/merge
Vladimír Vondruš 10 years ago
parent
commit
326fcf91cb
  1. 2
      src/Magnum/Trade/AbstractMaterialData.h
  2. 6
      src/Magnum/Trade/ObjectData2D.h
  3. 5
      src/Magnum/Trade/ObjectData3D.h

2
src/Magnum/Trade/AbstractMaterialData.h

@ -40,7 +40,7 @@ namespace Magnum { namespace Trade {
@see @ref AbstractMaterialData::type()
*/
enum class MaterialType: UnsignedByte {
Phong /**< Phong shading */
Phong /**< Phong shading (see @ref PhongMaterialData) */
};
/**

6
src/Magnum/Trade/ObjectData2D.h

@ -110,8 +110,10 @@ class MAGNUM_EXPORT ObjectData2D {
/**
* @brief Instance ID
* @return ID of given camera / light / mesh etc., specified by
* @ref instanceType()
*
* Returns ID of given camera / light / mesh etc., specified by
* @ref instanceType(). If @ref instanceType() is
* @ref ObjectInstanceType2D::Empty, this function returns `-1`.
*/
Int instance() const { return _instance; }

5
src/Magnum/Trade/ObjectData3D.h

@ -42,8 +42,8 @@ namespace Magnum { namespace Trade {
@see @ref ObjectData3D::instanceType()
*/
enum class ObjectInstanceType3D: UnsignedByte {
Camera, /**< Camera instance (see CameraData) */
Light, /**< Light instance (see LightData) */
Camera, /**< Camera instance (see @ref CameraData) */
Light, /**< Light instance (see @ref LightData) */
/**
* Mesh instance. The data can be cast to @ref MeshObjectData3D to provide
@ -54,7 +54,6 @@ enum class ObjectInstanceType3D: UnsignedByte {
Empty /**< Empty */
};
/**
@brief Three-dimensional object data

Loading…
Cancel
Save