mirror of
https://github.com/SFML/SFML.git
synced 2024-11-28 14:21:04 +08:00
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:
parent
280ce139d6
commit
7ff4cb5ca4
8
doc/build/Doxyfile
vendored
8
doc/build/Doxyfile
vendored
@ -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
|
||||
|
@ -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
|
||||
|
@ -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);
|
||||
|
Loading…
Reference in New Issue
Block a user