From 25a75800eff7b342beb2260fab062e4fe203b788 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vladim=C3=ADr=20Vondru=C5=A1?= Date: Thu, 12 Jul 2018 01:41:48 +0200 Subject: [PATCH] Trade: doc++ --- src/Magnum/Trade/ImageData.h | 4 +++- src/Magnum/Trade/LightData.h | 2 ++ src/Magnum/Trade/MeshData2D.h | 2 +- src/Magnum/Trade/MeshData3D.h | 2 +- src/Magnum/Trade/MeshObjectData2D.h | 2 +- src/Magnum/Trade/MeshObjectData3D.h | 2 +- src/Magnum/Trade/ObjectData2D.h | 3 ++- src/Magnum/Trade/ObjectData3D.h | 3 ++- src/Magnum/Trade/PhongMaterialData.h | 2 ++ src/Magnum/Trade/SceneData.h | 2 ++ src/Magnum/Trade/TextureData.h | 2 ++ 11 files changed, 19 insertions(+), 7 deletions(-) diff --git a/src/Magnum/Trade/ImageData.h b/src/Magnum/Trade/ImageData.h index 29574d67f..6fdd61d3e 100644 --- a/src/Magnum/Trade/ImageData.h +++ b/src/Magnum/Trade/ImageData.h @@ -74,7 +74,9 @@ compressed properties through @ref compressedStorage() and @snippet MagnumTrade.cpp ImageData-usage -@see @ref ImageData1D, @ref ImageData2D, @ref ImageData3D +@see @ref ImageData1D, @ref ImageData2D, @ref ImageData3D, + @ref AbstractImporter::image1D(), @ref AbstractImporter::image2D(), + @ref AbstractImporter::image3D() */ template class ImageData { public: diff --git a/src/Magnum/Trade/LightData.h b/src/Magnum/Trade/LightData.h index 72569fc6f..d4d6e1f70 100644 --- a/src/Magnum/Trade/LightData.h +++ b/src/Magnum/Trade/LightData.h @@ -37,6 +37,8 @@ namespace Magnum { namespace Trade { /** @brief Light data + +@see @ref AbstractImporter::light() */ class LightData { public: diff --git a/src/Magnum/Trade/MeshData2D.h b/src/Magnum/Trade/MeshData2D.h index 5b6e0d175..5fb0067a9 100644 --- a/src/Magnum/Trade/MeshData2D.h +++ b/src/Magnum/Trade/MeshData2D.h @@ -42,7 +42,7 @@ namespace Magnum { namespace Trade { Provides access to mesh data and additional information, such as primitive type. -@see @ref MeshData3D +@see @ref AbstractImporter::mesh2D(), @ref MeshData3D */ class MAGNUM_TRADE_EXPORT MeshData2D { public: diff --git a/src/Magnum/Trade/MeshData3D.h b/src/Magnum/Trade/MeshData3D.h index 0a7366969..0f69a3103 100644 --- a/src/Magnum/Trade/MeshData3D.h +++ b/src/Magnum/Trade/MeshData3D.h @@ -42,7 +42,7 @@ namespace Magnum { namespace Trade { Provides access to mesh data and additional information, such as primitive type. -@see @ref MeshData2D +@see @ref AbstractImporter::mesh3D(), @ref MeshData2D */ class MAGNUM_TRADE_EXPORT MeshData3D { public: diff --git a/src/Magnum/Trade/MeshObjectData2D.h b/src/Magnum/Trade/MeshObjectData2D.h index 9a1b871c1..60e3ab52b 100644 --- a/src/Magnum/Trade/MeshObjectData2D.h +++ b/src/Magnum/Trade/MeshObjectData2D.h @@ -37,7 +37,7 @@ namespace Magnum { namespace Trade { @brief Two-dimensional mesh object data Provides access to material information for given mesh instance. -@see @ref MeshObjectData3D +@see @ref AbstractImporter::object2D(), @ref MeshObjectData3D */ class MAGNUM_TRADE_EXPORT MeshObjectData2D: public ObjectData2D { public: diff --git a/src/Magnum/Trade/MeshObjectData3D.h b/src/Magnum/Trade/MeshObjectData3D.h index 212f8d40f..8e3f1a46c 100644 --- a/src/Magnum/Trade/MeshObjectData3D.h +++ b/src/Magnum/Trade/MeshObjectData3D.h @@ -37,7 +37,7 @@ namespace Magnum { namespace Trade { @brief Three-dimensional mesh object data Provides access to material information for given mesh instance. -@see @ref MeshObjectData2D +@see @ref AbstractImporter::object3D(), @ref MeshObjectData2D */ class MAGNUM_TRADE_EXPORT MeshObjectData3D: public ObjectData3D { public: diff --git a/src/Magnum/Trade/ObjectData2D.h b/src/Magnum/Trade/ObjectData2D.h index 1455472f2..5c2d0527c 100644 --- a/src/Magnum/Trade/ObjectData2D.h +++ b/src/Magnum/Trade/ObjectData2D.h @@ -84,7 +84,8 @@ CORRADE_ENUMSET_OPERATORS(ObjectFlags2D) @brief Two-dimensional object data Provides access to object transformation and hierarchy. -@see @ref MeshObjectData2D, @ref ObjectData3D +@see @ref AbstractImporter::object2D(), @ref MeshObjectData2D, + @ref ObjectData3D */ class MAGNUM_TRADE_EXPORT ObjectData2D { public: diff --git a/src/Magnum/Trade/ObjectData3D.h b/src/Magnum/Trade/ObjectData3D.h index 70043798f..e97214c84 100644 --- a/src/Magnum/Trade/ObjectData3D.h +++ b/src/Magnum/Trade/ObjectData3D.h @@ -85,7 +85,8 @@ CORRADE_ENUMSET_OPERATORS(ObjectFlags3D) @brief Three-dimensional object data Provides access to object transformation and hierarchy. -@see @ref MeshObjectData3D, @ref ObjectData2D +@see @ref AbstractImporter::object3D(), @ref MeshObjectData3D, + @ref ObjectData2D */ class MAGNUM_TRADE_EXPORT ObjectData3D { public: diff --git a/src/Magnum/Trade/PhongMaterialData.h b/src/Magnum/Trade/PhongMaterialData.h index e5f3bdabb..4078dd842 100644 --- a/src/Magnum/Trade/PhongMaterialData.h +++ b/src/Magnum/Trade/PhongMaterialData.h @@ -37,6 +37,8 @@ namespace Magnum { namespace Trade { /** @brief Phong material data + +@see @ref AbstractImporter::material() */ class MAGNUM_TRADE_EXPORT PhongMaterialData: public AbstractMaterialData { public: diff --git a/src/Magnum/Trade/SceneData.h b/src/Magnum/Trade/SceneData.h index 5c05f38e2..64b03919a 100644 --- a/src/Magnum/Trade/SceneData.h +++ b/src/Magnum/Trade/SceneData.h @@ -39,6 +39,8 @@ namespace Magnum { namespace Trade { /** @brief Scene data + +@see @ref AbstractImporter::scene() */ class MAGNUM_TRADE_EXPORT SceneData { public: diff --git a/src/Magnum/Trade/TextureData.h b/src/Magnum/Trade/TextureData.h index b7b01e7c4..5d95523ba 100644 --- a/src/Magnum/Trade/TextureData.h +++ b/src/Magnum/Trade/TextureData.h @@ -37,6 +37,8 @@ namespace Magnum { namespace Trade { /** @brief Texture data + +@see @ref AbstractImporter::texture() */ class TextureData { public: