Improved tags for doxygen documentation (added relations between free functions and classes, grouped classes into modules)

git-svn-id: https://sfml.svn.sourceforge.net/svnroot/sfml/branches/sfml2@1535 4e206d99-4929-0410-ac5d-dfc041789085

include/SFML/Graphics/Color.hpp

@@ -83,6 +83,7 @@ public :
 };
 
 ////////////////////////////////////////////////////////////
+/// \relates Color
 /// \brief Overload of the == operator
 ///
 /// This operator compares two colors and check if they are equal.
@@ -96,6 +97,7 @@ public :
 SFML_API bool operator ==(const Color& left, const Color& right);
 
 ////////////////////////////////////////////////////////////
+/// \relates Color
 /// \brief Overload of the != operator
 ///
 /// This operator compares two colors and check if they are different.
@@ -109,6 +111,7 @@ SFML_API bool operator ==(const Color& left, const Color& right);
 SFML_API bool operator !=(const Color& left, const Color& right);
 
 ////////////////////////////////////////////////////////////
+/// \relates Color
 /// \brief Overload of the binary + operator
 ///
 /// This operator returns the component-wise sum of two colors.
@@ -123,6 +126,7 @@ SFML_API bool operator !=(const Color& left, const Color& right);
 SFML_API Color operator +(const Color& left, const Color& right);
 
 ////////////////////////////////////////////////////////////
+/// \relates Color
 /// \brief Overload of the binary * operator
 ///
 /// This operator returns the component-wise multiplication
@@ -139,6 +143,7 @@ SFML_API Color operator +(const Color& left, const Color& right);
 SFML_API Color operator *(const Color& left, const Color& right);
 
 ////////////////////////////////////////////////////////////
+/// \relates Color
 /// \brief Overload of the binary += operator
 ///
 /// This operator computes the component-wise sum of two colors,
@@ -154,6 +159,7 @@ SFML_API Color operator *(const Color& left, const Color& right);
 SFML_API Color& operator +=(Color& left, const Color& right);
 
 ////////////////////////////////////////////////////////////
+/// \relates Color
 /// \brief Overload of the binary *= operator
 ///
 /// This operator returns the component-wise multiplication
@@ -178,6 +184,7 @@ SFML_API Color& operator *=(Color& left, const Color& right);
 
 ////////////////////////////////////////////////////////////
 /// \class sf::Color
+/// \ingroup graphics
 ///
 /// sf::Color is a simple color class composed of 4 components:
 /// \li Red

include/SFML/Graphics/Drawable.hpp

@@ -41,6 +41,7 @@ class RenderTarget;
 namespace Blend
 {
     ////////////////////////////////////////////////////////////
+    /// \ingroup graphics
     /// \brief Available blending modes for drawable objects
     ///
     ////////////////////////////////////////////////////////////
@@ -524,6 +525,7 @@ private :
 
 ////////////////////////////////////////////////////////////
 /// \class sf::Drawable
+/// \ingroup graphics
 ///
 /// sf::Drawable defines the attributes and operations that
 /// are common to all the drawable classes:

include/SFML/Graphics/Font.hpp

@@ -291,6 +291,7 @@ private :
 
 ////////////////////////////////////////////////////////////
 /// \class sf::Font
+/// \ingroup graphics
 ///
 /// Fonts can be loaded from a file or from memory, from
 /// the most common types of fonts. See the LoadFromFile

include/SFML/Graphics/Glyph.hpp

@@ -64,6 +64,7 @@ public :
 
 ////////////////////////////////////////////////////////////
 /// \class sf::Glyph
+/// \ingroup graphics
 ///
 /// A glyph is the visual representation of a character.
 ///

include/SFML/Graphics/Image.hpp

@@ -463,6 +463,7 @@ private :
 
 ////////////////////////////////////////////////////////////
 /// \class sf::Image
+/// \ingroup graphics
 ///
 /// sf::Image is an abstraction to manipulate images
 /// as bidimensional arrays of pixels. The class provides

include/SFML/Graphics/Matrix3.hpp

@@ -165,6 +165,7 @@ private :
 
 ////////////////////////////////////////////////////////////
 /// \class sf::Matrix3
+/// \ingroup graphics
 ///
 /// Matrix3 is only meant for internal use, its interface is
 /// limited and its implementation is optimized for OpenGL

include/SFML/Graphics/Rect.hpp

@@ -154,6 +154,7 @@ typedef Rect<float> FloatRect;
 
 ////////////////////////////////////////////////////////////
 /// \class sf::Rect
+/// \ingroup graphics
 ///
 /// A rectangle is defined by its top-left corner and its size.
 /// It is a very simple class defined for convenience, so

include/SFML/Graphics/RenderImage.hpp

@@ -221,6 +221,7 @@ private :
 
 ////////////////////////////////////////////////////////////
 /// \class sf::RenderImage
+/// \ingroup graphics
 ///
 /// sf::RenderImage is the little brother of sf::RenderWindow.
 /// It implements the same 2D drawing and OpenGL-related functions

include/SFML/Graphics/RenderTarget.hpp

@@ -311,6 +311,7 @@ private :
 
 ////////////////////////////////////////////////////////////
 /// \class sf::RenderTarget
+/// \ingroup graphics
 ///
 /// sf::RenderTarget defines the common behaviour of all the
 /// 2D render targets usable in the graphics module. It makes

include/SFML/Graphics/RenderWindow.hpp

@@ -165,6 +165,7 @@ private :
 
 ////////////////////////////////////////////////////////////
 /// \class sf::RenderWindow
+/// \ingroup graphics
 ///
 /// sf::RenderWindow is the main class of the Graphics module.
 /// It defines an OS window that can be painted using the other

include/SFML/Graphics/Renderer.hpp

@@ -372,6 +372,7 @@ private :
 
 ////////////////////////////////////////////////////////////
 /// \class sf::Renderer
+/// \ingroup graphics
 ///
 /// sf::Renderer is the abstraction layer between SFML code
 /// and the low-level drawing API (OpenGL). It manages

include/SFML/Graphics/Shader.hpp

@@ -370,6 +370,7 @@ private :
 
 ////////////////////////////////////////////////////////////
 /// \class sf::Shader
+/// \ingroup graphics
 ///
 /// Pixel shaders (or fragment shaders) are programs written
 /// using a specific language, executed directly by the

include/SFML/Graphics/Shape.hpp

@@ -433,6 +433,7 @@ private :
 
 ////////////////////////////////////////////////////////////
 /// \class sf::Shape
+/// \ingroup graphics
 ///
 /// sf::Shape is a drawable class that allows to define and
 /// display a custom convex shape on a render target.

include/SFML/Graphics/Sprite.hpp

@@ -243,6 +243,7 @@ private :
 
 ////////////////////////////////////////////////////////////
 /// \class sf::Sprite
+/// \ingroup graphics
 ///
 /// sf::Sprite is a drawable class that allows to easily display
 /// an image (or a part of it) on a render target.

include/SFML/Graphics/Text.hpp

@@ -254,6 +254,7 @@ private :
 
 ////////////////////////////////////////////////////////////
 /// \class sf::Text
+/// \ingroup graphics
 ///
 /// sf::Text is a drawable class that allows to easily display
 /// some text with custom style and color on a render target.

include/SFML/Graphics/View.hpp

@@ -287,6 +287,7 @@ private :
 
 ////////////////////////////////////////////////////////////
 /// \class sf::View
+/// \ingroup graphics
 ///
 /// sf::View defines a camera in the 2D scene. This is a
 /// very powerful concept: you can scroll, rotate or zoom