From 7ff4cb5ca4f62309fbdeb782b1b6e2796e85a392 Mon Sep 17 00:00:00 2001 From: LaurentGom Date: Fri, 11 Jun 2010 22:08:49 +0000 Subject: [PATCH] Some minor corrections in API documentation and parameters names git-svn-id: https://sfml.svn.sourceforge.net/svnroot/sfml/branches/sfml2@1526 4e206d99-4929-0410-ac5d-dfc041789085 --- doc/build/Doxyfile | 8 -------- include/SFML/Network/SocketSelector.hpp | 4 ++++ include/SFML/System/String.hpp | 2 +- 3 files changed, 5 insertions(+), 9 deletions(-) diff --git a/doc/build/Doxyfile b/doc/build/Doxyfile index 9def25f5..f9c7b13f 100644 --- a/doc/build/Doxyfile +++ b/doc/build/Doxyfile @@ -641,16 +641,8 @@ EXCLUDE_SYMLINKS = NO # for example use the pattern */test/* EXCLUDE_PATTERNS = .svn \ - stb_vorbis \ - libjpeg \ - libpng \ - SOIL \ - zlib \ - glew \ - glext \ Linux \ Unix \ - Attic \ OSX* # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names diff --git a/include/SFML/Network/SocketSelector.hpp b/include/SFML/Network/SocketSelector.hpp index aaddd339..754206a6 100644 --- a/include/SFML/Network/SocketSelector.hpp +++ b/include/SFML/Network/SocketSelector.hpp @@ -111,6 +111,8 @@ public : /// If you use a timeout and no socket is ready before the timeout /// is over, the function returns false. /// + /// \param timeout Maximum time to wait (use 0 for infinity) + /// /// \return True if there are sockets ready, false otherwise /// /// \see IsReady @@ -128,6 +130,8 @@ public : /// Note that if this function returns true for a TcpListener, /// this means that it is ready to accept a new connection. /// + /// \param socket Socket to test + /// /// \return True if the socket is ready to read, false otherwise /// /// \see IsReady diff --git a/include/SFML/System/String.hpp b/include/SFML/System/String.hpp index fcd9a617..825390cf 100644 --- a/include/SFML/System/String.hpp +++ b/include/SFML/System/String.hpp @@ -70,7 +70,7 @@ public : /// to the current locale. See the other constructor for /// explicitely passing the locale to use. /// - /// \param ansiString ANSI character to convert + /// \param ansiChar ANSI character to convert /// //////////////////////////////////////////////////////////// String(char ansiChar);