ic
/
magnum
mirror of https://github.com/mosra/magnum.git
6
0
Fork 0
Code Issues Projects Releases Wiki Activity
Browse Source

Doc++

pull/342/head
Vladimír Vondruš 7 years ago
parent
e4db99b418
commit
f419b25763
6 changed files with 39 additions and 39 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Split View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 10
      src/Magnum/GL/Renderer.h
  2. 2
      src/Magnum/Mesh.h
  3. 4
      src/Magnum/SceneGraph/FeatureGroup.h
  4. 20
      src/Magnum/SceneGraph/MatrixTransformation2D.h
  5. 32
      src/Magnum/SceneGraph/MatrixTransformation3D.h
  6. 10
      src/Magnum/SceneGraph/Object.h

10
src/Magnum/GL/Renderer.h
Unescape View File

@ -45,7 +45,7 @@ namespace Magnum { namespace GL {
namespace Implementation { struct RendererState; }
/** @nosubgrouping
@brief Global renderer configuration.
@brief Global renderer configuration
@todo @gl_extension{ARB,viewport_array}
@todo `GL_POINT_SIZE_GRANULARITY`, `GL_POINT_SIZE_RANGE` (?)
@ -77,7 +77,7 @@ class MAGNUM_GL_EXPORT Renderer {
/** @{ @name Renderer features */
/**
* @brief Features
* @brief Feature
*
* All features are disabled by default unless specified otherwise.
* @see @ref enable(), @ref disable(), @ref setFeature()
@ -317,21 +317,21 @@ class MAGNUM_GL_EXPORT Renderer {
static Range1D lineWidthRange();
/**
* @brief Enable feature
* @brief Enable a feature
*
* @see @ref disable(), @ref setFeature(), @fn_gl_keyword{Enable}
*/
static void enable(Feature feature);
/**
* @brief Disable feature
* @brief Disable a feature
*
* @see @ref enable(), @ref setFeature(), @fn_gl_keyword{Disable}
*/
static void disable(Feature feature);
/**
* @brief Enable or disable feature
* @brief Enable or disable a feature
*
* Convenience equivalent to the following:
*

2
src/Magnum/Mesh.h
Unescape View File

@ -114,7 +114,7 @@ enum class MeshPrimitive: UnsignedInt {
MAGNUM_EXPORT Debug& operator<<(Debug& debug, MeshPrimitive value);
/**
@brief Mesh primitive type
@brief Mesh index type
In case of OpenGL, corresponds to @ref GL::MeshIndexType and is convertible to
it using @ref GL::meshIndexType(). See documentation of each value for more

4
src/Magnum/SceneGraph/FeatureGroup.h
Unescape View File

@ -95,7 +95,7 @@ template<UnsignedInt dimensions, class Feature, class T> class FeatureGroup: pub
}
/**
* @brief Add feature to the group
* @brief Add a feature to the group
* @return Reference to self (for method chaining)
*
* If the features is part of another group, it is removed from it.
@ -104,7 +104,7 @@ template<UnsignedInt dimensions, class Feature, class T> class FeatureGroup: pub
FeatureGroup<dimensions, Feature, T>& add(Feature& feature);
/**
* @brief Remove feature from the group
* @brief Remove a feature from the group
* @return Reference to self (for method chaining)
*
* The feature must be part of the group.

20
src/Magnum/SceneGraph/MatrixTransformation2D.h
Unescape View File

@ -67,7 +67,7 @@ template<class T> class BasicMatrixTransformation2D: public AbstractBasicTransla
}
/**
* @brief Transform object
* @brief Transform the object
* @return Reference to self (for method chaining)
*
* @see @ref transformLocal()
@ -77,7 +77,7 @@ template<class T> class BasicMatrixTransformation2D: public AbstractBasicTransla
}
/**
* @brief Transform object as a local transformation
* @brief Transform the object as a local transformation
*
* Similar to the above, except that the transformation is applied
* before all others.
@ -92,7 +92,7 @@ template<class T> class BasicMatrixTransformation2D: public AbstractBasicTransla
}
/**
* Translate object
* Translate the object
* @return Reference to self (for method chaining)
*
* Same as calling @ref transform() with @ref Math::Matrix3::translation().
@ -104,7 +104,7 @@ template<class T> class BasicMatrixTransformation2D: public AbstractBasicTransla
}
/**
* @brief Translate object as a local transformation
* @brief Translate the object as a local transformation
*
* Similar to the above, except that the transformation is applied
* before all others. Same as calling @ref transformLocal() with
@ -115,7 +115,7 @@ template<class T> class BasicMatrixTransformation2D: public AbstractBasicTransla
}
/**
* @brief Rotate object
* @brief Rotate the object
* @param angle Angle (counterclockwise)
* @return Reference to self (for method chaining)
*
@ -127,7 +127,7 @@ template<class T> class BasicMatrixTransformation2D: public AbstractBasicTransla
}
/**
* @brief Rotate object as a local transformation
* @brief Rotate the object as a local transformation
*
* Similar to the above, except that the transformation is applied
* before all others. Same as calling @ref transformLocal() with
@ -138,7 +138,7 @@ template<class T> class BasicMatrixTransformation2D: public AbstractBasicTransla
}
/**
* @brief Scale object
* @brief Scale the object
* @return Reference to self (for method chaining)
*
* Same as calling @ref transform() with @ref Math::Matrix3::scaling().
@ -150,7 +150,7 @@ template<class T> class BasicMatrixTransformation2D: public AbstractBasicTransla
}
/**
* @brief Scale object as a local transformation
* @brief Scale the object as a local transformation
*
* Similar to the above, except that the transformation is applied
* before all others. Same as calling @ref transformLocal() with
@ -161,7 +161,7 @@ template<class T> class BasicMatrixTransformation2D: public AbstractBasicTransla
}
/**
* @brief Reflect object
* @brief Reflect the object
* @param normal Normal of the line through which to reflect
* (normalized)
* @return Reference to self (for method chaining)
@ -175,7 +175,7 @@ template<class T> class BasicMatrixTransformation2D: public AbstractBasicTransla
}
/**
* @brief Reflect object as a local transformation
* @brief Reflect the object as a local transformation
*
* Similar to the above, except that the transformation is applied
* before all others. Same as calling @ref transformLocal() with

32
src/Magnum/SceneGraph/MatrixTransformation3D.h
Unescape View File

@ -72,7 +72,7 @@ template<class T> class BasicMatrixTransformation3D: public AbstractBasicTransla
}
/**
* @brief Transform object
* @brief Transform the object
* @return Reference to self (for method chaining)
*
* @see @ref transformLocal()
@ -82,7 +82,7 @@ template<class T> class BasicMatrixTransformation3D: public AbstractBasicTransla
}
/**
* @brief Transform object as a local transformation
* @brief Transform the object as a local transformation
*
* Similar to the above, except that the transformation is applied
* before all others.
@ -92,7 +92,7 @@ template<class T> class BasicMatrixTransformation3D: public AbstractBasicTransla
}
/**
* @brief Translate object
* @brief Translate the object
* @return Reference to self (for method chaining)
*
* Same as calling @ref transform() with @ref Math::Matrix4::translation().
@ -104,7 +104,7 @@ template<class T> class BasicMatrixTransformation3D: public AbstractBasicTransla
}
/**
* @brief Translate object as a local transformation
* @brief Translate the object as a local transformation
*
* Similar to the above, except that the transformation is applied
* before all others. Same as calling @ref transformLocal() with
@ -115,7 +115,7 @@ template<class T> class BasicMatrixTransformation3D: public AbstractBasicTransla
}
/**
* @brief Rotate object
* @brief Rotate the object
* @param angle Angle (counterclockwise)
* @param normalizedAxis Normalized rotation axis
* @return Reference to self (for method chaining)
@ -130,7 +130,7 @@ template<class T> class BasicMatrixTransformation3D: public AbstractBasicTransla
}
/**
* @brief Rotate object as a local transformation
* @brief Rotate the object as a local transformation
*
* Similar to the above, except that the transformation is applied
* before all others. Same as calling @ref transformLocal() with
@ -141,7 +141,7 @@ template<class T> class BasicMatrixTransformation3D: public AbstractBasicTransla
}
/**
* @brief Rotate object around X axis
* @brief Rotate the object around X axis
* @param angle Angle (counterclockwise)
* @return Reference to self (for method chaining)
*
@ -153,7 +153,7 @@ template<class T> class BasicMatrixTransformation3D: public AbstractBasicTransla
}
/**
* @brief Rotate object around X axis as a local transformation
* @brief Rotate the object around X axis as a local transformation
*
* Similar to the above, except that the transformation is applied
* before all others. Same as calling @ref transformLocal() with
@ -164,7 +164,7 @@ template<class T> class BasicMatrixTransformation3D: public AbstractBasicTransla
}
/**
* @brief Rotate object around Y axis
* @brief Rotate the object around Y axis
* @param angle Angle (counterclockwise)
* @return Reference to self (for method chaining)
*
@ -176,7 +176,7 @@ template<class T> class BasicMatrixTransformation3D: public AbstractBasicTransla
}
/**
* @brief Rotate object around Y axis as a local transformation
* @brief Rotate the object around Y axis as a local transformation
*
* Similar to the above, except that the transformation is applied
* before all others. Same as calling @ref transformLocal() with
@ -187,7 +187,7 @@ template<class T> class BasicMatrixTransformation3D: public AbstractBasicTransla
}
/**
* @brief Rotate object around Z axis
* @brief Rotate the object around Z axis
* @param angle Angle (counterclockwise)
* @return Reference to self (for method chaining)
*
@ -199,7 +199,7 @@ template<class T> class BasicMatrixTransformation3D: public AbstractBasicTransla
}
/**
* @brief Rotate object around Z axis as a local transformation
* @brief Rotate the object around Z axis as a local transformation
*
* Similar to the above, except that the transformation is applied
* before all others. Same as calling @ref transformLocal() with
@ -210,7 +210,7 @@ template<class T> class BasicMatrixTransformation3D: public AbstractBasicTransla
}
/**
* @brief Scale object
* @brief Scale the object
* @return Reference to self (for method chaining)
*
* Same as calling @ref transform() with @ref Math::Matrix4::scaling().
@ -222,7 +222,7 @@ template<class T> class BasicMatrixTransformation3D: public AbstractBasicTransla
}
/**
* @brief Scale object as a local transformation
* @brief Scale the object as a local transformation
*
* Similar to the above, except that the transformation is applied
* before all others. Same as calling @ref transformLocal() with
@ -233,7 +233,7 @@ template<class T> class BasicMatrixTransformation3D: public AbstractBasicTransla
}
/**
* @brief Reflect object
* @brief Reflect the object
* @param normal Normal of the plane through which to reflect
* (normalized)
* @return Reference to self (for method chaining)
@ -246,7 +246,7 @@ template<class T> class BasicMatrixTransformation3D: public AbstractBasicTransla
}
/**
* @brief Reflect object as a local transformation
* @brief Reflect the object as a local transformation
*
* Similar to the above, except that the transformation is applied
* before all others. Same as calling @ref transformLocal() with

10
src/Magnum/SceneGraph/Object.h
Unescape View File

@ -143,7 +143,7 @@ template<class Transformation> class Object: public AbstractObject<Transformatio
Scene<Transformation>* scene();
const Scene<Transformation>* scene() const; /**< @overload */
/** @brief Parent object or `nullptr`, if this is root object */
/** @brief Parent object or `nullptr`, if this is the root object */
Object<Transformation>* parent() {
return Containers::LinkedListItem<Object<Transformation>, Object<Transformation>>::list();
}
@ -153,7 +153,7 @@ template<class Transformation> class Object: public AbstractObject<Transformatio
return Containers::LinkedListItem<Object<Transformation>, Object<Transformation>>::list();
}
/** @brief Previous sibling object or `nullptr`, if this is first object */
/** @brief Previous sibling object or `nullptr`, if this is the first object */
Object<Transformation>* previousSibling() {
return Containers::LinkedListItem<Object<Transformation>, Object<Transformation>>::previous();
}
@ -163,7 +163,7 @@ template<class Transformation> class Object: public AbstractObject<Transformatio
return Containers::LinkedListItem<Object<Transformation>, Object<Transformation>>::previous();
}
/** @brief Next sibling object or `nullptr`, if this is last object */
/** @brief Next sibling object or `nullptr`, if this is the last object */
Object<Transformation>* nextSibling() {
return Containers::LinkedListItem<Object<Transformation>, Object<Transformation>>::next();
}
@ -230,7 +230,7 @@ template<class Transformation> class Object: public AbstractObject<Transformatio
}
/**
* @brief Transformation matrix relative to root object
* @brief Transformation matrix relative to the root object
*
* @see @ref absoluteTransformation()
*/
@ -239,7 +239,7 @@ template<class Transformation> class Object: public AbstractObject<Transformatio
}
/**
* @brief Transformation relative to root object
* @brief Transformation relative to the root object
*
* @see @ref absoluteTransformationMatrix()
*/

Write Preview
Loading…
Cancel
Save