Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Updated the description of modules

  • Loading branch information...
commit 8ddf513216dfe149a90c33f70ea980af521de4e8 1 parent 37d6e72
@LaurentGomila LaurentGomila authored
View
3  include/SFML/Audio.hpp
@@ -43,5 +43,8 @@
////////////////////////////////////////////////////////////
/// \defgroup audio Audio module
+///
+/// Sounds, streaming (musics or custom sources), recording,
+/// spatialization.
///
////////////////////////////////////////////////////////////
View
4 include/SFML/Graphics.hpp
@@ -56,5 +56,7 @@
////////////////////////////////////////////////////////////
/// \defgroup graphics Graphics module
-///
+///
+/// 2D graphics module: sprites, text, shapes, ...
+///
////////////////////////////////////////////////////////////
View
5 include/SFML/Network.hpp
@@ -44,5 +44,8 @@
////////////////////////////////////////////////////////////
/// \defgroup network Network module
-///
+///
+/// Socket-based communication, utilities and higher-level
+/// network protocols (HTTP, FTP).
+///
////////////////////////////////////////////////////////////
View
4 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.
///
////////////////////////////////////////////////////////////
View
5 include/SFML/Window.hpp
@@ -45,5 +45,8 @@
////////////////////////////////////////////////////////////
/// \defgroup window Window module
-///
+///
+/// Provides OpenGL-based windows, and abstractions for
+/// events and input handling.
+///
////////////////////////////////////////////////////////////
Please sign in to comment.
Something went wrong with that request. Please try again.