Doc++

src/DebugTools/Implementation/BoxRenderer.cpp

@@ -25,6 +25,7 @@ namespace Magnum { namespace DebugTools { namespace Implementation {
 template<std::uint8_t dimensions> BoxRenderer<dimensions>::BoxRenderer(Physics::Box<dimensions>& box): box(box) {}
 
 template<std::uint8_t dimensions> void BoxRenderer<dimensions>::draw(Resource<ShapeRendererOptions>& options, const typename DimensionTraits<dimensions>::MatrixType& projectionMatrix) {
+    /* Half scale, because the box is 2x2(x2) */
     this->shader->setTransformationProjectionMatrix(projectionMatrix*box.transformedTransformation()*
         DimensionTraits<dimensions>::MatrixType::scaling(typename DimensionTraits<dimensions>::VectorType(0.5f)))
         ->setColor(options->color())

src/DebugTools/ObjectRenderer.h

@@ -15,6 +15,10 @@
     GNU Lesser General Public License version 3 for more details.
 */
 
+/** @file
+ * @brief Class Magnum::DebugTools::ObjectRenderer, Magnum::DebugTools::ObjectRendererOptions, typedef Magnum::DebugTools::ObjectRenderer2D, Magnum::DebugTools::ObjectRenderer3D
+ */
+
 #include "Resource.h"
 #include "SceneGraph/Drawable.h"
 #include "Shaders/Shaders.h"

src/DebugTools/ShapeRenderer.h

@@ -15,6 +15,10 @@
     GNU Lesser General Public License version 3 for more details.
 */
 
+/** @file
+ * @brief Class Magnum::DebugTools::ShapeRenderer, Magnum::DebugTools::ShapeRendererOptions, typedef Magnum::DebugTools::ShapeRenderer2D, Magnum::DebugTools::ShapeRenderer3D
+ */
+
 #include "Color.h"
 #include "Resource.h"
 #include "SceneGraph/Drawable.h"
@@ -65,7 +69,8 @@ class ShapeRendererOptions {
 /**
 @brief Shape renderer
 
-Visualizes collision shape. See @ref debug-tools-renderers for more information.
+Visualizes collision shapes using wireframe primitives. See
+@ref debug-tools-renderers for more information.
 
 @section ShapeRenderer-usage Basic usage
 

src/Primitives/Capsule.h

@@ -26,7 +26,7 @@ namespace Magnum { namespace Primitives {
 /**
 @brief 3D capsule primitive
 
-%Cylinder along Y axis with hemispheres instead of caps. Indexed triangle mesh
+%Cylinder along Y axis with hemispheres instead of caps. Indexed @ref Mesh::Primitive "Triangles"
 with normals and optional 2D texture coordinates.
 */
 class Capsule: public Trade::MeshData3D {

src/Primitives/Cube.h

@@ -33,14 +33,14 @@ class Cube {
         /**
          * @brief Solid cube
          *
-         * Indexed triangle mesh with flat normals.
+         * Indexed @ref Mesh::Primitive "Triangles" with flat normals.
          */
         static Trade::MeshData3D solid();
 
         /**
          * @brief Wireframe cube
          *
-         * Indexed line mesh.
+         * Indexed @ref Mesh::Primitive "Lines".
          */
         static Trade::MeshData3D wireframe();
 

src/Primitives/Cylinder.h

@@ -16,7 +16,7 @@
 */
 
 /** @file
- * @brief Class Magnum::Primitives::UVSphere
+ * @brief Class Magnum::Primitives::Cylinder
  */
 
 #include <Containers/EnumSet.h>
@@ -28,8 +28,8 @@ namespace Magnum { namespace Primitives {
 /**
 @brief 3D cylinder primitive
 
-Indexed triangle mesh with normals, optional 2D texture coordinates and
-optional capped ends.
+Indexed @ref Mesh::Primitive "Triangles" with normals, optional 2D texture
+coordinates and optional capped ends.
 */
 class Cylinder: public Capsule {
     public:

src/Primitives/Icosphere.h

@@ -34,7 +34,7 @@ template<std::size_t subdivisions> class Icosphere;
 /**
 @brief 3D icosphere primitive with zero subdivisions
 
-Indexed triangle mesh with normals.
+Indexed @ref Mesh::Primitive "Triangles" with normals.
 */
 template<> class Icosphere<0>: public Trade::MeshData3D {
     public:
@@ -46,7 +46,7 @@ template<> class Icosphere<0>: public Trade::MeshData3D {
 @brief 3D icosphere primitive
 @tparam subdivisions     Number of subdivisions
 
-Indexed triangle mesh with normals.
+Indexed @ref Mesh::Primitive "Triangles" with normals.
 */
 #ifndef DOXYGEN_GENERATING_OUTPUT
 template<std::size_t subdivisions> class Icosphere: public Icosphere<0> {

src/Primitives/Plane.h

@@ -26,7 +26,7 @@ namespace Magnum { namespace Primitives {
 /**
 @brief 3D plane primitive
 
-2x2 plane as triangle strip, non-indexed with normals in positive Z direction.
+2x2 plane.
 */
 class Plane {
     public:

src/Primitives/UVSphere.h

@@ -26,7 +26,8 @@ namespace Magnum { namespace Primitives {
 /**
 @brief 3D UV sphere primitive
 
-Indexed triangle mesh with normals and optional 2D texture coordinates.
+Indexed @ref Mesh::Primitive "Triangles" with normals and optional 2D texture
+coordinates.
 */
 class UVSphere: public Capsule {
     public: