From 09acfa711fbbe42de758d825f31d62ff16ec93ec Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vladim=C3=ADr=20Vondru=C5=A1?= Date: Tue, 22 May 2012 14:30:57 +0200 Subject: [PATCH] Documented directories containing various namespaces. --- doc/namespaces.dox | 47 ++++++++++++++++++++++++++++++++++++ src/Magnum.h | 6 ----- src/Math/Math.h | 9 +------ src/Trade/AbstractImporter.h | 10 +------- 4 files changed, 49 insertions(+), 23 deletions(-) diff --git a/doc/namespaces.dox b/doc/namespaces.dox index cd280e901..42355a40f 100644 --- a/doc/namespaces.dox +++ b/doc/namespaces.dox @@ -1,30 +1,77 @@ +/** @dir magnum + * @brief %Magnum library + */ +/** @dir magnum/src + * @brief Namespace Magnum + */ +/** @namespace Magnum +@brief Root namespace + +Contains classes needed for building meshes, setting up and rendering the +scene. +*/ + +/** @dir Math + * @brief Namespace Magnum::Math + */ +/** @namespace Magnum::Math +@brief %Math library + +Template classes for matrix and vector calculations. +*/ + +/** @dir Math/Geometry + * @brief Namespace Magnum::Math::Geometry + */ /** @namespace Magnum::Math::Geometry @brief %Geometry library Functions for computing intersections, distances, areas and volumes. */ +/** @dir MeshTools + * @brief Namespace Magnum::MeshTools + */ /** @namespace Magnum::MeshTools @brief %Mesh tools Tools for generating, optimizing and cleaning meshes. */ +/** @dir Primitives + * @brief Namespace Magnum::Primitives + */ /** @namespace Magnum::Primitives @brief Primitive library Basic primitives for testing purposes. */ +/** @dir Shaders + * @brief Namespace Magnum::Shaders + */ /** @namespace Magnum::Shaders @brief Sample shaders Collection of shaders for testing purposes. */ +/** @dir Physics + * @brief Namespace Magnum::Physics + */ /** @namespace Magnum::Physics @brief %Physics library Collision detection system and rigid body objects. See @ref CollisionDetection for introduction. */ + +/** @dir Trade + * @brief Namespace Magnum::Trade + */ +/** @namespace Magnum::Trade +@brief Data format exchange + +Contains plugin interfaces for importing data of various formats and classes +for direct access to the data. +*/ diff --git a/src/Magnum.h b/src/Magnum.h index 4c7d3f26a..a0595dd05 100644 --- a/src/Magnum.h +++ b/src/Magnum.h @@ -25,12 +25,6 @@ #include "Math/Matrix4.h" #include "Math/Vector2.h" -/** - * @brief Root namespace - * - * Contains classes needed for building meshes, setting up and rendering the - * scene. - */ namespace Magnum { /** @brief Two-component floating-point vector */ diff --git a/src/Math/Math.h b/src/Math/Math.h index 78b927730..7bb42119b 100644 --- a/src/Math/Math.h +++ b/src/Math/Math.h @@ -23,7 +23,7 @@ * @brief Math constants and utilities */ -namespace Magnum { +namespace Magnum { namespace Math { /** @todo Quaternions: @@ -32,13 +32,6 @@ namespace Magnum { matrices) */ -/** - * @brief %Math library - * - * Template classes for matrix and vector calculations. -*/ -namespace Math { - /** @brief Numeric constants */ template struct Constants { #ifdef DOXYGEN_GENERATING_OUTPUT diff --git a/src/Trade/AbstractImporter.h b/src/Trade/AbstractImporter.h index 93e28c5a6..dea239f6a 100644 --- a/src/Trade/AbstractImporter.h +++ b/src/Trade/AbstractImporter.h @@ -22,15 +22,7 @@ #include "PluginManager/Plugin.h" #include "ImageData.h" -namespace Magnum { - -/** -@brief Data format exchange - -Contains plugin interfaces for importing data of various formats and classes -for direct access to the data. -*/ -namespace Trade { +namespace Magnum { namespace Trade { class AbstractMaterialData; class CameraData;