From b68a168fcb5f48e41d4764b8f5fcfc89279b72d5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vladim=C3=ADr=20Vondru=C5=A1?= Date: Wed, 26 Sep 2012 20:40:52 +0200 Subject: [PATCH] Doc: crosslinking 1D/2D/3D alternatives. --- src/BufferedImage.h | 2 +- src/Image.h | 1 + src/Math/Point2D.h | 1 + src/Math/Point3D.h | 1 + src/SceneGraph/Camera.h | 12 ++++++++++-- src/SceneGraph/Object.h | 20 ++++++++++++++------ src/SceneGraph/Scene.h | 6 +++++- src/Texture.h | 2 +- src/Trade/MeshData2D.h | 1 + src/Trade/MeshData3D.h | 1 + src/Trade/MeshObjectData2D.h | 1 + src/Trade/MeshObjectData3D.h | 1 + src/Trade/ObjectData2D.h | 1 + src/Trade/ObjectData3D.h | 1 + 14 files changed, 40 insertions(+), 11 deletions(-) diff --git a/src/BufferedImage.h b/src/BufferedImage.h index 34a767abb..8b04bd615 100644 --- a/src/BufferedImage.h +++ b/src/BufferedImage.h @@ -31,7 +31,7 @@ namespace Magnum { Class for storing image data in GPU memory. Can be replaced with Image, which stores image data in client memory, ImageWrapper, or for example with Trade::ImageData. -@see Buffer +@see BufferedImage1D, BufferedImage2D, BufferedImage3D, Buffer @requires_gles30 (no extension providing this functionality) */ template class BufferedImage: public AbstractImage { diff --git a/src/Image.h b/src/Image.h index fd83832a7..472af324a 100644 --- a/src/Image.h +++ b/src/Image.h @@ -30,6 +30,7 @@ namespace Magnum { Class for storing image data on client memory. Can be replaced with ImageWrapper, BufferedImage, which stores image data in GPU memory, or for example with Trade::ImageData. +@see Image1D, Image2D, Image3D */ template class Image: public AbstractImage { public: diff --git a/src/Math/Point2D.h b/src/Math/Point2D.h index f0c85186a..a882e68ab 100644 --- a/src/Math/Point2D.h +++ b/src/Math/Point2D.h @@ -29,6 +29,7 @@ namespace Magnum { namespace Math { Same as Vector3, except that constructors have default value for Z component set to one. See also @ref matrix-vector for brief introduction. +@see Point3D @configurationvalueref{Magnum::Math::Point2D} */ template class Point2D: public Vector3 { diff --git a/src/Math/Point3D.h b/src/Math/Point3D.h index 428a91395..19c89aa75 100644 --- a/src/Math/Point3D.h +++ b/src/Math/Point3D.h @@ -29,6 +29,7 @@ namespace Magnum { namespace Math { Same as Vector4, except that constructors have default value for W component set to one. See also @ref matrix-vector for brief introduction. +@see Point2D @configurationvalueref{Magnum::Math::Point3D} */ template class Point3D: public Vector4 { diff --git a/src/SceneGraph/Camera.h b/src/SceneGraph/Camera.h index 97507ab21..18f5c016c 100644 --- a/src/SceneGraph/Camera.h +++ b/src/SceneGraph/Camera.h @@ -183,7 +183,11 @@ namespace Implementation { } #endif -/** @brief %Camera for two-dimensional scenes */ +/** +@brief %Camera for two-dimensional scenes + +@see Camera3D +*/ class SCENEGRAPH_EXPORT Camera2D: public AbstractCamera<2> { public: /** @@ -206,7 +210,11 @@ class SCENEGRAPH_EXPORT Camera2D: public AbstractCamera<2> { Camera2D* setProjection(const Vector2& size); }; -/** @brief %Camera for three-dimensional scenes */ +/** +@brief %Camera for three-dimensional scenes + +@see Camera2D +*/ class SCENEGRAPH_EXPORT Camera3D: public AbstractCamera<3> { public: /** diff --git a/src/SceneGraph/Object.h b/src/SceneGraph/Object.h index ffbf86042..cdeaf5a69 100644 --- a/src/SceneGraph/Object.h +++ b/src/SceneGraph/Object.h @@ -71,10 +71,10 @@ namespace Implementation { */ /** - * @brief Base for all positioned objects - * - * @todo Transform transformation when changing parent, so the object stays in - * place. +@brief Base for all positioned objects + +@todo Transform transformation when changing parent, so the object stays in +place. */ template class SCENEGRAPH_EXPORT AbstractObject: public Corrade::Containers::LinkedList::ObjectType>, public Corrade::Containers::LinkedListItem::ObjectType, typename Implementation::ObjectDimensionTraits::ObjectType> { #ifndef DOXYGEN_GENERATING_OUTPUT @@ -328,7 +328,11 @@ extern template class SCENEGRAPH_EXPORT AbstractObject<2>; extern template class SCENEGRAPH_EXPORT AbstractObject<3>; #endif -/** @brief Two-dimensional object */ +/** +@brief Two-dimensional object + +@see Object3D +*/ class SCENEGRAPH_EXPORT Object2D: public AbstractObject<2> { public: /** @copydoc AbstractObject::AbstractObject() */ @@ -379,7 +383,11 @@ class SCENEGRAPH_EXPORT Object2D: public AbstractObject<2> { } }; -/** @brief Three-dimensional object */ +/** +@brief Three-dimensional object + +@see Object2D +*/ class SCENEGRAPH_EXPORT Object3D: public AbstractObject<3> { public: /** @copydoc AbstractObject::AbstractObject() */ diff --git a/src/SceneGraph/Scene.h b/src/SceneGraph/Scene.h index f3cfde551..092f85e73 100644 --- a/src/SceneGraph/Scene.h +++ b/src/SceneGraph/Scene.h @@ -23,7 +23,11 @@ namespace Magnum { namespace SceneGraph { -/** @brief %Scene */ +/** +@brief %Scene + +@see Scene2D, Scene3D +*/ template class SCENEGRAPH_EXPORT Scene: public AbstractObject::ObjectType { public: /** @copydoc AbstractObject::isScene() */ diff --git a/src/Texture.h b/src/Texture.h index 8faed911a..ca8d54a4b 100644 --- a/src/Texture.h +++ b/src/Texture.h @@ -46,7 +46,7 @@ for more information. @requires_gl (rectangle textures) @requires_gl31 Extension @extension{ARB,texture_rectangle} (rectangle textures) -@see CubeMapTexture, CubeMapTextureArray +@see Texture1D, Texture2D, Texture3D, CubeMapTexture, CubeMapTextureArray */ template class Texture: public AbstractTexture { public: diff --git a/src/Trade/MeshData2D.h b/src/Trade/MeshData2D.h index 3a7663e44..cc650a213 100644 --- a/src/Trade/MeshData2D.h +++ b/src/Trade/MeshData2D.h @@ -31,6 +31,7 @@ namespace Magnum { namespace Trade { Provides access to mesh data and additional information, such as primitive type. +@see MeshData3D */ class MAGNUM_EXPORT MeshData2D { MeshData2D(const MeshData2D& other) = delete; diff --git a/src/Trade/MeshData3D.h b/src/Trade/MeshData3D.h index 371bd4a59..159a6ebcf 100644 --- a/src/Trade/MeshData3D.h +++ b/src/Trade/MeshData3D.h @@ -31,6 +31,7 @@ namespace Magnum { namespace Trade { Provides access to mesh data and additional information, such as primitive type. +@see MeshData2D */ class MAGNUM_EXPORT MeshData3D { MeshData3D(const MeshData3D& other) = delete; diff --git a/src/Trade/MeshObjectData2D.h b/src/Trade/MeshObjectData2D.h index c733c53a4..8eda1d68f 100644 --- a/src/Trade/MeshObjectData2D.h +++ b/src/Trade/MeshObjectData2D.h @@ -27,6 +27,7 @@ namespace Magnum { namespace Trade { @brief Two-dimensional mesh object data Provides access to material information for given mesh instance. +@see MeshObjectData3D */ class MeshObjectData2D: public ObjectData2D { MeshObjectData2D(const MeshObjectData2D& other) = delete; diff --git a/src/Trade/MeshObjectData3D.h b/src/Trade/MeshObjectData3D.h index 4dbfef017..c133f2ed7 100644 --- a/src/Trade/MeshObjectData3D.h +++ b/src/Trade/MeshObjectData3D.h @@ -27,6 +27,7 @@ namespace Magnum { namespace Trade { @brief Three-dimensional mesh object data Provides access to material information for given mesh instance. +@see MeshObjectData2D */ class MeshObjectData3D: public ObjectData3D { MeshObjectData3D(const MeshObjectData3D& other) = delete; diff --git a/src/Trade/ObjectData2D.h b/src/Trade/ObjectData2D.h index 7610087eb..2db556f08 100644 --- a/src/Trade/ObjectData2D.h +++ b/src/Trade/ObjectData2D.h @@ -29,6 +29,7 @@ namespace Magnum { namespace Trade { Provides access to object transformation and hierarchy. See also MeshObjectData2D, which is specialized for objects with mesh instance type. +@see ObjectData3D */ class ObjectData2D { ObjectData2D(const ObjectData2D& other) = delete; diff --git a/src/Trade/ObjectData3D.h b/src/Trade/ObjectData3D.h index 189560254..ec048e194 100644 --- a/src/Trade/ObjectData3D.h +++ b/src/Trade/ObjectData3D.h @@ -29,6 +29,7 @@ namespace Magnum { namespace Trade { Provides access to object transformation and hierarchy. See also MeshObjectData3D, which is specialized for objects with mesh instance type. +@see ObjectData2D */ class ObjectData3D { ObjectData3D(const ObjectData3D& other) = delete;