Browse Source

Documented directories containing various namespaces.

vectorfields
Vladimír Vondruš 14 years ago
parent
commit
09acfa711f
  1. 47
      doc/namespaces.dox
  2. 6
      src/Magnum.h
  3. 9
      src/Math/Math.h
  4. 10
      src/Trade/AbstractImporter.h

47
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 /** @namespace Magnum::Math::Geometry
@brief %Geometry library @brief %Geometry library
Functions for computing intersections, distances, areas and volumes. Functions for computing intersections, distances, areas and volumes.
*/ */
/** @dir MeshTools
* @brief Namespace Magnum::MeshTools
*/
/** @namespace Magnum::MeshTools /** @namespace Magnum::MeshTools
@brief %Mesh tools @brief %Mesh tools
Tools for generating, optimizing and cleaning meshes. Tools for generating, optimizing and cleaning meshes.
*/ */
/** @dir Primitives
* @brief Namespace Magnum::Primitives
*/
/** @namespace Magnum::Primitives /** @namespace Magnum::Primitives
@brief Primitive library @brief Primitive library
Basic primitives for testing purposes. Basic primitives for testing purposes.
*/ */
/** @dir Shaders
* @brief Namespace Magnum::Shaders
*/
/** @namespace Magnum::Shaders /** @namespace Magnum::Shaders
@brief Sample shaders @brief Sample shaders
Collection of shaders for testing purposes. Collection of shaders for testing purposes.
*/ */
/** @dir Physics
* @brief Namespace Magnum::Physics
*/
/** @namespace Magnum::Physics /** @namespace Magnum::Physics
@brief %Physics library @brief %Physics library
Collision detection system and rigid body objects. See @ref CollisionDetection Collision detection system and rigid body objects. See @ref CollisionDetection
for introduction. 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.
*/

6
src/Magnum.h

@ -25,12 +25,6 @@
#include "Math/Matrix4.h" #include "Math/Matrix4.h"
#include "Math/Vector2.h" #include "Math/Vector2.h"
/**
* @brief Root namespace
*
* Contains classes needed for building meshes, setting up and rendering the
* scene.
*/
namespace Magnum { namespace Magnum {
/** @brief Two-component floating-point vector */ /** @brief Two-component floating-point vector */

9
src/Math/Math.h

@ -23,7 +23,7 @@
* @brief Math constants and utilities * @brief Math constants and utilities
*/ */
namespace Magnum { namespace Magnum { namespace Math {
/** /**
@todo Quaternions: @todo Quaternions:
@ -32,13 +32,6 @@ namespace Magnum {
matrices) matrices)
*/ */
/**
* @brief %Math library
*
* Template classes for matrix and vector calculations.
*/
namespace Math {
/** @brief Numeric constants */ /** @brief Numeric constants */
template<class T> struct Constants { template<class T> struct Constants {
#ifdef DOXYGEN_GENERATING_OUTPUT #ifdef DOXYGEN_GENERATING_OUTPUT

10
src/Trade/AbstractImporter.h

@ -22,15 +22,7 @@
#include "PluginManager/Plugin.h" #include "PluginManager/Plugin.h"
#include "ImageData.h" #include "ImageData.h"
namespace Magnum { namespace Magnum { namespace Trade {
/**
@brief Data format exchange
Contains plugin interfaces for importing data of various formats and classes
for direct access to the data.
*/
namespace Trade {
class AbstractMaterialData; class AbstractMaterialData;
class CameraData; class CameraData;

Loading…
Cancel
Save