From 7fd9e70b78581c8ced4387b28dd44fa1d8d8633e Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Vladim=C3=ADr=20Vondru=C5=A1?= <mosra@centrum.cz>
Date: Sun, 11 May 2014 18:17:53 +0200
Subject: [PATCH] Primitives: completed documentation review.

---
 src/Magnum/Primitives/Capsule.h   |  2 +-
 src/Magnum/Primitives/Circle.h    |  4 ++--
 src/Magnum/Primitives/Crosshair.h |  2 +-
 src/Magnum/Primitives/Cube.h      |  2 +-
 src/Magnum/Primitives/Cylinder.h  | 12 ++++++++----
 src/Magnum/Primitives/Icosphere.h |  2 +-
 src/Magnum/Primitives/Line.h      |  2 +-
 src/Magnum/Primitives/Plane.h     |  2 +-
 src/Magnum/Primitives/Square.h    |  2 +-
 src/Magnum/Primitives/UVSphere.h  |  2 +-
 10 files changed, 18 insertions(+), 14 deletions(-)

diff --git a/src/Magnum/Primitives/Capsule.h b/src/Magnum/Primitives/Capsule.h
index 15466542f..ecaff322f 100644
--- a/src/Magnum/Primitives/Capsule.h
+++ b/src/Magnum/Primitives/Capsule.h
@@ -26,7 +26,7 @@
 */
 
 /** @file
- * @brief Class Magnum::Primitives::Capsule
+ * @brief Class @ref Magnum::Primitives::Capsule2D, @ref Magnum::Primitives::Capsule3D
  */
 
 #include "Magnum/Primitives/visibility.h"
diff --git a/src/Magnum/Primitives/Circle.h b/src/Magnum/Primitives/Circle.h
index c46cdca4c..d6afd9b34 100644
--- a/src/Magnum/Primitives/Circle.h
+++ b/src/Magnum/Primitives/Circle.h
@@ -26,7 +26,7 @@
 */
 
 /** @file
- * @brief Class Magnum::Primitives::Circle
+ * @brief Class @ref Magnum::Primitives::Circle
  */
 
 #include "Magnum/Primitives/visibility.h"
@@ -37,7 +37,7 @@ namespace Magnum { namespace Primitives {
 /**
 @brief 2D circle primitive
 
-Circle with radius `1`.
+%Circle with radius `1`.
 */
 class MAGNUM_PRIMITIVES_EXPORT Circle {
     public:
diff --git a/src/Magnum/Primitives/Crosshair.h b/src/Magnum/Primitives/Crosshair.h
index 66f469c7a..91ff5b6da 100644
--- a/src/Magnum/Primitives/Crosshair.h
+++ b/src/Magnum/Primitives/Crosshair.h
@@ -26,7 +26,7 @@
 */
 
 /** @file
- * @brief Class Magnum::Primitives::Crosshair2D, Magnum::Primitives::Crosshair3D
+ * @brief Class @ref Magnum::Primitives::Crosshair2D, @ref Magnum::Primitives::Crosshair3D
  */
 
 #include "Magnum/Primitives/visibility.h"
diff --git a/src/Magnum/Primitives/Cube.h b/src/Magnum/Primitives/Cube.h
index d929e755e..25e7bd44e 100644
--- a/src/Magnum/Primitives/Cube.h
+++ b/src/Magnum/Primitives/Cube.h
@@ -26,7 +26,7 @@
 */
 
 /** @file
- * @brief Class Magnum::Primitives::Cube
+ * @brief Class @ref Magnum::Primitives::Cube
  */
 
 #include "Magnum/Primitives/visibility.h"
diff --git a/src/Magnum/Primitives/Cylinder.h b/src/Magnum/Primitives/Cylinder.h
index 58a15bebd..dcae34469 100644
--- a/src/Magnum/Primitives/Cylinder.h
+++ b/src/Magnum/Primitives/Cylinder.h
@@ -26,7 +26,7 @@
 */
 
 /** @file
- * @brief Class Magnum::Primitives::Cylinder
+ * @brief Class @ref Magnum::Primitives::Cylinder
  */
 
 #include <Corrade/Containers/EnumSet.h>
@@ -45,16 +45,20 @@ namespace Magnum { namespace Primitives {
 class MAGNUM_PRIMITIVES_EXPORT Cylinder {
     public:
         /**
-         * @brief %Flags
+         * @brief %Flag
          *
-         * @see Flags, Cylinder()
+         * @see @ref Flags, @ref solid(), @ref wireframe()
          */
         enum class Flag {
             GenerateTextureCoords = 1,  /**< @brief Generate texture coordinates */
             CapEnds                     /**< @brief Cap ends */
         };
 
-        /** @brief %Flags */
+        /**
+         * @brief %Flags
+         *
+         * @see @ref solid(), @ref wireframe()
+         */
         typedef Containers::EnumSet<Flag, int> Flags;
 
         /**
diff --git a/src/Magnum/Primitives/Icosphere.h b/src/Magnum/Primitives/Icosphere.h
index f39fccdf1..f8e19d469 100644
--- a/src/Magnum/Primitives/Icosphere.h
+++ b/src/Magnum/Primitives/Icosphere.h
@@ -26,7 +26,7 @@
 */
 
 /** @file
- * @brief Class Magnum::Primitives::Icosphere
+ * @brief Class @ref Magnum::Primitives::Icosphere
  */
 
 #include "Magnum/Primitives/visibility.h"
diff --git a/src/Magnum/Primitives/Line.h b/src/Magnum/Primitives/Line.h
index 65e7cd7b6..9917ce5e6 100644
--- a/src/Magnum/Primitives/Line.h
+++ b/src/Magnum/Primitives/Line.h
@@ -26,7 +26,7 @@
 */
 
 /** @file
- * @brief Class Magnum::Primitives::Line2D, Magnum::Primitives::Line3D
+ * @brief Class @ref Magnum::Primitives::Line2D, @ref Magnum::Primitives::Line3D
  */
 
 #include "Magnum/Primitives/visibility.h"
diff --git a/src/Magnum/Primitives/Plane.h b/src/Magnum/Primitives/Plane.h
index 9ef48429e..eacd0312e 100644
--- a/src/Magnum/Primitives/Plane.h
+++ b/src/Magnum/Primitives/Plane.h
@@ -26,7 +26,7 @@
 */
 
 /** @file
- * @brief Class Magnum::Primitives::Plane
+ * @brief Class @ref Magnum::Primitives::Plane
  */
 
 #include "Magnum/Trade/Trade.h"
diff --git a/src/Magnum/Primitives/Square.h b/src/Magnum/Primitives/Square.h
index 5d7160645..3127c4ee6 100644
--- a/src/Magnum/Primitives/Square.h
+++ b/src/Magnum/Primitives/Square.h
@@ -26,7 +26,7 @@
 */
 
 /** @file
- * @brief Class Magnum::Primitives::Square
+ * @brief Class @ref Magnum::Primitives::Square
  */
 
 #include "Magnum/Primitives/visibility.h"
diff --git a/src/Magnum/Primitives/UVSphere.h b/src/Magnum/Primitives/UVSphere.h
index 749967e25..b61cc1874 100644
--- a/src/Magnum/Primitives/UVSphere.h
+++ b/src/Magnum/Primitives/UVSphere.h
@@ -26,7 +26,7 @@
 */
 
 /** @file
- * @brief Class Magnum::Primitives::UVSphere
+ * @brief Class @ref Magnum::Primitives::UVSphere
  */
 
 #include "Magnum/Trade/Trade.h"