Browse Source

Doc++

Removed doc/namespaces.dox, moved namespace documentation to main files
of given namespace.
vectorfields
Vladimír Vondruš 15 years ago
parent
commit
e0b4fca4fe
  1. 6
      doc/MainPage.dox
  2. 11
      doc/namespaces.dox
  3. 2
      src/Camera.h
  4. 6
      src/Magnum.h
  5. 9
      src/Math/Math.h
  6. 5
      src/Primitives/AbstractPrimitive.h
  7. 2
      src/Primitives/Icosphere.h

6
doc/MainPage.dox

@ -4,8 +4,10 @@ namespace Magnum {
<p><strong>%Magnum</strong> is simple graphical engine written in C++11 and OpenGL 3 Core Profile. Features:</p>
<ul>
<li>Easy-to-use templated @ref Math "mathematical library" for matrix/vector calculations.</li>
<li>Hierarchical @ref Scene "scene graph" which supports transformation caching for better performance.</li>
<li>Classes for convenient usage of @ref AbstractShaderProgram "shaders", @ref Buffer "buffers" and @ref Texture "textures".</li>
<li>Comprehensive use of C++11 features for security, performance and ease of development.</li>
<li>Hierarchical @ref Scene "scene graph" which supports transformation caching for better performance, classes for convenient usage of @ref AbstractShaderProgram "shaders", @ref Buffer "buffers" and @ref Texture "textures".</li>
<li>@ref MeshTools "Mesh tools" for cleaning, optimizing and generating meshes.</li>
<li>Collection of pre-made @ref Primitives "graphic primitives" for testing purposes.</li>
</ul>
@section BasicUsage Basic usage

11
doc/namespaces.dox

@ -1,11 +0,0 @@
/** @namespace Magnum
@brief Root namespace
Contains classes needed for building meshes, setting up and rendering the scene.
*/
/** @namespace Magnum::Math
@brief Math library
Template classes for matrix and vector calculations.
*/

2
src/Camera.h

@ -120,7 +120,7 @@ class Camera: public Object {
*/
void setViewport(const Math::Vector2<unsigned int>& size);
/** @copydoc setViewport(const Math::Vector2<size_t>& size); */
/** @copydoc setViewport(const Math::Vector2<unsigned int>& size); */
inline void setViewport(unsigned int width, unsigned int height) {
setViewport({width, height});
}

6
src/Magnum.h

@ -24,6 +24,12 @@
#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 */

9
src/Math/Math.h

@ -21,7 +21,14 @@
* @brief Math constants and utilities
*/
namespace Magnum { namespace Math {
namespace Magnum {
/**
* @brief %Math library
*
* Template classes for matrix and vector calculations.
*/
namespace Math {
/** @brief Pi */
#define PI 3.1415926535

5
src/Primitives/AbstractPrimitive.h

@ -28,6 +28,11 @@ namespace Magnum {
class Buffer;
class IndexedMesh;
/**
* @brief %Primitive library
*
* Basic primitives usable for testing.
*/
namespace Primitives {
/**

2
src/Primitives/Icosphere.h

@ -16,7 +16,7 @@
*/
/** @file
* @brief Class Magnum::Primitives::Icosphere
* @brief Class Magnum::Primitives::Icosahedron, Magnum::Primitives::Icosphere
*/
#include "AbstractPrimitive.h"

Loading…
Cancel
Save