Edgaru089/SFML
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Improved the documentation of SFML-specific statuses in sf::Ftp

Browse Source
This commit is contained in:
Laurent Gomila 2015-01-03 23:47:15 +01:00
parent d4e6b84afc
commit 758735092e
1 changed files with 8 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
include/SFML/Network/Ftp.hpp
View File

@ -127,10 +127,10 @@ public:
FilenameNotAllowed = 553, ///< Requested action not taken, file name not allowed FilenameNotAllowed = 553, ///< Requested action not taken, file name not allowed
// 10xx: SFML custom codes // 10xx: SFML custom codes
InvalidResponse = 1000, ///< Response is not a valid FTP one InvalidResponse = 1000, ///< Not part of the FTP standard, generated by SFML when a received response cannot be parsed
ConnectionFailed = 1001, ///< Connection with server failed ConnectionFailed = 1001, ///< Not part of the FTP standard, generated by SFML when the low-level socket connection with the server fails
ConnectionClosed = 1002, ///< Connection with server closed ConnectionClosed = 1002, ///< Not part of the FTP standard, generated by SFML when the low-level socket connection is unexpectedly closed
InvalidFile = 1003 ///< Invalid file to upload / download InvalidFile = 1003 ///< Not part of the FTP standard, generated by SFML when a local file cannot be read or written
}; };
//////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////
@ -559,7 +559,10 @@ private:
/// return additional data, and use a class derived from /// return additional data, and use a class derived from
/// sf::Ftp::Response to provide this data. The most often used /// sf::Ftp::Response to provide this data. The most often used
/// commands are directly provided as member functions, but it is /// commands are directly provided as member functions, but it is
/// also possible to use specific commands with the sendCommand() method. /// also possible to use specific commands with the sendCommand() function.
///
/// Note that response statuses >= 1000 are not part of the FTP standard,
/// they are generated by SFML when an internal error occurs.
/// ///
/// All commands, especially upload and download, may take some /// All commands, especially upload and download, may take some
/// time to complete. This is important to know if you don't want /// time to complete. This is important to know if you don't want