diff --git a/Doxyfile b/Doxyfile index 8e5f297f0..96efd5ee1 100644 --- a/Doxyfile +++ b/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 diff --git a/doc/MainPage.dox b/doc/MainPage.dox new file mode 100644 index 000000000..b46a1f607 --- /dev/null +++ b/doc/MainPage.dox @@ -0,0 +1,22 @@ +/** @mainpage + +
%Magnum is simple graphical engine written in C++11 and OpenGL 3 Core Profile. Features:
+%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.
+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".
+Basic usage examples are in examples/ subdirectory.
+*/ diff --git a/doc/namespaces.dox b/doc/namespaces.dox new file mode 100644 index 000000000..e73f42ea2 --- /dev/null +++ b/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. +*/ diff --git a/src/Math/Vector2.h b/src/Math/Vector2.h index 1b234580a..7a6c27c2d 100644 --- a/src/Math/Vector2.h +++ b/src/Math/Vector2.h @@ -23,7 +23,7 @@ namespace Magnum { namespace Math { -/** @brief Vector (three-component) */ +/** @brief Vector (two-component) */ template