diff --git a/src/Primitives/Capsule.h b/src/Primitives/Capsule.h index 570a1ede0..243e426c9 100644 --- a/src/Primitives/Capsule.h +++ b/src/Primitives/Capsule.h @@ -24,9 +24,10 @@ namespace Magnum { namespace Primitives { /** -@brief %Capsule primitive +@brief 3D capsule primitive -Cylinder along Y axis with hemispheres instead of caps. +Cylinder along Y axis with hemispheres instead of caps. Indexed with normals +and optional 2D texture coordinates. */ class Capsule: public Trade::MeshData3D { friend class UVSphere; diff --git a/src/Primitives/Cube.h b/src/Primitives/Cube.h index e44368f58..95f98c0f5 100644 --- a/src/Primitives/Cube.h +++ b/src/Primitives/Cube.h @@ -23,7 +23,12 @@ namespace Magnum { namespace Primitives { -/** @brief %Cube primitive */ +/** +@brief 3D cube primitive + +Indexed with smooth normals. +@todo Does anyone EVER want smooth normals on a cube?! +*/ class Cube: public Trade::MeshData3D { public: /** @brief Constructor */ diff --git a/src/Primitives/Cylinder.h b/src/Primitives/Cylinder.h index f68993b70..f8c5a5a3b 100644 --- a/src/Primitives/Cylinder.h +++ b/src/Primitives/Cylinder.h @@ -25,7 +25,12 @@ namespace Magnum { namespace Primitives { -/** @brief Cylinder primitive */ +/** +@brief 3D cylinder primitive + +Indexed with normals, optional 2D texture coordinates and optional capped +ends. +*/ class Cylinder: public Capsule { public: /** diff --git a/src/Primitives/Icosphere.h b/src/Primitives/Icosphere.h index a31c887d2..5bc2afacc 100644 --- a/src/Primitives/Icosphere.h +++ b/src/Primitives/Icosphere.h @@ -29,8 +29,9 @@ namespace Magnum { namespace Primitives { template class Icosphere; /** -@brief %Icosphere primitive with zero subdivisions +@brief 3D icosphere primitive with zero subdivisions +Indexed with normals. @todo Use own computed (and more precise) icosahedron data, not these stolen from Blender. */ @@ -41,9 +42,11 @@ template<> class Icosphere<0>: public Trade::MeshData3D { }; /** - * @brief %Icosphere primitive - * @tparam subdivisions Number of subdivisions - */ +@brief 3D icosphere primitive +@tparam subdivisions Number of subdivisions + +Indexed with normals. +*/ #ifndef DOXYGEN_GENERATING_OUTPUT template class Icosphere: public Icosphere<0> { #else diff --git a/src/Primitives/Plane.h b/src/Primitives/Plane.h index 7f1693284..e1d0045ce 100644 --- a/src/Primitives/Plane.h +++ b/src/Primitives/Plane.h @@ -24,9 +24,9 @@ namespace Magnum { namespace Primitives { /** -@brief %Plane primitive +@brief 3D plane primitive -2x2 plane with normals in positive Z direction. +2x2 plane, non-indexed with normals in positive Z direction. */ class Plane: public Trade::MeshData3D { public: diff --git a/src/Primitives/Square.h b/src/Primitives/Square.h index 67ad3ad5e..eff7f6595 100644 --- a/src/Primitives/Square.h +++ b/src/Primitives/Square.h @@ -24,9 +24,9 @@ namespace Magnum { namespace Primitives { /** -@brief %Square primitive +@brief 2D square primitive -2x2 square. +2x2 square, non-indexed. */ class Square: public Trade::MeshData2D { public: diff --git a/src/Primitives/UVSphere.h b/src/Primitives/UVSphere.h index 4e6be3b63..2e81ae6f4 100644 --- a/src/Primitives/UVSphere.h +++ b/src/Primitives/UVSphere.h @@ -23,7 +23,11 @@ namespace Magnum { namespace Primitives { -/** @brief UV Sphere primitive */ +/** +@brief 3D UV sphere primitive + +Indexed with normals and optional 2D texture coordinates. +*/ class UVSphere: public Capsule { public: /**