From db105839c5caa827fa40629edf74fec1a44a3a87 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Vladim=C3=ADr=20Vondru=C5=A1?= <mosra@centrum.cz>
Date: Sat, 18 Aug 2012 15:51:17 +0200
Subject: [PATCH] Doc++

---
 src/BufferedImage.h     | 2 +-
 src/Image.h             | 2 +-
 src/SceneGraph/Camera.h | 2 +-
 src/SceneGraph/Object.h | 2 +-
 src/SceneGraph/Scene.h  | 4 +++-
 src/Swizzle.h           | 6 +++---
 src/Texture.h           | 2 +-
 7 files changed, 11 insertions(+), 9 deletions(-)

diff --git a/src/BufferedImage.h b/src/BufferedImage.h
index 5b91723c5..5489716df 100644
--- a/src/BufferedImage.h
+++ b/src/BufferedImage.h
@@ -16,7 +16,7 @@
 */
 
 /** @file
- * @brief Class Magnum::BufferedImage
+ * @brief Class Magnum::BufferedImage, typedef Magnum::BufferedImage1D, Magnum::BufferedImage2D, Magnum::BufferedImage3D
  */
 
 #include "AbstractImage.h"
diff --git a/src/Image.h b/src/Image.h
index 7a595786f..64557ea23 100644
--- a/src/Image.h
+++ b/src/Image.h
@@ -16,7 +16,7 @@
 */
 
 /** @file
- * @brief Class Magnum::Image
+ * @brief Class Magnum::Image, typedef Magnum::Image1D, Magnum::Image2D, Magnum::Image3D
  */
 
 #include "AbstractImage.h"
diff --git a/src/SceneGraph/Camera.h b/src/SceneGraph/Camera.h
index 003845250..64ed68d37 100644
--- a/src/SceneGraph/Camera.h
+++ b/src/SceneGraph/Camera.h
@@ -16,7 +16,7 @@
 */
 
 /** @file
- * @brief Class Magnum::SceneGraph::Camera
+ * @brief Class Magnum::SceneGraph::Camera, Magnum::SceneGraph::Camera2D, Magnum::SceneGraph::Camera3D
  */
 
 #include "Object.h"
diff --git a/src/SceneGraph/Object.h b/src/SceneGraph/Object.h
index 01ce166b7..b6a0d3861 100644
--- a/src/SceneGraph/Object.h
+++ b/src/SceneGraph/Object.h
@@ -16,7 +16,7 @@
 */
 
 /** @file
- * @brief Class Magnum::SceneGraph::Object
+ * @brief Class Magnum::SceneGraph::Object, Magnum::SceneGraph::Object2D, Magnum::SceneGraph::Object3D
  */
 
 #include <Containers/LinkedList.h>
diff --git a/src/SceneGraph/Scene.h b/src/SceneGraph/Scene.h
index 58cc94fd1..2fd2e6fe9 100644
--- a/src/SceneGraph/Scene.h
+++ b/src/SceneGraph/Scene.h
@@ -16,7 +16,7 @@
 */
 
 /** @file
- * @brief Class Magnum::SceneGraph::Scene
+ * @brief Class Magnum::SceneGraph::Scene, typedef Magnum::SceneGraph::Scene2D, Magnum::SceneGraph::Scene3D
  */
 
 #include "Object.h"
@@ -26,8 +26,10 @@ namespace Magnum { namespace SceneGraph {
 /** @brief %Scene */
 template<class MatrixType, class VectorType, class ObjectType, class CameraType> class SCENEGRAPH_EXPORT Scene: public ObjectType {
     public:
+        /** @copydoc Object::isScene() */
         inline bool isScene() const { return true; }
 
+        /** @todo Some deleted functions belong only to Scene2D, some only to Scene3D - what to do? */
         #ifndef DOXYGEN_GENERATING_OUTPUT
         void setParent(ObjectType* parent) = delete;
         void setTransformation(const MatrixType& transformation) = delete;
diff --git a/src/Swizzle.h b/src/Swizzle.h
index 84af4858b..22239225b 100644
--- a/src/Swizzle.h
+++ b/src/Swizzle.h
@@ -16,7 +16,7 @@
 */
 
 /** @file
- * @brief Function Magnum::Math::swizzle()
+ * @brief Functions Magnum::swizzle(const T&), Magnum::swizzle(const T&, const char(&)[])
  */
 
 #include "Color.h"
@@ -93,7 +93,7 @@ two, three or four-component, corresponding Vector2, Vector3 or Vector4
 specialization is returned.
 
 @attention This function is less convenient to write than
-swizzle(const Vector<size, T>&, const char(&)[newSize]), but the evaluation of
+swizzle(const T&, const char(&)[newSize]), but the evaluation of
 the swizzling operation is guaranteed to be always done at compile time
 instead of at runtime.
 
@@ -119,7 +119,7 @@ two, three or four-component, corresponding Vector2, Vector3 or Vector4
 specialization is returned.
 
 @attention This function is more convenient to write than
-swizzle(const Vector<size, T>&), but unless the result is marked with
+swizzle(const T&), but unless the result is marked with
 `constexpr`, the evaluation of the swizzling operation probably won't be
 evaluated at compile time, but at runtime.
 
diff --git a/src/Texture.h b/src/Texture.h
index 7bb9e33b3..d31d2039b 100644
--- a/src/Texture.h
+++ b/src/Texture.h
@@ -16,7 +16,7 @@
 */
 
 /** @file
- * @brief Class Magnum::Texture
+ * @brief Class Magnum::Texture, typedef Magnum::Texture1D, Magnum::Texture2D, Magnum::Texture3D
  */
 
 #include "AbstractTexture.h"