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
This commit is contained in:
LaurentGom 2010-06-11 22:08:49 +00:00
parent 280ce139d6
commit 7ff4cb5ca4
3 changed files with 5 additions and 9 deletions

8
doc/build/Doxyfile vendored
View File

@ -641,16 +641,8 @@ EXCLUDE_SYMLINKS = NO
# for example use the pattern */test/* # for example use the pattern */test/*
EXCLUDE_PATTERNS = .svn \ EXCLUDE_PATTERNS = .svn \
stb_vorbis \
libjpeg \
libpng \
SOIL \
zlib \
glew \
glext \
Linux \ Linux \
Unix \ Unix \
Attic \
OSX* OSX*
# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names

View File

@ -111,6 +111,8 @@ public :
/// If you use a timeout and no socket is ready before the timeout /// If you use a timeout and no socket is ready before the timeout
/// is over, the function returns false. /// 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 /// \return True if there are sockets ready, false otherwise
/// ///
/// \see IsReady /// \see IsReady
@ -128,6 +130,8 @@ public :
/// Note that if this function returns true for a TcpListener, /// Note that if this function returns true for a TcpListener,
/// this means that it is ready to accept a new connection. /// 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 /// \return True if the socket is ready to read, false otherwise
/// ///
/// \see IsReady /// \see IsReady

View File

@ -70,7 +70,7 @@ public :
/// to the current locale. See the other constructor for /// to the current locale. See the other constructor for
/// explicitely passing the locale to use. /// explicitely passing the locale to use.
/// ///
/// \param ansiString ANSI character to convert /// \param ansiChar ANSI character to convert
/// ///
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
String(char ansiChar); String(char ansiChar);