From 17ef4da648c955d13f8641e108ee98a3c43bfd92 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vladim=C3=ADr=20Vondru=C5=A1?= Date: Fri, 25 Oct 2013 16:42:20 +0200 Subject: [PATCH] Doc++ --- doc/matrix-vector.dox | 6 +++--- doc/scenegraph.dox | 3 +-- doc/types.dox | 15 ++++++++------- 3 files changed, 12 insertions(+), 12 deletions(-) diff --git a/doc/matrix-vector.dox b/doc/matrix-vector.dox index c5703196a..52c792b04 100644 --- a/doc/matrix-vector.dox +++ b/doc/matrix-vector.dox @@ -169,7 +169,7 @@ Math::Vector<6, Int> w10xyz = swizzle<'w', '1', '0', 'x', 'y', 'z'>(original); / @section matrix-vector-operations Operations with matrices and vectors Vectors can be added, subtracted, negated and multiplied or divided with -scalars, as is common in mathematics, Magnum also adds the ability to divide +scalars, as is common in mathematics, %Magnum also adds the ability to divide scalar with vector: @code Vector3 a(1.0f, 2.0f, 3.0f); @@ -232,8 +232,8 @@ OpenGL matrices are column-major, thus it is reasonable to have matrices in %Magnum also column major (and vectors as columns). This has naturally some implications and it may differ from what is common in mathematics: -- Order of template arguments in specification of RectangularMatrix is also - column-major: +- Order of template arguments in specification of @ref Math::RectangularMatrix + is also column-major: @code Math::RectangularMatrix<2, 3, Int> mat; // two columns, three rows @endcode diff --git a/doc/scenegraph.dox b/doc/scenegraph.dox index 3d59a8849..f97b80bd1 100644 --- a/doc/scenegraph.dox +++ b/doc/scenegraph.dox @@ -60,8 +60,7 @@ won't allow you to scale or shear objects, but are more memory efficient than matrices. It's also possible to implement your own transformation class for specific -needs, see @ref AbstractTransformation-subclassing -"AbstractTransformation documentation" for more information. +needs, see source of other transformation classes for more information. @section scenegraph-hierarchy Scene hierarchy diff --git a/doc/types.dox b/doc/types.dox index 3ddb332a6..f79ab9e6b 100644 --- a/doc/types.dox +++ b/doc/types.dox @@ -30,9 +30,9 @@ namespace Magnum { @section types-builtin Builtin types %Magnum provides typedefs for builtin integral and floating-point arithmetic -types to ensure portability (e.g. Int is *always* 32bit), maintain consistency -and reduce confusion (e.g. `std::int32_t`, `int` and `GLint` all refer to the -same type). +types to ensure portability (e.g. @ref Int is *always* 32bit), maintain +consistency and reduce confusion (e.g. `std::int32_t`, `int` and `GLint` all +refer to the same type). | %Magnum type | Size | Equivalent GLSL type | | ------------------ | -------------- | -------------------- | @@ -52,9 +52,10 @@ types which cannot be directly passed to GLSL shaders (such as `long double`) have no typedefs. Types from the above table are then used to define other types. All following -types are aliases of corresponding types in Math namespace. No suffix after type -name means @ref Float underlying type, `ui` means @ref UnsignedInt underlying -type, `i` is @ref Int underlying type and `d` is for @ref Double underlying type. +types are aliases of corresponding types in @ref Math namespace. No suffix +after type name means @ref Float underlying type, `ui` means @ref UnsignedInt +underlying type, `i` is @ref Int underlying type and `d` is for @ref Double +underlying type. @section types-matrix Matrix/vector types @@ -78,7 +79,7 @@ type, `i` is @ref Int underlying type and `d` is for @ref Double underlying type | @ref Matrix4x3 or @ref Matrix4x3d | `mat4x3` or `dmat4x3` | Any super- or sub-class of the same size and underlying type can be used -equivalently (e.g. Math::Vector or Color3 instead of @ref Vector3). +equivalently (e.g. @ref Math::Vector or @ref Color3 instead of @ref Vector3). @section types-other Other types