From 8ddf513216dfe149a90c33f70ea980af521de4e8 Mon Sep 17 00:00:00 2001 From: Laurent Gomila <laurent.gom@gmail.com> Date: Sun, 2 Dec 2012 23:13:16 +0100 Subject: [PATCH] Updated the description of modules --- include/SFML/Audio.hpp | 3 +++ include/SFML/Graphics.hpp | 4 +++- include/SFML/Network.hpp | 5 ++++- include/SFML/System.hpp | 4 ++++ include/SFML/Window.hpp | 5 ++++- 5 files changed, 18 insertions(+), 3 deletions(-) diff --git a/include/SFML/Audio.hpp b/include/SFML/Audio.hpp index 9f405b72..36c860f3 100644 --- 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 index 89354e12..61c543b3 100644 --- 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/Network.hpp b/include/SFML/Network.hpp index ef1b78ad..d2b32bd0 100644 --- 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 index 9968c995..fd333b99 100644 --- 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 index 03856fcf..1f3d27ee 100644 --- a/include/SFML/Window.hpp +++ b/include/SFML/Window.hpp @@ -45,5 +45,8 @@ //////////////////////////////////////////////////////////// /// \defgroup window Window module -/// +/// +/// Provides OpenGL-based windows, and abstractions for +/// events and input handling. +/// ////////////////////////////////////////////////////////////