From 36f9cf6cc174065dc5430c94c33aaf6d0f296810 Mon Sep 17 00:00:00 2001 From: LaurentGom Date: Tue, 14 Sep 2010 21:51:39 +0000 Subject: [PATCH] Minor fixes in API documentation git-svn-id: https://sfml.svn.sourceforge.net/svnroot/sfml/branches/sfml2@1569 4e206d99-4929-0410-ac5d-dfc041789085 --- include/SFML/Graphics/Font.hpp | 2 +- include/SFML/System/Mutex.hpp | 2 +- include/SFML/System/Vector2.hpp | 2 ++ include/SFML/System/Vector3.hpp | 2 ++ 4 files changed, 6 insertions(+), 2 deletions(-) diff --git a/include/SFML/Graphics/Font.hpp b/include/SFML/Graphics/Font.hpp index de5415e2..6dc8bf35 100644 --- a/include/SFML/Graphics/Font.hpp +++ b/include/SFML/Graphics/Font.hpp @@ -92,7 +92,7 @@ public : bool LoadFromFile(const std::string& filename); //////////////////////////////////////////////////////////// - /// \brief Load the font from a file + /// \brief Load the font from a file in memory /// /// The supported font formats are: TrueType, Type 1, CFF, /// OpenType, SFNT, X11 PCF, Windows FNT, BDF, PFR and Type 42. diff --git a/include/SFML/System/Mutex.hpp b/include/SFML/System/Mutex.hpp index 4b8e3d8e..13accb0a 100644 --- a/include/SFML/System/Mutex.hpp +++ b/include/SFML/System/Mutex.hpp @@ -103,7 +103,7 @@ private : /// /// When you want to protect a part of the code from being accessed /// simultaneously by multiple threads, you typically use a -/// mutex. When a thread is locked by a thread, any other thread +/// mutex. When a thread is locked by a mutex, any other thread /// trying to lock it will be blocked until the mutex is released /// by the thread that locked it. This way, you can allow only /// one thread at a time to access a critical region of your code. diff --git a/include/SFML/System/Vector2.hpp b/include/SFML/System/Vector2.hpp index ca2ee3ea..63504f92 100644 --- a/include/SFML/System/Vector2.hpp +++ b/include/SFML/System/Vector2.hpp @@ -41,6 +41,8 @@ public : //////////////////////////////////////////////////////////// /// \brief Default constructor /// + /// Creates a Vector2(0, 0). + /// //////////////////////////////////////////////////////////// Vector2(); diff --git a/include/SFML/System/Vector3.hpp b/include/SFML/System/Vector3.hpp index 1e19e6f2..c25cd467 100644 --- a/include/SFML/System/Vector3.hpp +++ b/include/SFML/System/Vector3.hpp @@ -41,6 +41,8 @@ public : //////////////////////////////////////////////////////////// /// \brief Default constructor /// + /// Creates a Vector3(0, 0, 0). + /// //////////////////////////////////////////////////////////// Vector3();