Browse Source

Primitives: completed documentation review.

pull/54/merge
Vladimír Vondruš 12 years ago
parent
commit
7fd9e70b78
  1. 2
      src/Magnum/Primitives/Capsule.h
  2. 4
      src/Magnum/Primitives/Circle.h
  3. 2
      src/Magnum/Primitives/Crosshair.h
  4. 2
      src/Magnum/Primitives/Cube.h
  5. 12
      src/Magnum/Primitives/Cylinder.h
  6. 2
      src/Magnum/Primitives/Icosphere.h
  7. 2
      src/Magnum/Primitives/Line.h
  8. 2
      src/Magnum/Primitives/Plane.h
  9. 2
      src/Magnum/Primitives/Square.h
  10. 2
      src/Magnum/Primitives/UVSphere.h

2
src/Magnum/Primitives/Capsule.h

@ -26,7 +26,7 @@
*/ */
/** @file /** @file
* @brief Class Magnum::Primitives::Capsule * @brief Class @ref Magnum::Primitives::Capsule2D, @ref Magnum::Primitives::Capsule3D
*/ */
#include "Magnum/Primitives/visibility.h" #include "Magnum/Primitives/visibility.h"

4
src/Magnum/Primitives/Circle.h

@ -26,7 +26,7 @@
*/ */
/** @file /** @file
* @brief Class Magnum::Primitives::Circle * @brief Class @ref Magnum::Primitives::Circle
*/ */
#include "Magnum/Primitives/visibility.h" #include "Magnum/Primitives/visibility.h"
@ -37,7 +37,7 @@ namespace Magnum { namespace Primitives {
/** /**
@brief 2D circle primitive @brief 2D circle primitive
Circle with radius `1`. %Circle with radius `1`.
*/ */
class MAGNUM_PRIMITIVES_EXPORT Circle { class MAGNUM_PRIMITIVES_EXPORT Circle {
public: public:

2
src/Magnum/Primitives/Crosshair.h

@ -26,7 +26,7 @@
*/ */
/** @file /** @file
* @brief Class Magnum::Primitives::Crosshair2D, Magnum::Primitives::Crosshair3D * @brief Class @ref Magnum::Primitives::Crosshair2D, @ref Magnum::Primitives::Crosshair3D
*/ */
#include "Magnum/Primitives/visibility.h" #include "Magnum/Primitives/visibility.h"

2
src/Magnum/Primitives/Cube.h

@ -26,7 +26,7 @@
*/ */
/** @file /** @file
* @brief Class Magnum::Primitives::Cube * @brief Class @ref Magnum::Primitives::Cube
*/ */
#include "Magnum/Primitives/visibility.h" #include "Magnum/Primitives/visibility.h"

12
src/Magnum/Primitives/Cylinder.h

@ -26,7 +26,7 @@
*/ */
/** @file /** @file
* @brief Class Magnum::Primitives::Cylinder * @brief Class @ref Magnum::Primitives::Cylinder
*/ */
#include <Corrade/Containers/EnumSet.h> #include <Corrade/Containers/EnumSet.h>
@ -45,16 +45,20 @@ namespace Magnum { namespace Primitives {
class MAGNUM_PRIMITIVES_EXPORT Cylinder { class MAGNUM_PRIMITIVES_EXPORT Cylinder {
public: public:
/** /**
* @brief %Flags * @brief %Flag
* *
* @see Flags, Cylinder() * @see @ref Flags, @ref solid(), @ref wireframe()
*/ */
enum class Flag { enum class Flag {
GenerateTextureCoords = 1, /**< @brief Generate texture coordinates */ GenerateTextureCoords = 1, /**< @brief Generate texture coordinates */
CapEnds /**< @brief Cap ends */ CapEnds /**< @brief Cap ends */
}; };
/** @brief %Flags */ /**
* @brief %Flags
*
* @see @ref solid(), @ref wireframe()
*/
typedef Containers::EnumSet<Flag, int> Flags; typedef Containers::EnumSet<Flag, int> Flags;
/** /**

2
src/Magnum/Primitives/Icosphere.h

@ -26,7 +26,7 @@
*/ */
/** @file /** @file
* @brief Class Magnum::Primitives::Icosphere * @brief Class @ref Magnum::Primitives::Icosphere
*/ */
#include "Magnum/Primitives/visibility.h" #include "Magnum/Primitives/visibility.h"

2
src/Magnum/Primitives/Line.h

@ -26,7 +26,7 @@
*/ */
/** @file /** @file
* @brief Class Magnum::Primitives::Line2D, Magnum::Primitives::Line3D * @brief Class @ref Magnum::Primitives::Line2D, @ref Magnum::Primitives::Line3D
*/ */
#include "Magnum/Primitives/visibility.h" #include "Magnum/Primitives/visibility.h"

2
src/Magnum/Primitives/Plane.h

@ -26,7 +26,7 @@
*/ */
/** @file /** @file
* @brief Class Magnum::Primitives::Plane * @brief Class @ref Magnum::Primitives::Plane
*/ */
#include "Magnum/Trade/Trade.h" #include "Magnum/Trade/Trade.h"

2
src/Magnum/Primitives/Square.h

@ -26,7 +26,7 @@
*/ */
/** @file /** @file
* @brief Class Magnum::Primitives::Square * @brief Class @ref Magnum::Primitives::Square
*/ */
#include "Magnum/Primitives/visibility.h" #include "Magnum/Primitives/visibility.h"

2
src/Magnum/Primitives/UVSphere.h

@ -26,7 +26,7 @@
*/ */
/** @file /** @file
* @brief Class Magnum::Primitives::UVSphere * @brief Class @ref Magnum::Primitives::UVSphere
*/ */
#include "Magnum/Trade/Trade.h" #include "Magnum/Trade/Trade.h"

Loading…
Cancel
Save