From 0444781a4bac4daaa8038980b7d9b77ca83eaa09 Mon Sep 17 00:00:00 2001 From: LaurentGom Date: Thu, 22 Jul 2010 21:45:58 +0000 Subject: [PATCH] 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/Audio.hpp | 5 +++++ include/SFML/Audio/Listener.hpp | 1 + include/SFML/Audio/Music.hpp | 1 + include/SFML/Audio/Sound.hpp | 1 + include/SFML/Audio/SoundBuffer.hpp | 1 + include/SFML/Audio/SoundBufferRecorder.hpp | 1 + include/SFML/Audio/SoundRecorder.hpp | 1 + include/SFML/Audio/SoundSource.hpp | 1 + include/SFML/Audio/SoundStream.hpp | 1 + include/SFML/Graphics.hpp | 5 +++++ include/SFML/Graphics/Color.hpp | 7 +++++++ include/SFML/Graphics/Drawable.hpp | 2 ++ include/SFML/Graphics/Font.hpp | 1 + include/SFML/Graphics/Glyph.hpp | 1 + include/SFML/Graphics/Image.hpp | 1 + include/SFML/Graphics/Matrix3.hpp | 1 + include/SFML/Graphics/Rect.hpp | 1 + include/SFML/Graphics/RenderImage.hpp | 1 + include/SFML/Graphics/RenderTarget.hpp | 1 + include/SFML/Graphics/RenderWindow.hpp | 1 + include/SFML/Graphics/Renderer.hpp | 1 + include/SFML/Graphics/Shader.hpp | 1 + include/SFML/Graphics/Shape.hpp | 1 + include/SFML/Graphics/Sprite.hpp | 1 + include/SFML/Graphics/Text.hpp | 1 + include/SFML/Graphics/View.hpp | 1 + include/SFML/Network.hpp | 5 +++++ include/SFML/Network/Ftp.hpp | 1 + include/SFML/Network/Http.hpp | 1 + include/SFML/Network/IpAddress.hpp | 1 + include/SFML/Network/Packet.hpp | 1 + include/SFML/Network/Socket.hpp | 1 + include/SFML/Network/SocketSelector.hpp | 1 + include/SFML/Network/TcpListener.hpp | 1 + include/SFML/Network/TcpSocket.hpp | 1 + include/SFML/Network/UdpSocket.hpp | 1 + include/SFML/System.hpp | 5 +++++ include/SFML/System/Clock.hpp | 1 + include/SFML/System/Err.hpp | 1 + include/SFML/System/Lock.hpp | 1 + include/SFML/System/Mutex.hpp | 1 + include/SFML/System/NonCopyable.hpp | 1 + include/SFML/System/Randomizer.hpp | 1 + include/SFML/System/Resource.hpp | 2 ++ include/SFML/System/Sleep.hpp | 1 + include/SFML/System/String.hpp | 8 ++++++++ include/SFML/System/Thread.hpp | 1 + include/SFML/System/ThreadLocal.hpp | 1 + include/SFML/System/ThreadLocalPtr.hpp | 1 + include/SFML/System/Utf.hpp | 2 ++ include/SFML/System/Vector2.hpp | 13 +++++++++++++ include/SFML/System/Vector3.hpp | 13 +++++++++++++ include/SFML/Window.hpp | 5 +++++ include/SFML/Window/Context.hpp | 1 + include/SFML/Window/ContextSettings.hpp | 1 + include/SFML/Window/Event.hpp | 4 ++++ include/SFML/Window/Input.hpp | 1 + include/SFML/Window/VideoMode.hpp | 7 +++++++ include/SFML/Window/Window.hpp | 1 + include/SFML/Window/WindowStyle.hpp | 1 + 60 files changed, 129 insertions(+) diff --git a/include/SFML/Audio.hpp b/include/SFML/Audio.hpp index 9a83a735..7b02c2df 100644 --- a/include/SFML/Audio.hpp +++ b/include/SFML/Audio.hpp @@ -40,3 +40,8 @@ #endif // SFML_AUDIO_HPP + +//////////////////////////////////////////////////////////// +/// \defgroup audio Audio module +/// +//////////////////////////////////////////////////////////// diff --git a/include/SFML/Audio/Listener.hpp b/include/SFML/Audio/Listener.hpp index c34ac164..a8bc1b35 100644 --- a/include/SFML/Audio/Listener.hpp +++ b/include/SFML/Audio/Listener.hpp @@ -154,6 +154,7 @@ public : //////////////////////////////////////////////////////////// /// \class sf::Listener +/// \ingroup audio /// /// The audio listener defines the global properties of the /// audio environment, it defines where and how sounds and musics diff --git a/include/SFML/Audio/Music.hpp b/include/SFML/Audio/Music.hpp index 0bbb98ec..b082b452 100644 --- a/include/SFML/Audio/Music.hpp +++ b/include/SFML/Audio/Music.hpp @@ -146,6 +146,7 @@ private : //////////////////////////////////////////////////////////// /// \class sf::Music +/// \ingroup audio /// /// Musics are sounds that are streamed rather than completely /// loaded in memory. This is especially useful for compressed diff --git a/include/SFML/Audio/Sound.hpp b/include/SFML/Audio/Sound.hpp index 7b4ef3c5..8ff69e34 100644 --- a/include/SFML/Audio/Sound.hpp +++ b/include/SFML/Audio/Sound.hpp @@ -228,6 +228,7 @@ private : //////////////////////////////////////////////////////////// /// \class sf::Sound +/// \ingroup audio /// /// sf::Sound is the class to use to play sounds. /// It provides: diff --git a/include/SFML/Audio/SoundBuffer.hpp b/include/SFML/Audio/SoundBuffer.hpp index 1a060183..d738294f 100644 --- a/include/SFML/Audio/SoundBuffer.hpp +++ b/include/SFML/Audio/SoundBuffer.hpp @@ -261,6 +261,7 @@ private : //////////////////////////////////////////////////////////// /// \class sf::SoundBuffer +/// \ingroup audio /// /// A sound buffer holds the data of a sound, which is /// an array of audio samples. A sample is a 16 bits signed integer diff --git a/include/SFML/Audio/SoundBufferRecorder.hpp b/include/SFML/Audio/SoundBufferRecorder.hpp index 8e59927f..7d56bce7 100644 --- a/include/SFML/Audio/SoundBufferRecorder.hpp +++ b/include/SFML/Audio/SoundBufferRecorder.hpp @@ -98,6 +98,7 @@ private : //////////////////////////////////////////////////////////// /// \class sf::SoundBufferRecorder +/// \ingroup audio /// /// sf::SoundBufferRecorder allows to access a recorded sound /// through a sf::SoundBuffer, so that it can be played, saved diff --git a/include/SFML/Audio/SoundRecorder.hpp b/include/SFML/Audio/SoundRecorder.hpp index 014fbfbf..f7e99790 100644 --- a/include/SFML/Audio/SoundRecorder.hpp +++ b/include/SFML/Audio/SoundRecorder.hpp @@ -193,6 +193,7 @@ private : //////////////////////////////////////////////////////////// /// \class sf::SoundRecorder +/// \ingroup audio /// /// sf::SoundBuffer provides a simple interface to access /// the audio recording capabilities of the computer diff --git a/include/SFML/Audio/SoundSource.hpp b/include/SFML/Audio/SoundSource.hpp index 6c149a5f..cc75a801 100644 --- a/include/SFML/Audio/SoundSource.hpp +++ b/include/SFML/Audio/SoundSource.hpp @@ -271,6 +271,7 @@ protected : //////////////////////////////////////////////////////////// /// \class sf::SoundSource +/// \ingroup audio /// /// sf::SoundSource is not meant to be used directly, it /// only serves as a common base for all audio objects diff --git a/include/SFML/Audio/SoundStream.hpp b/include/SFML/Audio/SoundStream.hpp index efd8afa0..38ddde27 100644 --- a/include/SFML/Audio/SoundStream.hpp +++ b/include/SFML/Audio/SoundStream.hpp @@ -296,6 +296,7 @@ private : //////////////////////////////////////////////////////////// /// \class sf::SoundStream +/// \ingroup audio /// /// Unlike audio buffers (see sf::SoundBuffer), audio streams /// are never completely loaded in memory. Instead, the audio diff --git a/include/SFML/Graphics.hpp b/include/SFML/Graphics.hpp index d45e71ff..7ad60b2a 100644 --- a/include/SFML/Graphics.hpp +++ b/include/SFML/Graphics.hpp @@ -45,3 +45,8 @@ #endif // SFML_GRAPHICS_HPP + +//////////////////////////////////////////////////////////// +/// \defgroup graphics Graphics module +/// +//////////////////////////////////////////////////////////// diff --git a/include/SFML/Graphics/Color.hpp b/include/SFML/Graphics/Color.hpp index 61e43fb8..8307ad72 100644 --- a/include/SFML/Graphics/Color.hpp +++ b/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 diff --git a/include/SFML/Graphics/Drawable.hpp b/include/SFML/Graphics/Drawable.hpp index 7f38735a..eec721e8 100644 --- a/include/SFML/Graphics/Drawable.hpp +++ b/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: diff --git a/include/SFML/Graphics/Font.hpp b/include/SFML/Graphics/Font.hpp index c7b13a27..de5415e2 100644 --- a/include/SFML/Graphics/Font.hpp +++ b/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 diff --git a/include/SFML/Graphics/Glyph.hpp b/include/SFML/Graphics/Glyph.hpp index 40b281f5..1b7f42f6 100644 --- a/include/SFML/Graphics/Glyph.hpp +++ b/include/SFML/Graphics/Glyph.hpp @@ -64,6 +64,7 @@ public : //////////////////////////////////////////////////////////// /// \class sf::Glyph +/// \ingroup graphics /// /// A glyph is the visual representation of a character. /// diff --git a/include/SFML/Graphics/Image.hpp b/include/SFML/Graphics/Image.hpp index c63e1d1c..2ec14a9d 100644 --- a/include/SFML/Graphics/Image.hpp +++ b/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 diff --git a/include/SFML/Graphics/Matrix3.hpp b/include/SFML/Graphics/Matrix3.hpp index 7c486a26..5760568d 100644 --- a/include/SFML/Graphics/Matrix3.hpp +++ b/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 diff --git a/include/SFML/Graphics/Rect.hpp b/include/SFML/Graphics/Rect.hpp index f152b03c..80c941d3 100644 --- a/include/SFML/Graphics/Rect.hpp +++ b/include/SFML/Graphics/Rect.hpp @@ -154,6 +154,7 @@ typedef Rect 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 diff --git a/include/SFML/Graphics/RenderImage.hpp b/include/SFML/Graphics/RenderImage.hpp index a1cbedd5..aa65cd09 100644 --- a/include/SFML/Graphics/RenderImage.hpp +++ b/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 diff --git a/include/SFML/Graphics/RenderTarget.hpp b/include/SFML/Graphics/RenderTarget.hpp index 7adb19f2..78172431 100644 --- a/include/SFML/Graphics/RenderTarget.hpp +++ b/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 diff --git a/include/SFML/Graphics/RenderWindow.hpp b/include/SFML/Graphics/RenderWindow.hpp index bb2f8e81..3b81183c 100644 --- a/include/SFML/Graphics/RenderWindow.hpp +++ b/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 diff --git a/include/SFML/Graphics/Renderer.hpp b/include/SFML/Graphics/Renderer.hpp index afd335ee..ead24ca3 100644 --- a/include/SFML/Graphics/Renderer.hpp +++ b/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 diff --git a/include/SFML/Graphics/Shader.hpp b/include/SFML/Graphics/Shader.hpp index b6fde662..e49f3454 100644 --- a/include/SFML/Graphics/Shader.hpp +++ b/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 diff --git a/include/SFML/Graphics/Shape.hpp b/include/SFML/Graphics/Shape.hpp index d5c8706c..4b2afd9e 100644 --- a/include/SFML/Graphics/Shape.hpp +++ b/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. diff --git a/include/SFML/Graphics/Sprite.hpp b/include/SFML/Graphics/Sprite.hpp index 7759a191..2f75ecf7 100644 --- a/include/SFML/Graphics/Sprite.hpp +++ b/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. diff --git a/include/SFML/Graphics/Text.hpp b/include/SFML/Graphics/Text.hpp index dabdc544..1aa45aa7 100644 --- a/include/SFML/Graphics/Text.hpp +++ b/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. diff --git a/include/SFML/Graphics/View.hpp b/include/SFML/Graphics/View.hpp index 62fb09f7..15474cdd 100644 --- a/include/SFML/Graphics/View.hpp +++ b/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 diff --git a/include/SFML/Network.hpp b/include/SFML/Network.hpp index 19696ae7..c21b723d 100644 --- a/include/SFML/Network.hpp +++ b/include/SFML/Network.hpp @@ -41,3 +41,8 @@ #endif // SFML_NETWORK_HPP + +//////////////////////////////////////////////////////////// +/// \defgroup network Network module +/// +//////////////////////////////////////////////////////////// diff --git a/include/SFML/Network/Ftp.hpp b/include/SFML/Network/Ftp.hpp index 047f5db5..aa54c17c 100644 --- a/include/SFML/Network/Ftp.hpp +++ b/include/SFML/Network/Ftp.hpp @@ -532,6 +532,7 @@ private : //////////////////////////////////////////////////////////// /// \class sf::Ftp +/// \ingroup network /// /// sf::Ftp is a very simple FTP client that allows you /// to communicate with a FTP server. The FTP protocol allows diff --git a/include/SFML/Network/Http.hpp b/include/SFML/Network/Http.hpp index f79bc81c..033d37b4 100644 --- a/include/SFML/Network/Http.hpp +++ b/include/SFML/Network/Http.hpp @@ -407,6 +407,7 @@ private : //////////////////////////////////////////////////////////// /// \class sf::Http +/// \ingroup network /// /// sf::Http is a very simple HTTP client that allows you /// to communicate with a web server. You can retrieve diff --git a/include/SFML/Network/IpAddress.hpp b/include/SFML/Network/IpAddress.hpp index 7e2c6e72..ace8bc5e 100644 --- a/include/SFML/Network/IpAddress.hpp +++ b/include/SFML/Network/IpAddress.hpp @@ -287,6 +287,7 @@ SFML_API std::ostream& operator <<(std::ostream& stream, const IpAddress& addres //////////////////////////////////////////////////////////// /// \class sf::IpAddress +/// \ingroup network /// /// sf::IpAddress is a utility class for manipulating network /// addresses. It provides a set a implicit constructors and diff --git a/include/SFML/Network/Packet.hpp b/include/SFML/Network/Packet.hpp index 04f87401..4c8c6404 100644 --- a/include/SFML/Network/Packet.hpp +++ b/include/SFML/Network/Packet.hpp @@ -269,6 +269,7 @@ private : //////////////////////////////////////////////////////////// /// \class sf::Packet +/// \ingroup network /// /// Packets provide a safe and easy way to serialize data, /// in order to send it over the network using sockets diff --git a/include/SFML/Network/Socket.hpp b/include/SFML/Network/Socket.hpp index 4a9e4d5c..403acacb 100644 --- a/include/SFML/Network/Socket.hpp +++ b/include/SFML/Network/Socket.hpp @@ -202,6 +202,7 @@ private : //////////////////////////////////////////////////////////// /// \class sf::Socket +/// \ingroup network /// /// This class mainly defines internal stuff to be used by /// derived classes. diff --git a/include/SFML/Network/SocketSelector.hpp b/include/SFML/Network/SocketSelector.hpp index 754206a6..9c505492 100644 --- a/include/SFML/Network/SocketSelector.hpp +++ b/include/SFML/Network/SocketSelector.hpp @@ -167,6 +167,7 @@ private : //////////////////////////////////////////////////////////// /// \class sf::SocketSelector +/// \ingroup network /// /// Socket selectors provide a way to wait until some data is /// available on a set of sockets, instead of just one. This diff --git a/include/SFML/Network/TcpListener.hpp b/include/SFML/Network/TcpListener.hpp index 4d2eb8f7..93694504 100644 --- a/include/SFML/Network/TcpListener.hpp +++ b/include/SFML/Network/TcpListener.hpp @@ -104,6 +104,7 @@ public : //////////////////////////////////////////////////////////// /// \class sf::TcpListener +/// \ingroup network /// /// A listener socket is a special type of socket that listens to /// a given port and waits for connections on that port. diff --git a/include/SFML/Network/TcpSocket.hpp b/include/SFML/Network/TcpSocket.hpp index c83b6978..424304e8 100644 --- a/include/SFML/Network/TcpSocket.hpp +++ b/include/SFML/Network/TcpSocket.hpp @@ -193,6 +193,7 @@ public : //////////////////////////////////////////////////////////// /// \class sf::TcpSocket +/// \ingroup network /// /// TCP is a connected protocol, which means that a TCP /// socket can only communicate with the host it is connected diff --git a/include/SFML/Network/UdpSocket.hpp b/include/SFML/Network/UdpSocket.hpp index 2782b1da..c12e4977 100644 --- a/include/SFML/Network/UdpSocket.hpp +++ b/include/SFML/Network/UdpSocket.hpp @@ -190,6 +190,7 @@ public : //////////////////////////////////////////////////////////// /// \class sf::UdpSocket +/// \ingroup network /// /// A UDP socket is a connectionless socket. Instead of /// connecting once to a remote host, like TCP sockets, diff --git a/include/SFML/System.hpp b/include/SFML/System.hpp index 02e3b69f..f787bb3b 100644 --- a/include/SFML/System.hpp +++ b/include/SFML/System.hpp @@ -45,3 +45,8 @@ #include #endif // SFML_SYSTEM_HPP + +//////////////////////////////////////////////////////////// +/// \defgroup system System module +/// +//////////////////////////////////////////////////////////// diff --git a/include/SFML/System/Clock.hpp b/include/SFML/System/Clock.hpp index 55be19c1..69000653 100644 --- a/include/SFML/System/Clock.hpp +++ b/include/SFML/System/Clock.hpp @@ -85,6 +85,7 @@ private : //////////////////////////////////////////////////////////// /// \class sf::Clock +/// \ingroup system /// /// sf::Clock is a lightweight class for measuring time. /// Its resolution depends on the underlying OS, but you can generally diff --git a/include/SFML/System/Err.hpp b/include/SFML/System/Err.hpp index d294dcd9..c66749d2 100644 --- a/include/SFML/System/Err.hpp +++ b/include/SFML/System/Err.hpp @@ -48,6 +48,7 @@ SFML_API std::ostream& Err(); //////////////////////////////////////////////////////////// /// \fn sf::Err +/// \ingroup system /// /// By default, sf::Err() outputs to the same location as std::cerr, /// (-> the stderr descriptor) which is the console if there's diff --git a/include/SFML/System/Lock.hpp b/include/SFML/System/Lock.hpp index 97190ae5..f7d082d9 100644 --- a/include/SFML/System/Lock.hpp +++ b/include/SFML/System/Lock.hpp @@ -77,6 +77,7 @@ private : //////////////////////////////////////////////////////////// /// \class sf::Lock +/// \ingroup system /// /// sf::Lock is a RAII wrapper for sf::Mutex. By unlocking /// it in its destructor, it ensures that the mutex will diff --git a/include/SFML/System/Mutex.hpp b/include/SFML/System/Mutex.hpp index 781b4a7a..4b8e3d8e 100644 --- a/include/SFML/System/Mutex.hpp +++ b/include/SFML/System/Mutex.hpp @@ -96,6 +96,7 @@ private : //////////////////////////////////////////////////////////// /// \class sf::Mutex +/// \ingroup system /// /// Mutex stands for "MUTual EXclusion". A mutex is a /// synchronization object, used when multiple threads are involved. diff --git a/include/SFML/System/NonCopyable.hpp b/include/SFML/System/NonCopyable.hpp index 5dd5e8a6..deff871e 100644 --- a/include/SFML/System/NonCopyable.hpp +++ b/include/SFML/System/NonCopyable.hpp @@ -87,6 +87,7 @@ private : //////////////////////////////////////////////////////////// /// \class sf::NonCopyable +/// \ingroup system /// /// This class makes its instances non-copyable, by explicitely /// disabling its copy constructor and its assignment operator. diff --git a/include/SFML/System/Randomizer.hpp b/include/SFML/System/Randomizer.hpp index ca54d6ef..f7a82298 100644 --- a/include/SFML/System/Randomizer.hpp +++ b/include/SFML/System/Randomizer.hpp @@ -91,6 +91,7 @@ public : //////////////////////////////////////////////////////////// /// \class sf::Randomizer +/// \ingroup system /// /// sf::Randomizer generates pseudo-random numbers using the /// standard library. diff --git a/include/SFML/System/Resource.hpp b/include/SFML/System/Resource.hpp index c94180ea..236adeb5 100644 --- a/include/SFML/System/Resource.hpp +++ b/include/SFML/System/Resource.hpp @@ -243,6 +243,7 @@ private : //////////////////////////////////////////////////////////// /// \class sf::Resource +/// \ingroup system /// /// sf::Resource is a base for classes that want to be /// compatible with the sf::ResourcePtr safe pointer. @@ -256,6 +257,7 @@ private : //////////////////////////////////////////////////////////// /// \class sf::ResourcePtr +/// \ingroup system /// /// sf::ResourcePtr is a special kind of smart pointer for /// resources. Its main feature is to automatically diff --git a/include/SFML/System/Sleep.hpp b/include/SFML/System/Sleep.hpp index a4f9cda9..208b5a4e 100644 --- a/include/SFML/System/Sleep.hpp +++ b/include/SFML/System/Sleep.hpp @@ -34,6 +34,7 @@ namespace sf { //////////////////////////////////////////////////////////// +/// \ingroup system /// \brief Make the current thread sleep for a given time /// /// sf::Sleep is the best way to block a program or one of its diff --git a/include/SFML/System/String.hpp b/include/SFML/System/String.hpp index 825390cf..434fe408 100644 --- a/include/SFML/System/String.hpp +++ b/include/SFML/System/String.hpp @@ -461,6 +461,7 @@ private : }; //////////////////////////////////////////////////////////// +/// \relates String /// \brief Overload of == operator to compare two UTF-32 strings /// /// \param left Left operand (a string) @@ -472,6 +473,7 @@ private : SFML_API bool operator ==(const String& left, const String& right); //////////////////////////////////////////////////////////// +/// \relates String /// \brief Overload of != operator to compare two UTF-32 strings /// /// \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); //////////////////////////////////////////////////////////// +/// \relates String /// \brief Overload of < operator to compare two UTF-32 strings /// /// \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); //////////////////////////////////////////////////////////// +/// \relates String /// \brief Overload of > operator to compare two UTF-32 strings /// /// \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); //////////////////////////////////////////////////////////// +/// \relates String /// \brief Overload of <= operator to compare two UTF-32 strings /// /// \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); //////////////////////////////////////////////////////////// +/// \relates String /// \brief Overload of >= operator to compare two UTF-32 strings /// /// \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); //////////////////////////////////////////////////////////// +/// \relates String /// \brief Overload of binary + operator to concatenate two strings /// /// \param left Left operand (a string) @@ -545,6 +552,7 @@ SFML_API String operator +(const String& left, const String& right); //////////////////////////////////////////////////////////// /// \class sf::String +/// \ingroup system /// /// sf::String is a utility string class defined mainly for /// convenience. It is a Unicode string (implemented using diff --git a/include/SFML/System/Thread.hpp b/include/SFML/System/Thread.hpp index ab399066..8978e89a 100644 --- a/include/SFML/System/Thread.hpp +++ b/include/SFML/System/Thread.hpp @@ -135,6 +135,7 @@ private : //////////////////////////////////////////////////////////// /// \class sf::Thread +/// \ingroup system /// /// Threads provide a way to run multiple parts of the code /// in parallel. When you launch a new thread, the execution diff --git a/include/SFML/System/ThreadLocal.hpp b/include/SFML/System/ThreadLocal.hpp index f4d43f52..5d4d2e49 100644 --- a/include/SFML/System/ThreadLocal.hpp +++ b/include/SFML/System/ThreadLocal.hpp @@ -94,6 +94,7 @@ private : //////////////////////////////////////////////////////////// /// \class sf::ThreadLocal +/// \ingroup system /// /// This class manipulates void* parameters and thus is not /// appropriate for strongly-typed variables. You should rather diff --git a/include/SFML/System/ThreadLocalPtr.hpp b/include/SFML/System/ThreadLocalPtr.hpp index d1704e35..7c7813f7 100644 --- a/include/SFML/System/ThreadLocalPtr.hpp +++ b/include/SFML/System/ThreadLocalPtr.hpp @@ -112,6 +112,7 @@ public : //////////////////////////////////////////////////////////// /// \class sf::ThreadLocalPtr +/// \ingroup system /// /// sf::ThreadLocalPtr is a type-safe wrapper for storing /// pointers to thread-local variables. A thread-local diff --git a/include/SFML/System/Utf.hpp b/include/SFML/System/Utf.hpp index ae3b4351..d390c901 100644 --- a/include/SFML/System/Utf.hpp +++ b/include/SFML/System/Utf.hpp @@ -38,6 +38,7 @@ namespace sf { //////////////////////////////////////////////////////////// +/// \ingroup system /// \brief Get the default system locale /// /// \return Reference to the default system locale @@ -670,6 +671,7 @@ typedef Utf<32> Utf32; //////////////////////////////////////////////////////////// /// \class sf::Utf +/// \ingroup system /// /// Utility class providing generic functions for UTF conversions. /// diff --git a/include/SFML/System/Vector2.hpp b/include/SFML/System/Vector2.hpp index 2bab6a32..ca2ee3ea 100644 --- a/include/SFML/System/Vector2.hpp +++ b/include/SFML/System/Vector2.hpp @@ -61,6 +61,7 @@ public : }; //////////////////////////////////////////////////////////// +/// \relates Vector2 /// \brief Overload of unary operator - /// /// \param right Vector to negate @@ -72,6 +73,7 @@ template Vector2 operator -(const Vector2& right); //////////////////////////////////////////////////////////// +/// \relates Vector2 /// \brief Overload of binary operator += /// /// This operator performs a memberwise addition of both vectors, @@ -87,6 +89,7 @@ template Vector2& operator +=(Vector2& left, const Vector2& right); //////////////////////////////////////////////////////////// +/// \relates Vector2 /// \brief Overload of binary operator -= /// /// This operator performs a memberwise subtraction of both vectors, @@ -102,6 +105,7 @@ template Vector2& operator -=(Vector2& left, const Vector2& right); //////////////////////////////////////////////////////////// +/// \relates Vector2 /// \brief Overload of binary operator + /// /// \param left Left operand (a vector) @@ -114,6 +118,7 @@ template Vector2 operator +(const Vector2& left, const Vector2& right); //////////////////////////////////////////////////////////// +/// \relates Vector2 /// \brief Overload of binary operator - /// /// \param left Left operand (a vector) @@ -126,6 +131,7 @@ template Vector2 operator -(const Vector2& left, const Vector2& right); //////////////////////////////////////////////////////////// +/// \relates Vector2 /// \brief Overload of binary operator * /// /// \param left Left operand (a vector) @@ -138,6 +144,7 @@ template Vector2 operator *(const Vector2& left, T right); //////////////////////////////////////////////////////////// +/// \relates Vector2 /// \brief Overload of binary operator * /// /// \param left Left operand (a scalar value) @@ -150,6 +157,7 @@ template Vector2 operator *(T left, const Vector2& right); //////////////////////////////////////////////////////////// +/// \relates Vector2 /// \brief Overload of binary operator *= /// /// This operator performs a memberwise multiplication by \a right, @@ -165,6 +173,7 @@ template Vector2& operator *=(Vector2& left, T right); //////////////////////////////////////////////////////////// +/// \relates Vector2 /// \brief Overload of binary operator / /// /// \param left Left operand (a scalar value) @@ -177,6 +186,7 @@ template Vector2 operator /(const Vector2& left, T right); //////////////////////////////////////////////////////////// +/// \relates Vector2 /// \brief Overload of binary operator /= /// /// This operator performs a memberwise division by \a right, @@ -192,6 +202,7 @@ template Vector2& operator /=(Vector2& left, T right); //////////////////////////////////////////////////////////// +/// \relates Vector2 /// \brief Overload of binary operator == /// /// This operator compares strict equality between two vectors. @@ -206,6 +217,7 @@ template bool operator ==(const Vector2& left, const Vector2& right); //////////////////////////////////////////////////////////// +/// \relates Vector2 /// \brief Overload of binary operator != /// /// This operator compares strict difference between two vectors. @@ -233,6 +245,7 @@ typedef Vector2 Vector2f; //////////////////////////////////////////////////////////// /// \class sf::Vector2 +/// \ingroup system /// /// sf::Vector2 is a simple class that defines a mathematical /// vector with two coordinates (x and y). It can be used to diff --git a/include/SFML/System/Vector3.hpp b/include/SFML/System/Vector3.hpp index 954889ab..1e19e6f2 100644 --- a/include/SFML/System/Vector3.hpp +++ b/include/SFML/System/Vector3.hpp @@ -63,6 +63,7 @@ public : }; //////////////////////////////////////////////////////////// +/// \relates Vector3 /// \brief Overload of unary operator - /// /// \param right Vector to negate @@ -74,6 +75,7 @@ template Vector3 operator -(const Vector3& left); //////////////////////////////////////////////////////////// +/// \relates Vector3 /// \brief Overload of binary operator += /// /// This operator performs a memberwise addition of both vectors, @@ -89,6 +91,7 @@ template Vector3& operator +=(Vector3& left, const Vector3& right); //////////////////////////////////////////////////////////// +/// \relates Vector3 /// \brief Overload of binary operator -= /// /// This operator performs a memberwise subtraction of both vectors, @@ -104,6 +107,7 @@ template Vector3& operator -=(Vector3& left, const Vector3& right); //////////////////////////////////////////////////////////// +/// \relates Vector3 /// \brief Overload of binary operator + /// /// \param left Left operand (a vector) @@ -116,6 +120,7 @@ template Vector3 operator +(const Vector3& left, const Vector3& right); //////////////////////////////////////////////////////////// +/// \relates Vector3 /// \brief Overload of binary operator - /// /// \param left Left operand (a vector) @@ -128,6 +133,7 @@ template Vector3 operator -(const Vector3& left, const Vector3& right); //////////////////////////////////////////////////////////// +/// \relates Vector3 /// \brief Overload of binary operator * /// /// \param left Left operand (a vector) @@ -140,6 +146,7 @@ template Vector3 operator *(const Vector3& left, T right); //////////////////////////////////////////////////////////// +/// \relates Vector3 /// \brief Overload of binary operator * /// /// \param left Left operand (a scalar value) @@ -152,6 +159,7 @@ template Vector3 operator *(T left, const Vector3& right); //////////////////////////////////////////////////////////// +/// \relates Vector3 /// \brief Overload of binary operator *= /// /// This operator performs a memberwise multiplication by \a right, @@ -167,6 +175,7 @@ template Vector3& operator *=(Vector3& left, T right); //////////////////////////////////////////////////////////// +/// \relates Vector3 /// \brief Overload of binary operator / /// /// \param left Left operand (a scalar value) @@ -179,6 +188,7 @@ template Vector3 operator /(const Vector3& left, T right); //////////////////////////////////////////////////////////// +/// \relates Vector3 /// \brief Overload of binary operator /= /// /// This operator performs a memberwise division by \a right, @@ -194,6 +204,7 @@ template Vector3& operator /=(Vector3& left, T right); //////////////////////////////////////////////////////////// +/// \relates Vector3 /// \brief Overload of binary operator == /// /// This operator compares strict equality between two vectors. @@ -208,6 +219,7 @@ template bool operator ==(const Vector3& left, const Vector3& right); //////////////////////////////////////////////////////////// +/// \relates Vector3 /// \brief Overload of binary operator != /// /// This operator compares strict difference between two vectors. @@ -235,6 +247,7 @@ typedef Vector3 Vector3f; //////////////////////////////////////////////////////////// /// \class sf::Vector3 +/// \ingroup system /// /// sf::Vector3 is a simple class that defines a mathematical /// vector with three coordinates (x, y and z). It can be used to diff --git a/include/SFML/Window.hpp b/include/SFML/Window.hpp index 0d7666f7..db1c7b46 100644 --- a/include/SFML/Window.hpp +++ b/include/SFML/Window.hpp @@ -40,3 +40,8 @@ #endif // SFML_SFML_WINDOW_HPP + +//////////////////////////////////////////////////////////// +/// \defgroup window Window module +/// +//////////////////////////////////////////////////////////// diff --git a/include/SFML/Window/Context.hpp b/include/SFML/Window/Context.hpp index d88e749c..9ec69c5e 100644 --- a/include/SFML/Window/Context.hpp +++ b/include/SFML/Window/Context.hpp @@ -98,6 +98,7 @@ private : //////////////////////////////////////////////////////////// /// \class sf::Context +/// \ingroup window /// /// If you need to make OpenGL / graphics calls without /// having an active window (like in a thread), you can use diff --git a/include/SFML/Window/ContextSettings.hpp b/include/SFML/Window/ContextSettings.hpp index 5fc4e539..b920ba45 100644 --- a/include/SFML/Window/ContextSettings.hpp +++ b/include/SFML/Window/ContextSettings.hpp @@ -72,6 +72,7 @@ struct ContextSettings //////////////////////////////////////////////////////////// /// \class sf::ContextSettings +/// \ingroup window /// /// ContextSettings allows to define several advanced settings /// of the OpenGL context attached to a window. All these diff --git a/include/SFML/Window/Event.hpp b/include/SFML/Window/Event.hpp index 47748789..24707402 100644 --- a/include/SFML/Window/Event.hpp +++ b/include/SFML/Window/Event.hpp @@ -36,6 +36,7 @@ namespace sf namespace Key { //////////////////////////////////////////////////////////// + /// \ingroup window /// \brief Definition of key codes for keyboard events /// //////////////////////////////////////////////////////////// @@ -151,6 +152,7 @@ namespace Key namespace Mouse { //////////////////////////////////////////////////////////// + /// \ingroup window /// \brief Definition of button codes for mouse events /// //////////////////////////////////////////////////////////// @@ -170,6 +172,7 @@ namespace Mouse namespace Joy { //////////////////////////////////////////////////////////// + /// \ingroup window /// \brief Definition of joystick axis for joystick events /// //////////////////////////////////////////////////////////// @@ -340,6 +343,7 @@ public : //////////////////////////////////////////////////////////// /// \class sf::Event +/// \ingroup window /// /// sf::Event holds all the informations about a system event /// that just happened. Events are retrieved using the diff --git a/include/SFML/Window/Input.hpp b/include/SFML/Window/Input.hpp index 2f229375..a7dacc56 100644 --- a/include/SFML/Window/Input.hpp +++ b/include/SFML/Window/Input.hpp @@ -159,6 +159,7 @@ private : //////////////////////////////////////////////////////////// /// \class sf::Input +/// \ingroup window /// /// sf::Input provides a way to access the state of keys, /// mouse buttons, mouse position, joystick buttons and diff --git a/include/SFML/Window/VideoMode.hpp b/include/SFML/Window/VideoMode.hpp index 183bf90f..bd04b17c 100644 --- a/include/SFML/Window/VideoMode.hpp +++ b/include/SFML/Window/VideoMode.hpp @@ -105,6 +105,7 @@ public : }; //////////////////////////////////////////////////////////// +/// \relates VideoMode /// \brief Overload of == operator to compare two video modes /// /// \param left Left operand (a video mode) @@ -116,6 +117,7 @@ public : SFML_API bool operator ==(const VideoMode& left, const VideoMode& right); //////////////////////////////////////////////////////////// +/// \relates VideoMode /// \brief Overload of != operator to compare two video modes /// /// \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); //////////////////////////////////////////////////////////// +/// \relates VideoMode /// \brief Overload of < operator to compare video modes /// /// \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); //////////////////////////////////////////////////////////// +/// \relates VideoMode /// \brief Overload of > operator to compare video modes /// /// \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); //////////////////////////////////////////////////////////// +/// \relates VideoMode /// \brief Overload of <= operator to compare video modes /// /// \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); //////////////////////////////////////////////////////////// +/// \relates VideoMode /// \brief Overload of >= operator to compare video modes /// /// \param left Left operand (a video mode) @@ -178,6 +184,7 @@ SFML_API bool operator >=(const VideoMode& left, const VideoMode& right); //////////////////////////////////////////////////////////// /// \class sf::VideoMode +/// \ingroup window /// /// 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 diff --git a/include/SFML/Window/Window.hpp b/include/SFML/Window/Window.hpp index 963d4046..c234dcae 100644 --- a/include/SFML/Window/Window.hpp +++ b/include/SFML/Window/Window.hpp @@ -510,6 +510,7 @@ private : //////////////////////////////////////////////////////////// /// \class sf::Window +/// \ingroup window /// /// sf::Window is the main class of the Window module. It defines /// an OS window that is able to receive an OpenGL rendering. diff --git a/include/SFML/Window/WindowStyle.hpp b/include/SFML/Window/WindowStyle.hpp index 34205213..454bcf93 100644 --- a/include/SFML/Window/WindowStyle.hpp +++ b/include/SFML/Window/WindowStyle.hpp @@ -31,6 +31,7 @@ namespace sf namespace Style { //////////////////////////////////////////////////////////// + /// \ingroup window /// \brief Enumeration of the window styles /// ////////////////////////////////////////////////////////////