Browse Source

Doc++

pull/51/head
Vladimír Vondruš 12 years ago
parent
commit
e5c366c6af
  1. 6
      doc/matrix-vector.dox
  2. 6
      doc/portability.dox
  3. 2
      src/Magnum/Magnum.h
  4. 3
      src/Magnum/Math/Vector.h

6
doc/matrix-vector.dox

@ -258,9 +258,9 @@ Matrix4x3 e = b*d;
@section matrix-vector-componentwise Component-wise and inter-vector operations @section matrix-vector-componentwise Component-wise and inter-vector operations
As shown above, vectors can be added and multiplied component-wise using the As shown above, vectors can be added and multiplied component-wise using the
`+` or `*` operator. You can use @ref Vector::sum() "sum()" and `+` or `*` operator. You can use @ref Math::Vector::sum() "sum()" and
@ref Vector::product() "product()" for sum or product of components in one @ref Math::Vector::product() "product()" for sum or product of components in
vector: one vector:
@code @code
Float a = Vector3{1.5f, 0.3f, 8.0f}.sum(); // 8.8f Float a = Vector3{1.5f, 0.3f, 8.0f}.sum(); // 8.8f
Int b = Vector3i{32, -5, 7}.product() // 1120 Int b = Vector3i{32, -5, 7}.product() // 1120

6
doc/portability.dox

@ -57,7 +57,7 @@ Renderer::setPolygonMode(Renderer::PolygonMode::Lines);
Each feature is marked accordingly if it is not available in some targets. See Each feature is marked accordingly if it is not available in some targets. See
also @ref requires-gl, @ref requires-gles20 and @ref requires-gles30. also @ref requires-gl, @ref requires-gles20 and @ref requires-gles30.
@section portability-compiler Compiler-specific code @section portability-compiler Compiler- and platform-specific code
%Magnum is attempting to be future-proof and as intuitive for users as %Magnum is attempting to be future-proof and as intuitive for users as
possible. Many features from C++11 are used to simplify things and make them possible. Many features from C++11 are used to simplify things and make them
@ -73,6 +73,10 @@ platform) which compiler your code will support, code written for e.g. GCC 4.6
will work also on Magnum compiled with support for newer compilers, although will work also on Magnum compiled with support for newer compilers, although
newer compilers may catch errors that weren't spotted by earlier versions. newer compilers may catch errors that weren't spotted by earlier versions.
Some functionality (such as dynamic plugin loading or filesystem access) might
not be available on particular platforms. @ref Corrade.h contains defintions
which you can use for platform-aware code.
@section portability-extensions Extension-aware code @section portability-extensions Extension-aware code
Some functionality is depending on support of particular extension and thus Some functionality is depending on support of particular extension and thus

2
src/Magnum/Magnum.h

@ -124,7 +124,7 @@ Defined if the engine is built for OpenGL ES 3.0. Implies also
Defined if the engine is built for OpenGL ES 3.0 or OpenGL ES 2.0 emulated Defined if the engine is built for OpenGL ES 3.0 or OpenGL ES 2.0 emulated
within standard desktop OpenGL. Implies also @ref MAGNUM_TARGET_GLES. within standard desktop OpenGL. Implies also @ref MAGNUM_TARGET_GLES.
@see @ref MAGNUM_TARGET_GLES2, @ref building @see @ref MAGNUM_TARGET_GLES2, @ref MAGNUM_TARGET_GLES3, @ref building
*/ */
#define MAGNUM_TARGET_DESKTOP_GLES #define MAGNUM_TARGET_DESKTOP_GLES
#undef MAGNUM_TARGET_DESKTOP_GLES #undef MAGNUM_TARGET_DESKTOP_GLES

3
src/Magnum/Math/Vector.h

@ -379,7 +379,8 @@ template<std::size_t size, class T> class Vector {
* @brief Multiply vector component-wise * @brief Multiply vector component-wise
* *
* @see operator*(T) const, operator*=(const Vector<size, T>&), * @see operator*(T) const, operator*=(const Vector<size, T>&),
* operator*(const Vector<size, Integral>&, const Vector<size, FloatingPoint>&) * operator*(const Vector<size, Integral>&, const Vector<size, FloatingPoint>&),
* @ref product()
*/ */
Vector<size, T> operator*(const Vector<size, T>& other) const { Vector<size, T> operator*(const Vector<size, T>& other) const {
return Vector<size, T>(*this) *= other; return Vector<size, T>(*this) *= other;

Loading…
Cancel
Save