Browse Source

DebugTools: doc++

pull/23/head
Vladimír Vondruš 13 years ago
parent
commit
fb6f6e47f6
  1. 4
      src/DebugTools/ForceRenderer.h
  2. 4
      src/DebugTools/ObjectRenderer.h
  3. 4
      src/DebugTools/ShapeRenderer.h

4
src/DebugTools/ForceRenderer.h

@ -40,7 +40,7 @@ namespace Magnum { namespace DebugTools {
/**
@brief Force renderer options
See ForceRenderer documentation for more information.
See @ref ForceRenderer documentation for more information.
*/
class ForceRendererOptions {
public:
@ -99,7 +99,7 @@ Vector3 force;
new DebugTools::ForceRenderer2D(object, {0.3f, 1.5f, -0.7f}, &force, "my", debugDrawables);
@endcode
@see ForceRenderer2D, ForceRenderer3D
@see @ref ForceRenderer2D, @ref ForceRenderer3D, @ref ForceRendererOptions
*/
template<UnsignedInt dimensions> class MAGNUM_DEBUGTOOLS_EXPORT ForceRenderer: public SceneGraph::Drawable<dimensions, Float> {
public:

4
src/DebugTools/ObjectRenderer.h

@ -39,7 +39,7 @@ namespace Magnum { namespace DebugTools {
/**
@brief Object renderer options
See ObjectRenderer documentation for more information.
See @ref ObjectRenderer documentation for more information.
*/
class ObjectRendererOptions {
public:
@ -81,7 +81,7 @@ Object3D* object;
new DebugTools::ObjectRenderer2D(object, "my", debugDrawables);
@endcode
@see ObjectRenderer2D, ObjectRenderer3D
@see @ref ObjectRenderer2D, @ref ObjectRenderer3D, @ref ObjectRendererOptions
*/
template<UnsignedInt dimensions> class MAGNUM_DEBUGTOOLS_EXPORT ObjectRenderer: public SceneGraph::Drawable<dimensions, Float> {
public:

4
src/DebugTools/ShapeRenderer.h

@ -49,7 +49,7 @@ namespace Implementation {
/**
@brief Shape renderer options
See ShapeRenderer documentation for more information.
See @ref ShapeRenderer documentation for more information.
*/
class ShapeRendererOptions {
public:
@ -133,7 +133,7 @@ Shapes::AbstractShape2D* shape;
new DebugTools::ShapeRenderer2D(shape, "red", debugDrawables);
@endcode
@see ShapeRenderer2D, ShapeRenderer3D
@see @ref ShapeRenderer2D, @ref ShapeRenderer3D, @ref ShapeRendererOptions
*/
template<UnsignedInt dimensions> class MAGNUM_DEBUGTOOLS_EXPORT ShapeRenderer: public SceneGraph::Drawable<dimensions, Float> {
friend void Implementation::createDebugMesh<>(ShapeRenderer<dimensions>&, const Shapes::Implementation::AbstractShape<dimensions>&);

Loading…
Cancel
Save