Updated the description of modules

2012-12-02 23:13:16 +01:00 · 2012-12-02 23:13:16 +01:00 · 8ddf513216
commit 8ddf513216
parent 37d6e72a14
5 changed files with 18 additions and 3 deletions
--- a/include/SFML/Audio.hpp
+++ b/include/SFML/Audio.hpp
@ -44,4 +44,7 @@
 ////////////////////////////////////////////////////////////
 /// \defgroup audio Audio module
 ///
+/// Sounds, streaming (musics or custom sources), recording,
+/// spatialization.
+/// 
 ////////////////////////////////////////////////////////////
--- a/include/SFML/Graphics.hpp
+++ b/include/SFML/Graphics.hpp
@ -57,4 +57,6 @@
 ////////////////////////////////////////////////////////////
 /// \defgroup graphics Graphics module
 ///
+/// 2D graphics module: sprites, text, shapes, ...
+///
 ////////////////////////////////////////////////////////////
--- a/include/SFML/Network.hpp
+++ b/include/SFML/Network.hpp
@ -45,4 +45,7 @@
 ////////////////////////////////////////////////////////////
 /// \defgroup network Network module
 ///
+/// Socket-based communication, utilities and higher-level
+/// network protocols (HTTP, FTP).
+///
 ////////////////////////////////////////////////////////////
--- a/include/SFML/System.hpp
+++ b/include/SFML/System.hpp
@ -49,4 +49,8 @@
 ////////////////////////////////////////////////////////////
 /// \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.
+/// 
 ////////////////////////////////////////////////////////////
--- a/include/SFML/Window.hpp
+++ b/include/SFML/Window.hpp
@ -46,4 +46,7 @@
 ////////////////////////////////////////////////////////////
 /// \defgroup window Window module
 ///
+/// Provides OpenGL-based windows, and abstractions for
+/// events and input handling.
+///
 ////////////////////////////////////////////////////////////