Doc++

Doxyfile

@@ -466,7 +466,7 @@ SORT_GROUP_NAMES       = NO
 # Note: This option applies only to the class list, not to the
 # alphabetical list.
 
-SORT_BY_SCOPE_NAME     = NO
+SORT_BY_SCOPE_NAME     = YES
 
 # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to
 # do proper type resolution of all parameters of a function it will reject a

doc/MainPage.dox

@@ -0,0 +1,22 @@
+/** @mainpage
+
+<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 Magnum::Math "mathematical library" for matrix/vector calculations.</li>
+<li>Hierarchical @ref Magnum::Scene "scene graph" which supports transformation caching for better performance.</li>
+<li>Classes for convenient usage of @ref Magnum::Shader "shaders", @ref Magnum::Buffer "buffers" and @ref Magnum::Texture "textures".</li>
+</ul>
+
+@section BasicUsage Basic usage
+
+<p>%Scene in %Magnum is composed of hierarchically connected object instances.
+To build the scene, you need @ref Magnum::Scene "Scene" object with assigned
+@ref Magnum::Camera "Camera" and some @ref Magnum::Object "Object" instances.
+When rendering using Magnum::Scene::draw(), the engine goes through all objects
+connected to the scene and calls Magnum::Object::draw() on them.</p>
+<p>All objects are by default empty. To make object renderable in the scene,
+you must reimplement Magnum::Object::draw(), and for example bind an
+@ref Magnum::AbstractShaderProgram "shader", @ref Magnum::Texture "texture" and
+render an prepared @ref Magnum::Mesh "mesh".</p>
+<p>Basic usage examples are in <tt>examples/</tt> subdirectory.</p>
+*/

doc/namespaces.dox

@@ -0,0 +1,11 @@
+/** @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.
+*/

src/Math/Vector2.h

@@ -23,7 +23,7 @@
 
 namespace Magnum { namespace Math {
 
-/** @brief Vector (three-component) */
+/** @brief Vector (two-component) */
 template<class T> class Vector2: public Vector<T, 2> {
     public:
         /** @copydoc Vector::Vector */