Merge branch 'master' of https://github.com/Caseus/SFML

ThatJotam · Dec 9, 2012 · 32ae9d3 · 32ae9d3
2 parents b668f00 + 2e22038
commit 32ae9d3
Show file tree

Hide file tree

Showing 8 changed files with 23 additions and 10 deletions.
diff --git a/doc/mainpage.hpp b/doc/mainpage.hpp
@@ -3,10 +3,9 @@
 ///
 /// \section welcome Welcome
 /// Welcome to the official SFML documentation. Here you will find a detailed
-/// view of all the SFML <a href="./annotated.php">classes</a>, as well as source
-/// <a href="./files.php">files</a>. <br>
+/// view of all the SFML <a href="./annotated.php">classes</a> and functions. <br/>
 /// If you are looking for tutorials, you can visit the official website
-/// at <a href="http://www.sfml-dev.org/tutorials/">www.sfml-dev.org</a>.
+/// at <a href="http://www.sfml-dev.org/">www.sfml-dev.org</a>.
 ///
 /// \section example Short example
 /// Here is a short example, to show you how simple it is to use SFML :

diff --git a/include/SFML/Audio.hpp b/include/SFML/Audio.hpp
@@ -43,5 +43,8 @@
 
 ////////////////////////////////////////////////////////////
 /// \defgroup audio Audio module
+///
+/// Sounds, streaming (musics or custom sources), recording,
+/// spatialization.
 /// 
 ////////////////////////////////////////////////////////////
diff --git a/include/SFML/Graphics.hpp b/include/SFML/Graphics.hpp
@@ -56,5 +56,7 @@
 
 ////////////////////////////////////////////////////////////
 /// \defgroup graphics Graphics module
-/// 
+///
+/// 2D graphics module: sprites, text, shapes, ...
+///
 ////////////////////////////////////////////////////////////
diff --git a/include/SFML/Graphics/RenderTarget.hpp b/include/SFML/Graphics/RenderTarget.hpp
@@ -337,6 +337,8 @@ protected :
     ////////////////////////////////////////////////////////////
     void initialize();
 
+private:
+
     ////////////////////////////////////////////////////////////
     /// \brief Apply the current view
     ///
@@ -375,8 +377,6 @@ protected :
     ////////////////////////////////////////////////////////////
     void applyShader(const Shader* shader);
 
-private :
-
     ////////////////////////////////////////////////////////////
     /// \brief Activate the target for rendering
     ///

diff --git a/include/SFML/Graphics/Shader.hpp b/include/SFML/Graphics/Shader.hpp
@@ -382,7 +382,7 @@ public :
     /// \endcode
     /// \code
     /// sf::Transform transform;
-    /// transform.Translate(5, 10);
+    /// transform.translate(5, 10);
     /// shader.setParameter("matrix", transform);
     /// \endcode
     ///
@@ -610,7 +610,6 @@ private :
 /// window.setActive();
 /// shader.bind();
 /// ... render OpenGL geometry ...
-/// shader.unbind();
 /// \endcode
 ///
 ////////////////////////////////////////////////////////////
diff --git a/include/SFML/Network.hpp b/include/SFML/Network.hpp
@@ -44,5 +44,8 @@
 
 ////////////////////////////////////////////////////////////
 /// \defgroup network Network module
-/// 
+///
+/// Socket-based communication, utilities and higher-level
+/// network protocols (HTTP, FTP).
+///
 ////////////////////////////////////////////////////////////
diff --git a/include/SFML/System.hpp b/include/SFML/System.hpp
@@ -48,5 +48,9 @@
 
 ////////////////////////////////////////////////////////////
 /// \defgroup system System module
+///
+/// Base module of SFML, defining various utilities. It provides
+/// vector classes, unicode strings and conversion functions,
+/// threads and mutexes, timing classes.
 /// 
 ////////////////////////////////////////////////////////////
diff --git a/include/SFML/Window.hpp b/include/SFML/Window.hpp
@@ -42,5 +42,8 @@
 
 ////////////////////////////////////////////////////////////
 /// \defgroup window Window module
-/// 
+///
+/// Provides OpenGL-based windows, and abstractions for
+/// events and input handling.
+///
 ////////////////////////////////////////////////////////////