From c451b223928aba8d7c397b13f9b781a92fb4caae Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vladim=C3=ADr=20Vondru=C5=A1?= Date: Tue, 14 Aug 2012 03:49:11 +0200 Subject: [PATCH] Revert "Documentation: organizing the classes into "modules"." It only caused another maintenance burden and was confusing to users. Now when scene graph is in SceneGraph namespace there is no need for another grouping. Namespaces are (and should be) sufficient. This reverts commit 79945ab6fce4bf0b53faab1d2f694f4cd934d562. Conflicts: src/BufferedImage.h src/BufferedTexture.h src/Framebuffer.h src/Query.h src/SceneGraph/Scene.h --- doc/groups.dox | 29 ---------------------------- doc/mainpage.dox | 5 ----- doc/namespaces.dox | 9 +++------ src/AbstractImage.h | 2 +- src/AbstractShaderProgram.h | 2 +- src/AbstractTexture.h | 2 +- src/Buffer.h | 2 +- src/BufferedImage.h | 6 ------ src/BufferedTexture.h | 2 +- src/CubeMapTexture.h | 2 +- src/CubeMapTextureArray.h | 2 +- src/Framebuffer.h | 3 +-- src/Image.h | 6 ------ src/ImageWrapper.h | 6 ------ src/IndexedMesh.h | 2 +- src/Math/MathTypeTraits.h | 2 +- src/Mesh.h | 2 +- src/MeshTools/Clean.h | 2 +- src/MeshTools/CombineIndexedArrays.h | 2 +- src/MeshTools/CompressIndices.h | 6 ------ src/MeshTools/FlipNormals.h | 6 ------ src/MeshTools/GenerateFlatNormals.h | 2 +- src/MeshTools/Interleave.h | 6 ------ src/MeshTools/Subdivide.h | 2 +- src/MeshTools/Tipsify.h | 2 +- src/Primitives/Capsule.h | 2 +- src/Primitives/Cube.h | 4 +--- src/Primitives/Icosphere.h | 4 ++-- src/Primitives/Plane.h | 2 +- src/Primitives/UVSphere.h | 4 +--- src/Query.h | 5 ----- src/Renderbuffer.h | 2 +- src/SceneGraph/Camera.h | 2 +- src/SceneGraph/Light.h | 2 +- src/SceneGraph/Object.h | 2 +- src/SceneGraph/Scene.h | 4 +--- src/Shader.h | 2 +- src/Shaders/PhongShader.h | 2 +- src/SizeTraits.h | 6 ------ src/Texture.h | 6 ------ src/TypeTraits.h | 6 ------ 41 files changed, 32 insertions(+), 135 deletions(-) delete mode 100644 doc/groups.dox diff --git a/doc/groups.dox b/doc/groups.dox deleted file mode 100644 index 22e833e4b..000000000 --- a/doc/groups.dox +++ /dev/null @@ -1,29 +0,0 @@ -namespace Magnum { - -/** @page modules */ - -/** -@defgroup scene Scene graph -@brief %Scene hierarchy, cameras, lights and other objects -*/ - -/** -@defgroup mesh Meshes -@brief Creating, modifying and rendering meshes -*/ - -/** -@defgroup rendering Rendering -@brief %Shader, buffer and mesh management, render queries -*/ - -/** @ingroup rendering -@defgroup textures Textures -@brief Access to OpenGL textures, image data wrappers and framebuffer operations -*/ - -/** -@defgroup utility Utility -@brief Various supporting utility classes -*/ -} diff --git a/doc/mainpage.dox b/doc/mainpage.dox index 8071252ee..093bcf0ce 100644 --- a/doc/mainpage.dox +++ b/doc/mainpage.dox @@ -50,11 +50,6 @@ in step-by-step tutorial. Then you can dig deeper and try @ref example-index "other examples", read about fundamental principles in the documentation or start experimenting on your own! -@subsection module-overview Module overview - -Classes in %Magnum are grouped into a few modules for a better orientation. -Check the @ref modules "module index" for more information about all classes. - @subsection getting-started-hacking Hacking Magnum If you want to hack on this engine, if you spotted a bug, need an feature or diff --git a/doc/namespaces.dox b/doc/namespaces.dox index 5f9427928..63587bca1 100644 --- a/doc/namespaces.dox +++ b/doc/namespaces.dox @@ -40,8 +40,7 @@ Functions for computing intersections, distances, areas and volumes. /** @dir MeshTools * @brief Namespace Magnum::MeshTools */ -/** @ingroup mesh -@namespace Magnum::MeshTools +/** @namespace Magnum::MeshTools @brief %Mesh tools Tools for generating, optimizing and cleaning meshes. @@ -50,8 +49,7 @@ Tools for generating, optimizing and cleaning meshes. /** @dir Primitives * @brief Namespace Magnum::Primitives */ -/** @ingroup mesh -@namespace Magnum::Primitives +/** @namespace Magnum::Primitives @brief Primitive library Basic primitives for testing purposes. @@ -70,8 +68,7 @@ Setting up and rendering the scene. /** @dir Shaders * @brief Namespace Magnum::Shaders */ -/** @ingroup rendering -@namespace Magnum::Shaders +/** @namespace Magnum::Shaders @brief Sample shaders Collection of shaders for testing purposes. diff --git a/src/AbstractImage.h b/src/AbstractImage.h index 815371bfe..1a86e4313 100644 --- a/src/AbstractImage.h +++ b/src/AbstractImage.h @@ -23,7 +23,7 @@ namespace Magnum { -/** @ingroup textures +/** @brief Non-templated base for one-, two- or three-dimensional images See Image, BufferedImage, Trade::ImageData documentation for more information. diff --git a/src/AbstractShaderProgram.h b/src/AbstractShaderProgram.h index 6b53cd6b6..827d238de 100644 --- a/src/AbstractShaderProgram.h +++ b/src/AbstractShaderProgram.h @@ -25,7 +25,7 @@ namespace Magnum { -/** @ingroup rendering +/** @brief Base class for shaders @section AbstractShaderProgram-subclassing Subclassing workflow diff --git a/src/AbstractTexture.h b/src/AbstractTexture.h index 2e1856e6f..5dd213d17 100644 --- a/src/AbstractTexture.h +++ b/src/AbstractTexture.h @@ -24,7 +24,7 @@ namespace Magnum { -/** @ingroup textures +/** @brief Base for textures @attention Don't forget to call @ref Texture::setWrapping() "setWrapping()", diff --git a/src/Buffer.h b/src/Buffer.h index 940dcaae5..2b7655b9c 100644 --- a/src/Buffer.h +++ b/src/Buffer.h @@ -23,7 +23,7 @@ namespace Magnum { -/** @ingroup rendering +/** @brief Class for managing buffers @todo Support for buffer copying (OpenGL 3.1, @extension{ARB,copy_buffer}) diff --git a/src/BufferedImage.h b/src/BufferedImage.h index c8efa5181..5b91723c5 100644 --- a/src/BufferedImage.h +++ b/src/BufferedImage.h @@ -26,10 +26,6 @@ namespace Magnum { #ifndef MAGNUM_TARGET_GLES -/** @addtogroup textures - * @{ - */ - /** @brief %Buffered image @@ -116,8 +112,6 @@ typedef BufferedImage<2> BufferedImage2D; /** @brief Three-dimensional buffered image */ typedef BufferedImage<3> BufferedImage3D; - -/*@}*/ #endif } diff --git a/src/BufferedTexture.h b/src/BufferedTexture.h index fca8f74fc..12f2b05c0 100644 --- a/src/BufferedTexture.h +++ b/src/BufferedTexture.h @@ -25,7 +25,7 @@ namespace Magnum { #ifndef MAGNUM_TARGET_GLES -/** @ingroup textures +/** @brief Buffered texture This texture is, unlike classic textures such as Texture or CubeMapTexture, diff --git a/src/CubeMapTexture.h b/src/CubeMapTexture.h index 7a8edbdfa..44ae71fce 100644 --- a/src/CubeMapTexture.h +++ b/src/CubeMapTexture.h @@ -23,7 +23,7 @@ namespace Magnum { -/** @ingroup textures +/** @brief Cube map texture %Texture used mainly for environemnt maps. See AbstractTexture documentation diff --git a/src/CubeMapTextureArray.h b/src/CubeMapTextureArray.h index 22d7e1cde..0a1f0ebca 100644 --- a/src/CubeMapTextureArray.h +++ b/src/CubeMapTextureArray.h @@ -23,7 +23,7 @@ namespace Magnum { -/** @ingroup textures +/** @brief Cube map texture array For information about usage, see CubeMapTexture documentation. diff --git a/src/Framebuffer.h b/src/Framebuffer.h index 7e6b16772..b6e98c34b 100644 --- a/src/Framebuffer.h +++ b/src/Framebuffer.h @@ -29,8 +29,7 @@ namespace Magnum { -/** @ingroup textures -@nosubgrouping +/** @nosubgrouping @brief %Framebuffer Provides operations with framebuffers (configuring, clearing, blitting...) and diff --git a/src/Image.h b/src/Image.h index 61dcf30a0..7a595786f 100644 --- a/src/Image.h +++ b/src/Image.h @@ -24,10 +24,6 @@ namespace Magnum { -/** @addtogroup textures - * @{ - */ - /** @brief %Image @@ -128,8 +124,6 @@ typedef Image<2> Image2D; /** @brief Three-dimensional image */ typedef Image<3> Image3D; -/*@}*/ - } #endif diff --git a/src/ImageWrapper.h b/src/ImageWrapper.h index fef9a13c0..b4dc0e4e6 100644 --- a/src/ImageWrapper.h +++ b/src/ImageWrapper.h @@ -24,10 +24,6 @@ namespace Magnum { -/** @addtogroup textures - * @{ - */ - /** @brief %Image wrapper @@ -113,8 +109,6 @@ typedef ImageWrapper<2> ImageWrapper2D; /** @brief Three-dimensional image wrapper */ typedef ImageWrapper<3> ImageWrapper3D; -/*@}*/ - } #endif diff --git a/src/IndexedMesh.h b/src/IndexedMesh.h index a400d7f55..7250357b2 100644 --- a/src/IndexedMesh.h +++ b/src/IndexedMesh.h @@ -24,7 +24,7 @@ namespace Magnum { -/** @ingroup rendering mesh +/** * @brief Indexed mesh */ class MAGNUM_EXPORT IndexedMesh: public Mesh { diff --git a/src/Math/MathTypeTraits.h b/src/Math/MathTypeTraits.h index 3208711d0..fb97bb8b6 100644 --- a/src/Math/MathTypeTraits.h +++ b/src/Math/MathTypeTraits.h @@ -33,7 +33,7 @@ namespace Magnum { namespace Math { -/** @ingroup utility +/** @brief Traits class for numeric types Traits classes are usable for detecting type features at compile time without diff --git a/src/Mesh.h b/src/Mesh.h index 10956f569..e75567d8b 100644 --- a/src/Mesh.h +++ b/src/Mesh.h @@ -30,7 +30,7 @@ namespace Magnum { class Buffer; -/** @ingroup rendering mesh +/** @brief Base class for managing non-indexed meshes VAOs are used for desktop OpenGL (not in OpenGL ES). diff --git a/src/MeshTools/Clean.h b/src/MeshTools/Clean.h index a0b4ccade..7f5247d07 100644 --- a/src/MeshTools/Clean.h +++ b/src/MeshTools/Clean.h @@ -119,7 +119,7 @@ template class Clean { } #endif -/** @ingroup mesh +/** @brief %Clean the mesh @tparam Vertex Vertex data type @tparam vertexSize How many initial vertex fields are important (for diff --git a/src/MeshTools/CombineIndexedArrays.h b/src/MeshTools/CombineIndexedArrays.h index d3b272e8d..612e8fce3 100644 --- a/src/MeshTools/CombineIndexedArrays.h +++ b/src/MeshTools/CombineIndexedArrays.h @@ -89,7 +89,7 @@ class CombineIndexedArrays { } #endif -/** @ingroup mesh +/** @brief Combine indexed arrays @param[in,out] indexedArrays Index and attribute arrays @return Array with resulting indices diff --git a/src/MeshTools/CompressIndices.h b/src/MeshTools/CompressIndices.h index bbfe171c9..4a6b2ac48 100644 --- a/src/MeshTools/CompressIndices.h +++ b/src/MeshTools/CompressIndices.h @@ -73,10 +73,6 @@ class CompressIndices { } #endif -/** @addtogroup mesh - * @{ - */ - /** @brief Compress vertex indices @param indices Index array @@ -119,8 +115,6 @@ inline void compressIndices(IndexedMesh* mesh, Buffer::Usage usage, const std::v return Implementation::CompressIndices{indices}(mesh, usage); } -/*@}*/ - }} #endif diff --git a/src/MeshTools/FlipNormals.h b/src/MeshTools/FlipNormals.h index 2c5be2216..191177945 100644 --- a/src/MeshTools/FlipNormals.h +++ b/src/MeshTools/FlipNormals.h @@ -24,10 +24,6 @@ namespace Magnum { namespace MeshTools { -/** @addtogroup mesh - * @{ - */ - /** @brief Flip face winding @@ -61,8 +57,6 @@ inline void flipNormals(std::vector& indices, std::vector flipNormals(normals); } -/*@}*/ - }} #endif diff --git a/src/MeshTools/GenerateFlatNormals.h b/src/MeshTools/GenerateFlatNormals.h index 1af39d95e..a5dfcbb9b 100644 --- a/src/MeshTools/GenerateFlatNormals.h +++ b/src/MeshTools/GenerateFlatNormals.h @@ -26,7 +26,7 @@ namespace Magnum { namespace MeshTools { -/** @ingroup mesh +/** @brief Generate flat normals @param indices Array of triangle face indexes @param vertices Vertex array diff --git a/src/MeshTools/Interleave.h b/src/MeshTools/Interleave.h index aa1de8558..3c7408e52 100644 --- a/src/MeshTools/Interleave.h +++ b/src/MeshTools/Interleave.h @@ -96,10 +96,6 @@ class Interleave { } #endif -/** @addtogroup mesh - * @{ - */ - /** @brief %Interleave vertex attributes @param attribute First attribute array @@ -157,8 +153,6 @@ template inline void interleave(Mesh* mesh, Buffer* buffer, Buffer:: return Implementation::Interleave()(mesh, buffer, usage, attributes...); } -/*@}*/ - }} #endif diff --git a/src/MeshTools/Subdivide.h b/src/MeshTools/Subdivide.h index 7dad9a0b7..ab2c27dc8 100644 --- a/src/MeshTools/Subdivide.h +++ b/src/MeshTools/Subdivide.h @@ -84,7 +84,7 @@ template class Subdivide { } #endif -/** @ingroup mesh +/** @brief %Subdivide the mesh @tparam Vertex Vertex data type @tparam Interpolator See `interpolator` function parameter diff --git a/src/MeshTools/Tipsify.h b/src/MeshTools/Tipsify.h index 58e2425e8..d43f4e926 100644 --- a/src/MeshTools/Tipsify.h +++ b/src/MeshTools/Tipsify.h @@ -51,7 +51,7 @@ class MESHTOOLS_EXPORT Tipsify { } #endif -/** @ingroup mesh +/** @brief %Tipsify the mesh @param[in,out] indices Indices array to operate on @param[in] vertexCount Vertex count diff --git a/src/Primitives/Capsule.h b/src/Primitives/Capsule.h index 79c715231..3923beba1 100644 --- a/src/Primitives/Capsule.h +++ b/src/Primitives/Capsule.h @@ -23,7 +23,7 @@ namespace Magnum { namespace Primitives { -/** @ingroup mesh +/** @brief %Capsule primitive Cylinder along Y axis with hemispheres instead of caps. diff --git a/src/Primitives/Cube.h b/src/Primitives/Cube.h index 0a7864b91..bacc1829c 100644 --- a/src/Primitives/Cube.h +++ b/src/Primitives/Cube.h @@ -23,9 +23,7 @@ namespace Magnum { namespace Primitives { -/** @ingroup mesh -@brief %Cube primitive -*/ +/** @brief %Cube primitive */ class Cube: public Trade::MeshData { public: /** @brief Constructor */ diff --git a/src/Primitives/Icosphere.h b/src/Primitives/Icosphere.h index 7ce808846..5cd011e03 100644 --- a/src/Primitives/Icosphere.h +++ b/src/Primitives/Icosphere.h @@ -27,7 +27,7 @@ namespace Magnum { namespace Primitives { template class Icosphere; -/** @ingroup mesh +/** @brief %Icosphere primitive with zero subdivisions @todo Use own computed (and more precise) icosahedron data, not these stolen @@ -39,7 +39,7 @@ template<> class Icosphere<0>: public Trade::MeshData { Icosphere(); }; -/** @ingroup mesh +/** * @brief %Icosphere primitive * @tparam subdivisions Number of subdivisions */ diff --git a/src/Primitives/Plane.h b/src/Primitives/Plane.h index dffe9ce4e..d21eee942 100644 --- a/src/Primitives/Plane.h +++ b/src/Primitives/Plane.h @@ -23,7 +23,7 @@ namespace Magnum { namespace Primitives { -/** @ingroup mesh +/** @brief %Plane primitive 2x2 plane with normals in positive Z direction. diff --git a/src/Primitives/UVSphere.h b/src/Primitives/UVSphere.h index 6f50caee4..4e6be3b63 100644 --- a/src/Primitives/UVSphere.h +++ b/src/Primitives/UVSphere.h @@ -23,9 +23,7 @@ namespace Magnum { namespace Primitives { -/** @ingroup mesh -@brief UV Sphere primitive -*/ +/** @brief UV Sphere primitive */ class UVSphere: public Capsule { public: /** diff --git a/src/Query.h b/src/Query.h index 38d4d1cf1..32413b2bf 100644 --- a/src/Query.h +++ b/src/Query.h @@ -24,10 +24,6 @@ namespace Magnum { #ifndef MAGNUM_TARGET_GLES -/** @addtogroup rendering - * @{ - */ - /** @brief Base class for queries @@ -301,7 +297,6 @@ class TimeQuery: public AbstractQuery { } }; -/*@}*/ #endif } diff --git a/src/Renderbuffer.h b/src/Renderbuffer.h index 3a9d14145..35854aba3 100644 --- a/src/Renderbuffer.h +++ b/src/Renderbuffer.h @@ -23,7 +23,7 @@ namespace Magnum { -/** @ingroup textures +/** @brief %Renderbuffer Attachable to Framebuffer as render target. diff --git a/src/SceneGraph/Camera.h b/src/SceneGraph/Camera.h index 47be24edb..308a0d99a 100644 --- a/src/SceneGraph/Camera.h +++ b/src/SceneGraph/Camera.h @@ -28,7 +28,7 @@ namespace Magnum { namespace SceneGraph { -/** @ingroup scene +/** @brief %Camera object */ class SCENEGRAPH_EXPORT Camera: public Object { diff --git a/src/SceneGraph/Light.h b/src/SceneGraph/Light.h index 8a902b699..57ae9e083 100644 --- a/src/SceneGraph/Light.h +++ b/src/SceneGraph/Light.h @@ -23,7 +23,7 @@ namespace Magnum { namespace SceneGraph { -/** @ingroup scene +/** * @brief Basic light object * * Provides cached light position. diff --git a/src/SceneGraph/Object.h b/src/SceneGraph/Object.h index 66280e729..5ddb2c2f3 100644 --- a/src/SceneGraph/Object.h +++ b/src/SceneGraph/Object.h @@ -40,7 +40,7 @@ class Camera; not needed) */ -/** @ingroup scene +/** * @brief Base for all positioned objects * * @todo Transform transformation when changing parent, so the object stays in diff --git a/src/SceneGraph/Scene.h b/src/SceneGraph/Scene.h index 13b504ee4..63cedc905 100644 --- a/src/SceneGraph/Scene.h +++ b/src/SceneGraph/Scene.h @@ -23,9 +23,7 @@ namespace Magnum { namespace SceneGraph { -/** @ingroup scene -@brief %Scene -*/ +/** @brief %Scene */ class SCENEGRAPH_EXPORT Scene: public Object { public: /** @brief Constructor */ diff --git a/src/Shader.h b/src/Shader.h index 4b5639604..cdb19b456 100644 --- a/src/Shader.h +++ b/src/Shader.h @@ -26,7 +26,7 @@ namespace Magnum { -/** @ingroup rendering +/** * @brief %Shader * * Allows loading and compiling the shader from file or directly from source diff --git a/src/Shaders/PhongShader.h b/src/Shaders/PhongShader.h index 119676cc4..ceb79af6b 100644 --- a/src/Shaders/PhongShader.h +++ b/src/Shaders/PhongShader.h @@ -24,7 +24,7 @@ namespace Magnum { namespace Shaders { -/** @ingroup rendering +/** @brief Phong shader @requires_gl33 The shader is written in GLSL 3.3, although it should be trivial diff --git a/src/SizeTraits.h b/src/SizeTraits.h index dfa19ec28..5b156c576 100644 --- a/src/SizeTraits.h +++ b/src/SizeTraits.h @@ -23,10 +23,6 @@ namespace Magnum { -/** @addtogroup utility - * @{ - */ - /** @brief Traits class providing suitable types for given data sizes @tparam byte Highest byte needed (counting from zero) @@ -175,8 +171,6 @@ template struct Log { }; #endif -/*@}*/ - } #endif diff --git a/src/Texture.h b/src/Texture.h index b36bfa049..7bb9e33b3 100644 --- a/src/Texture.h +++ b/src/Texture.h @@ -23,10 +23,6 @@ namespace Magnum { -/** @addtogroup textures - * @{ - */ - /** @brief %Texture @@ -189,8 +185,6 @@ typedef Texture<2> Texture2D; typedef Texture<3> Texture3D; #endif -/*@}*/ - } #endif diff --git a/src/TypeTraits.h b/src/TypeTraits.h index 31dd42f93..3e95eec12 100644 --- a/src/TypeTraits.h +++ b/src/TypeTraits.h @@ -23,10 +23,6 @@ namespace Magnum { -/** @addtogroup utility - * @{ - */ - /** @brief Traits class for plain OpenGL types @@ -148,8 +144,6 @@ struct MAGNUM_EXPORT TypeInfo { /** @todo Other texture types, referenced in glTexImage2D function manual */ /** @todo Using Vector3 for textures? */ -/*@}*/ - #ifndef DOXYGEN_GENERATING_OUTPUT template<> struct TypeOf { typedef GLubyte Type; }; template<> struct TypeOf { typedef GLbyte Type; };