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
This commit is contained in:
LaurentGom 2010-07-22 21:45:58 +00:00
parent 37ea224621
commit 0444781a4b
60 changed files with 129 additions and 0 deletions

View File

@ -40,3 +40,8 @@
#endif // SFML_AUDIO_HPP #endif // SFML_AUDIO_HPP
////////////////////////////////////////////////////////////
/// \defgroup audio Audio module
///
////////////////////////////////////////////////////////////

View File

@ -154,6 +154,7 @@ public :
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \class sf::Listener /// \class sf::Listener
/// \ingroup audio
/// ///
/// The audio listener defines the global properties of the /// The audio listener defines the global properties of the
/// audio environment, it defines where and how sounds and musics /// audio environment, it defines where and how sounds and musics

View File

@ -146,6 +146,7 @@ private :
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \class sf::Music /// \class sf::Music
/// \ingroup audio
/// ///
/// Musics are sounds that are streamed rather than completely /// Musics are sounds that are streamed rather than completely
/// loaded in memory. This is especially useful for compressed /// loaded in memory. This is especially useful for compressed

View File

@ -228,6 +228,7 @@ private :
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \class sf::Sound /// \class sf::Sound
/// \ingroup audio
/// ///
/// sf::Sound is the class to use to play sounds. /// sf::Sound is the class to use to play sounds.
/// It provides: /// It provides:

View File

@ -261,6 +261,7 @@ private :
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \class sf::SoundBuffer /// \class sf::SoundBuffer
/// \ingroup audio
/// ///
/// A sound buffer holds the data of a sound, which is /// A sound buffer holds the data of a sound, which is
/// an array of audio samples. A sample is a 16 bits signed integer /// an array of audio samples. A sample is a 16 bits signed integer

View File

@ -98,6 +98,7 @@ private :
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \class sf::SoundBufferRecorder /// \class sf::SoundBufferRecorder
/// \ingroup audio
/// ///
/// sf::SoundBufferRecorder allows to access a recorded sound /// sf::SoundBufferRecorder allows to access a recorded sound
/// through a sf::SoundBuffer, so that it can be played, saved /// through a sf::SoundBuffer, so that it can be played, saved

View File

@ -193,6 +193,7 @@ private :
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \class sf::SoundRecorder /// \class sf::SoundRecorder
/// \ingroup audio
/// ///
/// sf::SoundBuffer provides a simple interface to access /// sf::SoundBuffer provides a simple interface to access
/// the audio recording capabilities of the computer /// the audio recording capabilities of the computer

View File

@ -271,6 +271,7 @@ protected :
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \class sf::SoundSource /// \class sf::SoundSource
/// \ingroup audio
/// ///
/// sf::SoundSource is not meant to be used directly, it /// sf::SoundSource is not meant to be used directly, it
/// only serves as a common base for all audio objects /// only serves as a common base for all audio objects

View File

@ -296,6 +296,7 @@ private :
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \class sf::SoundStream /// \class sf::SoundStream
/// \ingroup audio
/// ///
/// Unlike audio buffers (see sf::SoundBuffer), audio streams /// Unlike audio buffers (see sf::SoundBuffer), audio streams
/// are never completely loaded in memory. Instead, the audio /// are never completely loaded in memory. Instead, the audio

View File

@ -45,3 +45,8 @@
#endif // SFML_GRAPHICS_HPP #endif // SFML_GRAPHICS_HPP
////////////////////////////////////////////////////////////
/// \defgroup graphics Graphics module
///
////////////////////////////////////////////////////////////

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

@ -41,3 +41,8 @@
#endif // SFML_NETWORK_HPP #endif // SFML_NETWORK_HPP
////////////////////////////////////////////////////////////
/// \defgroup network Network module
///
////////////////////////////////////////////////////////////

View File

@ -532,6 +532,7 @@ private :
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \class sf::Ftp /// \class sf::Ftp
/// \ingroup network
/// ///
/// sf::Ftp is a very simple FTP client that allows you /// sf::Ftp is a very simple FTP client that allows you
/// to communicate with a FTP server. The FTP protocol allows /// to communicate with a FTP server. The FTP protocol allows

View File

@ -407,6 +407,7 @@ private :
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \class sf::Http /// \class sf::Http
/// \ingroup network
/// ///
/// sf::Http is a very simple HTTP client that allows you /// sf::Http is a very simple HTTP client that allows you
/// to communicate with a web server. You can retrieve /// to communicate with a web server. You can retrieve

View File

@ -287,6 +287,7 @@ SFML_API std::ostream& operator <<(std::ostream& stream, const IpAddress& addres
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \class sf::IpAddress /// \class sf::IpAddress
/// \ingroup network
/// ///
/// sf::IpAddress is a utility class for manipulating network /// sf::IpAddress is a utility class for manipulating network
/// addresses. It provides a set a implicit constructors and /// addresses. It provides a set a implicit constructors and

View File

@ -269,6 +269,7 @@ private :
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \class sf::Packet /// \class sf::Packet
/// \ingroup network
/// ///
/// Packets provide a safe and easy way to serialize data, /// Packets provide a safe and easy way to serialize data,
/// in order to send it over the network using sockets /// in order to send it over the network using sockets

View File

@ -202,6 +202,7 @@ private :
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \class sf::Socket /// \class sf::Socket
/// \ingroup network
/// ///
/// This class mainly defines internal stuff to be used by /// This class mainly defines internal stuff to be used by
/// derived classes. /// derived classes.

View File

@ -167,6 +167,7 @@ private :
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \class sf::SocketSelector /// \class sf::SocketSelector
/// \ingroup network
/// ///
/// Socket selectors provide a way to wait until some data is /// Socket selectors provide a way to wait until some data is
/// available on a set of sockets, instead of just one. This /// available on a set of sockets, instead of just one. This

View File

@ -104,6 +104,7 @@ public :
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \class sf::TcpListener /// \class sf::TcpListener
/// \ingroup network
/// ///
/// A listener socket is a special type of socket that listens to /// A listener socket is a special type of socket that listens to
/// a given port and waits for connections on that port. /// a given port and waits for connections on that port.

View File

@ -193,6 +193,7 @@ public :
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \class sf::TcpSocket /// \class sf::TcpSocket
/// \ingroup network
/// ///
/// TCP is a connected protocol, which means that a TCP /// TCP is a connected protocol, which means that a TCP
/// socket can only communicate with the host it is connected /// socket can only communicate with the host it is connected

View File

@ -190,6 +190,7 @@ public :
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \class sf::UdpSocket /// \class sf::UdpSocket
/// \ingroup network
/// ///
/// A UDP socket is a connectionless socket. Instead of /// A UDP socket is a connectionless socket. Instead of
/// connecting once to a remote host, like TCP sockets, /// connecting once to a remote host, like TCP sockets,

View File

@ -45,3 +45,8 @@
#include <SFML/System/Vector3.hpp> #include <SFML/System/Vector3.hpp>
#endif // SFML_SYSTEM_HPP #endif // SFML_SYSTEM_HPP
////////////////////////////////////////////////////////////
/// \defgroup system System module
///
////////////////////////////////////////////////////////////

View File

@ -85,6 +85,7 @@ private :
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \class sf::Clock /// \class sf::Clock
/// \ingroup system
/// ///
/// sf::Clock is a lightweight class for measuring time. /// sf::Clock is a lightweight class for measuring time.
/// Its resolution depends on the underlying OS, but you can generally /// Its resolution depends on the underlying OS, but you can generally

View File

@ -48,6 +48,7 @@ SFML_API std::ostream& Err();
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \fn sf::Err /// \fn sf::Err
/// \ingroup system
/// ///
/// By default, sf::Err() outputs to the same location as std::cerr, /// By default, sf::Err() outputs to the same location as std::cerr,
/// (-> the stderr descriptor) which is the console if there's /// (-> the stderr descriptor) which is the console if there's

View File

@ -77,6 +77,7 @@ private :
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \class sf::Lock /// \class sf::Lock
/// \ingroup system
/// ///
/// sf::Lock is a RAII wrapper for sf::Mutex. By unlocking /// sf::Lock is a RAII wrapper for sf::Mutex. By unlocking
/// it in its destructor, it ensures that the mutex will /// it in its destructor, it ensures that the mutex will

View File

@ -96,6 +96,7 @@ private :
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \class sf::Mutex /// \class sf::Mutex
/// \ingroup system
/// ///
/// Mutex stands for "MUTual EXclusion". A mutex is a /// Mutex stands for "MUTual EXclusion". A mutex is a
/// synchronization object, used when multiple threads are involved. /// synchronization object, used when multiple threads are involved.

View File

@ -87,6 +87,7 @@ private :
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \class sf::NonCopyable /// \class sf::NonCopyable
/// \ingroup system
/// ///
/// This class makes its instances non-copyable, by explicitely /// This class makes its instances non-copyable, by explicitely
/// disabling its copy constructor and its assignment operator. /// disabling its copy constructor and its assignment operator.

View File

@ -91,6 +91,7 @@ public :
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \class sf::Randomizer /// \class sf::Randomizer
/// \ingroup system
/// ///
/// sf::Randomizer generates pseudo-random numbers using the /// sf::Randomizer generates pseudo-random numbers using the
/// standard library. /// standard library.

View File

@ -243,6 +243,7 @@ private :
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \class sf::Resource /// \class sf::Resource
/// \ingroup system
/// ///
/// sf::Resource is a base for classes that want to be /// sf::Resource is a base for classes that want to be
/// compatible with the sf::ResourcePtr safe pointer. /// compatible with the sf::ResourcePtr safe pointer.
@ -256,6 +257,7 @@ private :
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \class sf::ResourcePtr /// \class sf::ResourcePtr
/// \ingroup system
/// ///
/// sf::ResourcePtr is a special kind of smart pointer for /// sf::ResourcePtr is a special kind of smart pointer for
/// resources. Its main feature is to automatically /// resources. Its main feature is to automatically

View File

@ -34,6 +34,7 @@
namespace sf namespace sf
{ {
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \ingroup system
/// \brief Make the current thread sleep for a given time /// \brief Make the current thread sleep for a given time
/// ///
/// sf::Sleep is the best way to block a program or one of its /// sf::Sleep is the best way to block a program or one of its

View File

@ -461,6 +461,7 @@ private :
}; };
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \relates String
/// \brief Overload of == operator to compare two UTF-32 strings /// \brief Overload of == operator to compare two UTF-32 strings
/// ///
/// \param left Left operand (a string) /// \param left Left operand (a string)
@ -472,6 +473,7 @@ private :
SFML_API bool operator ==(const String& left, const String& right); SFML_API bool operator ==(const String& left, const String& right);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \relates String
/// \brief Overload of != operator to compare two UTF-32 strings /// \brief Overload of != operator to compare two UTF-32 strings
/// ///
/// \param left Left operand (a string) /// \param left Left operand (a string)
@ -483,6 +485,7 @@ SFML_API bool operator ==(const String& left, const String& right);
SFML_API bool operator !=(const String& left, const String& right); SFML_API bool operator !=(const String& left, const String& right);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \relates String
/// \brief Overload of < operator to compare two UTF-32 strings /// \brief Overload of < operator to compare two UTF-32 strings
/// ///
/// \param left Left operand (a string) /// \param left Left operand (a string)
@ -494,6 +497,7 @@ SFML_API bool operator !=(const String& left, const String& right);
SFML_API bool operator <(const String& left, const String& right); SFML_API bool operator <(const String& left, const String& right);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \relates String
/// \brief Overload of > operator to compare two UTF-32 strings /// \brief Overload of > operator to compare two UTF-32 strings
/// ///
/// \param left Left operand (a string) /// \param left Left operand (a string)
@ -505,6 +509,7 @@ SFML_API bool operator <(const String& left, const String& right);
SFML_API bool operator >(const String& left, const String& right); SFML_API bool operator >(const String& left, const String& right);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \relates String
/// \brief Overload of <= operator to compare two UTF-32 strings /// \brief Overload of <= operator to compare two UTF-32 strings
/// ///
/// \param left Left operand (a string) /// \param left Left operand (a string)
@ -516,6 +521,7 @@ SFML_API bool operator >(const String& left, const String& right);
SFML_API bool operator <=(const String& left, const String& right); SFML_API bool operator <=(const String& left, const String& right);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \relates String
/// \brief Overload of >= operator to compare two UTF-32 strings /// \brief Overload of >= operator to compare two UTF-32 strings
/// ///
/// \param left Left operand (a string) /// \param left Left operand (a string)
@ -527,6 +533,7 @@ SFML_API bool operator <=(const String& left, const String& right);
SFML_API bool operator >=(const String& left, const String& right); SFML_API bool operator >=(const String& left, const String& right);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \relates String
/// \brief Overload of binary + operator to concatenate two strings /// \brief Overload of binary + operator to concatenate two strings
/// ///
/// \param left Left operand (a string) /// \param left Left operand (a string)
@ -545,6 +552,7 @@ SFML_API String operator +(const String& left, const String& right);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \class sf::String /// \class sf::String
/// \ingroup system
/// ///
/// sf::String is a utility string class defined mainly for /// sf::String is a utility string class defined mainly for
/// convenience. It is a Unicode string (implemented using /// convenience. It is a Unicode string (implemented using

View File

@ -135,6 +135,7 @@ private :
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \class sf::Thread /// \class sf::Thread
/// \ingroup system
/// ///
/// Threads provide a way to run multiple parts of the code /// Threads provide a way to run multiple parts of the code
/// in parallel. When you launch a new thread, the execution /// in parallel. When you launch a new thread, the execution

View File

@ -94,6 +94,7 @@ private :
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \class sf::ThreadLocal /// \class sf::ThreadLocal
/// \ingroup system
/// ///
/// This class manipulates void* parameters and thus is not /// This class manipulates void* parameters and thus is not
/// appropriate for strongly-typed variables. You should rather /// appropriate for strongly-typed variables. You should rather

View File

@ -112,6 +112,7 @@ public :
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \class sf::ThreadLocalPtr /// \class sf::ThreadLocalPtr
/// \ingroup system
/// ///
/// sf::ThreadLocalPtr is a type-safe wrapper for storing /// sf::ThreadLocalPtr is a type-safe wrapper for storing
/// pointers to thread-local variables. A thread-local /// pointers to thread-local variables. A thread-local

View File

@ -38,6 +38,7 @@
namespace sf namespace sf
{ {
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \ingroup system
/// \brief Get the default system locale /// \brief Get the default system locale
/// ///
/// \return Reference to the default system locale /// \return Reference to the default system locale
@ -670,6 +671,7 @@ typedef Utf<32> Utf32;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \class sf::Utf /// \class sf::Utf
/// \ingroup system
/// ///
/// Utility class providing generic functions for UTF conversions. /// Utility class providing generic functions for UTF conversions.
/// ///

View File

@ -61,6 +61,7 @@ public :
}; };
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \relates Vector2
/// \brief Overload of unary operator - /// \brief Overload of unary operator -
/// ///
/// \param right Vector to negate /// \param right Vector to negate
@ -72,6 +73,7 @@ template <typename T>
Vector2<T> operator -(const Vector2<T>& right); Vector2<T> operator -(const Vector2<T>& right);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \relates Vector2
/// \brief Overload of binary operator += /// \brief Overload of binary operator +=
/// ///
/// This operator performs a memberwise addition of both vectors, /// This operator performs a memberwise addition of both vectors,
@ -87,6 +89,7 @@ template <typename T>
Vector2<T>& operator +=(Vector2<T>& left, const Vector2<T>& right); Vector2<T>& operator +=(Vector2<T>& left, const Vector2<T>& right);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \relates Vector2
/// \brief Overload of binary operator -= /// \brief Overload of binary operator -=
/// ///
/// This operator performs a memberwise subtraction of both vectors, /// This operator performs a memberwise subtraction of both vectors,
@ -102,6 +105,7 @@ template <typename T>
Vector2<T>& operator -=(Vector2<T>& left, const Vector2<T>& right); Vector2<T>& operator -=(Vector2<T>& left, const Vector2<T>& right);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \relates Vector2
/// \brief Overload of binary operator + /// \brief Overload of binary operator +
/// ///
/// \param left Left operand (a vector) /// \param left Left operand (a vector)
@ -114,6 +118,7 @@ template <typename T>
Vector2<T> operator +(const Vector2<T>& left, const Vector2<T>& right); Vector2<T> operator +(const Vector2<T>& left, const Vector2<T>& right);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \relates Vector2
/// \brief Overload of binary operator - /// \brief Overload of binary operator -
/// ///
/// \param left Left operand (a vector) /// \param left Left operand (a vector)
@ -126,6 +131,7 @@ template <typename T>
Vector2<T> operator -(const Vector2<T>& left, const Vector2<T>& right); Vector2<T> operator -(const Vector2<T>& left, const Vector2<T>& right);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \relates Vector2
/// \brief Overload of binary operator * /// \brief Overload of binary operator *
/// ///
/// \param left Left operand (a vector) /// \param left Left operand (a vector)
@ -138,6 +144,7 @@ template <typename T>
Vector2<T> operator *(const Vector2<T>& left, T right); Vector2<T> operator *(const Vector2<T>& left, T right);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \relates Vector2
/// \brief Overload of binary operator * /// \brief Overload of binary operator *
/// ///
/// \param left Left operand (a scalar value) /// \param left Left operand (a scalar value)
@ -150,6 +157,7 @@ template <typename T>
Vector2<T> operator *(T left, const Vector2<T>& right); Vector2<T> operator *(T left, const Vector2<T>& right);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \relates Vector2
/// \brief Overload of binary operator *= /// \brief Overload of binary operator *=
/// ///
/// This operator performs a memberwise multiplication by \a right, /// This operator performs a memberwise multiplication by \a right,
@ -165,6 +173,7 @@ template <typename T>
Vector2<T>& operator *=(Vector2<T>& left, T right); Vector2<T>& operator *=(Vector2<T>& left, T right);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \relates Vector2
/// \brief Overload of binary operator / /// \brief Overload of binary operator /
/// ///
/// \param left Left operand (a scalar value) /// \param left Left operand (a scalar value)
@ -177,6 +186,7 @@ template <typename T>
Vector2<T> operator /(const Vector2<T>& left, T right); Vector2<T> operator /(const Vector2<T>& left, T right);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \relates Vector2
/// \brief Overload of binary operator /= /// \brief Overload of binary operator /=
/// ///
/// This operator performs a memberwise division by \a right, /// This operator performs a memberwise division by \a right,
@ -192,6 +202,7 @@ template <typename T>
Vector2<T>& operator /=(Vector2<T>& left, T right); Vector2<T>& operator /=(Vector2<T>& left, T right);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \relates Vector2
/// \brief Overload of binary operator == /// \brief Overload of binary operator ==
/// ///
/// This operator compares strict equality between two vectors. /// This operator compares strict equality between two vectors.
@ -206,6 +217,7 @@ template <typename T>
bool operator ==(const Vector2<T>& left, const Vector2<T>& right); bool operator ==(const Vector2<T>& left, const Vector2<T>& right);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \relates Vector2
/// \brief Overload of binary operator != /// \brief Overload of binary operator !=
/// ///
/// This operator compares strict difference between two vectors. /// This operator compares strict difference between two vectors.
@ -233,6 +245,7 @@ typedef Vector2<float> Vector2f;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \class sf::Vector2 /// \class sf::Vector2
/// \ingroup system
/// ///
/// sf::Vector2 is a simple class that defines a mathematical /// sf::Vector2 is a simple class that defines a mathematical
/// vector with two coordinates (x and y). It can be used to /// vector with two coordinates (x and y). It can be used to

View File

@ -63,6 +63,7 @@ public :
}; };
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \relates Vector3
/// \brief Overload of unary operator - /// \brief Overload of unary operator -
/// ///
/// \param right Vector to negate /// \param right Vector to negate
@ -74,6 +75,7 @@ template <typename T>
Vector3<T> operator -(const Vector3<T>& left); Vector3<T> operator -(const Vector3<T>& left);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \relates Vector3
/// \brief Overload of binary operator += /// \brief Overload of binary operator +=
/// ///
/// This operator performs a memberwise addition of both vectors, /// This operator performs a memberwise addition of both vectors,
@ -89,6 +91,7 @@ template <typename T>
Vector3<T>& operator +=(Vector3<T>& left, const Vector3<T>& right); Vector3<T>& operator +=(Vector3<T>& left, const Vector3<T>& right);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \relates Vector3
/// \brief Overload of binary operator -= /// \brief Overload of binary operator -=
/// ///
/// This operator performs a memberwise subtraction of both vectors, /// This operator performs a memberwise subtraction of both vectors,
@ -104,6 +107,7 @@ template <typename T>
Vector3<T>& operator -=(Vector3<T>& left, const Vector3<T>& right); Vector3<T>& operator -=(Vector3<T>& left, const Vector3<T>& right);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \relates Vector3
/// \brief Overload of binary operator + /// \brief Overload of binary operator +
/// ///
/// \param left Left operand (a vector) /// \param left Left operand (a vector)
@ -116,6 +120,7 @@ template <typename T>
Vector3<T> operator +(const Vector3<T>& left, const Vector3<T>& right); Vector3<T> operator +(const Vector3<T>& left, const Vector3<T>& right);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \relates Vector3
/// \brief Overload of binary operator - /// \brief Overload of binary operator -
/// ///
/// \param left Left operand (a vector) /// \param left Left operand (a vector)
@ -128,6 +133,7 @@ template <typename T>
Vector3<T> operator -(const Vector3<T>& left, const Vector3<T>& right); Vector3<T> operator -(const Vector3<T>& left, const Vector3<T>& right);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \relates Vector3
/// \brief Overload of binary operator * /// \brief Overload of binary operator *
/// ///
/// \param left Left operand (a vector) /// \param left Left operand (a vector)
@ -140,6 +146,7 @@ template <typename T>
Vector3<T> operator *(const Vector3<T>& left, T right); Vector3<T> operator *(const Vector3<T>& left, T right);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \relates Vector3
/// \brief Overload of binary operator * /// \brief Overload of binary operator *
/// ///
/// \param left Left operand (a scalar value) /// \param left Left operand (a scalar value)
@ -152,6 +159,7 @@ template <typename T>
Vector3<T> operator *(T left, const Vector3<T>& right); Vector3<T> operator *(T left, const Vector3<T>& right);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \relates Vector3
/// \brief Overload of binary operator *= /// \brief Overload of binary operator *=
/// ///
/// This operator performs a memberwise multiplication by \a right, /// This operator performs a memberwise multiplication by \a right,
@ -167,6 +175,7 @@ template <typename T>
Vector3<T>& operator *=(Vector3<T>& left, T right); Vector3<T>& operator *=(Vector3<T>& left, T right);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \relates Vector3
/// \brief Overload of binary operator / /// \brief Overload of binary operator /
/// ///
/// \param left Left operand (a scalar value) /// \param left Left operand (a scalar value)
@ -179,6 +188,7 @@ template <typename T>
Vector3<T> operator /(const Vector3<T>& left, T right); Vector3<T> operator /(const Vector3<T>& left, T right);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \relates Vector3
/// \brief Overload of binary operator /= /// \brief Overload of binary operator /=
/// ///
/// This operator performs a memberwise division by \a right, /// This operator performs a memberwise division by \a right,
@ -194,6 +204,7 @@ template <typename T>
Vector3<T>& operator /=(Vector3<T>& left, T right); Vector3<T>& operator /=(Vector3<T>& left, T right);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \relates Vector3
/// \brief Overload of binary operator == /// \brief Overload of binary operator ==
/// ///
/// This operator compares strict equality between two vectors. /// This operator compares strict equality between two vectors.
@ -208,6 +219,7 @@ template <typename T>
bool operator ==(const Vector3<T>& left, const Vector3<T>& right); bool operator ==(const Vector3<T>& left, const Vector3<T>& right);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \relates Vector3
/// \brief Overload of binary operator != /// \brief Overload of binary operator !=
/// ///
/// This operator compares strict difference between two vectors. /// This operator compares strict difference between two vectors.
@ -235,6 +247,7 @@ typedef Vector3<float> Vector3f;
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \class sf::Vector3 /// \class sf::Vector3
/// \ingroup system
/// ///
/// sf::Vector3 is a simple class that defines a mathematical /// sf::Vector3 is a simple class that defines a mathematical
/// vector with three coordinates (x, y and z). It can be used to /// vector with three coordinates (x, y and z). It can be used to

View File

@ -40,3 +40,8 @@
#endif // SFML_SFML_WINDOW_HPP #endif // SFML_SFML_WINDOW_HPP
////////////////////////////////////////////////////////////
/// \defgroup window Window module
///
////////////////////////////////////////////////////////////

View File

@ -98,6 +98,7 @@ private :
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \class sf::Context /// \class sf::Context
/// \ingroup window
/// ///
/// If you need to make OpenGL / graphics calls without /// If you need to make OpenGL / graphics calls without
/// having an active window (like in a thread), you can use /// having an active window (like in a thread), you can use

View File

@ -72,6 +72,7 @@ struct ContextSettings
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \class sf::ContextSettings /// \class sf::ContextSettings
/// \ingroup window
/// ///
/// ContextSettings allows to define several advanced settings /// ContextSettings allows to define several advanced settings
/// of the OpenGL context attached to a window. All these /// of the OpenGL context attached to a window. All these

View File

@ -36,6 +36,7 @@ namespace sf
namespace Key namespace Key
{ {
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \ingroup window
/// \brief Definition of key codes for keyboard events /// \brief Definition of key codes for keyboard events
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
@ -151,6 +152,7 @@ namespace Key
namespace Mouse namespace Mouse
{ {
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \ingroup window
/// \brief Definition of button codes for mouse events /// \brief Definition of button codes for mouse events
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
@ -170,6 +172,7 @@ namespace Mouse
namespace Joy namespace Joy
{ {
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \ingroup window
/// \brief Definition of joystick axis for joystick events /// \brief Definition of joystick axis for joystick events
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
@ -340,6 +343,7 @@ public :
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \class sf::Event /// \class sf::Event
/// \ingroup window
/// ///
/// sf::Event holds all the informations about a system event /// sf::Event holds all the informations about a system event
/// that just happened. Events are retrieved using the /// that just happened. Events are retrieved using the

View File

@ -159,6 +159,7 @@ private :
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \class sf::Input /// \class sf::Input
/// \ingroup window
/// ///
/// sf::Input provides a way to access the state of keys, /// sf::Input provides a way to access the state of keys,
/// mouse buttons, mouse position, joystick buttons and /// mouse buttons, mouse position, joystick buttons and

View File

@ -105,6 +105,7 @@ public :
}; };
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \relates VideoMode
/// \brief Overload of == operator to compare two video modes /// \brief Overload of == operator to compare two video modes
/// ///
/// \param left Left operand (a video mode) /// \param left Left operand (a video mode)
@ -116,6 +117,7 @@ public :
SFML_API bool operator ==(const VideoMode& left, const VideoMode& right); SFML_API bool operator ==(const VideoMode& left, const VideoMode& right);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \relates VideoMode
/// \brief Overload of != operator to compare two video modes /// \brief Overload of != operator to compare two video modes
/// ///
/// \param left Left operand (a video mode) /// \param left Left operand (a video mode)
@ -127,6 +129,7 @@ SFML_API bool operator ==(const VideoMode& left, const VideoMode& right);
SFML_API bool operator !=(const VideoMode& left, const VideoMode& right); SFML_API bool operator !=(const VideoMode& left, const VideoMode& right);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \relates VideoMode
/// \brief Overload of < operator to compare video modes /// \brief Overload of < operator to compare video modes
/// ///
/// \param left Left operand (a video mode) /// \param left Left operand (a video mode)
@ -138,6 +141,7 @@ SFML_API bool operator !=(const VideoMode& left, const VideoMode& right);
SFML_API bool operator <(const VideoMode& left, const VideoMode& right); SFML_API bool operator <(const VideoMode& left, const VideoMode& right);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \relates VideoMode
/// \brief Overload of > operator to compare video modes /// \brief Overload of > operator to compare video modes
/// ///
/// \param left Left operand (a video mode) /// \param left Left operand (a video mode)
@ -149,6 +153,7 @@ SFML_API bool operator <(const VideoMode& left, const VideoMode& right);
SFML_API bool operator >(const VideoMode& left, const VideoMode& right); SFML_API bool operator >(const VideoMode& left, const VideoMode& right);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \relates VideoMode
/// \brief Overload of <= operator to compare video modes /// \brief Overload of <= operator to compare video modes
/// ///
/// \param left Left operand (a video mode) /// \param left Left operand (a video mode)
@ -160,6 +165,7 @@ SFML_API bool operator >(const VideoMode& left, const VideoMode& right);
SFML_API bool operator <=(const VideoMode& left, const VideoMode& right); SFML_API bool operator <=(const VideoMode& left, const VideoMode& right);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \relates VideoMode
/// \brief Overload of >= operator to compare video modes /// \brief Overload of >= operator to compare video modes
/// ///
/// \param left Left operand (a video mode) /// \param left Left operand (a video mode)
@ -178,6 +184,7 @@ SFML_API bool operator >=(const VideoMode& left, const VideoMode& right);
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \class sf::VideoMode /// \class sf::VideoMode
/// \ingroup window
/// ///
/// A video mode is defined by a width and a height (in pixels) /// A video mode is defined by a width and a height (in pixels)
/// and a depth (in bits per pixel). Video modes are used to /// and a depth (in bits per pixel). Video modes are used to

View File

@ -510,6 +510,7 @@ private :
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \class sf::Window /// \class sf::Window
/// \ingroup window
/// ///
/// sf::Window is the main class of the Window module. It defines /// sf::Window is the main class of the Window module. It defines
/// an OS window that is able to receive an OpenGL rendering. /// an OS window that is able to receive an OpenGL rendering.

View File

@ -31,6 +31,7 @@ namespace sf
namespace Style namespace Style
{ {
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
/// \ingroup window
/// \brief Enumeration of the window styles /// \brief Enumeration of the window styles
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////