shinys000114/libssh
1
0
Fork 0
mirror of https://git.libssh.org/projects/libssh.git synced 2026-02-07 10:40:28 +09:00
Code Issues Packages Projects Releases Wiki Activity

sftp: fix documentation typos

Browse Source 
Signed-off-by: Harald Sitter <sitter@kde.org>
Reviewed-by: Jakub Jelen <jjelen@redhat.com>
Reviewed-by: Anderson Toshiyuki Sasaki <ansasaki@redhat.com>
This commit is contained in:
Harald Sitter
2020-08-05 15:36:18 +02:00
committed by Jakub Jelen
parent 7aad964cef
commit c0b65ccc5a
1 changed files with 8 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
include/libssh/sftp.h
View File

@@ -258,7 +258,7 @@ LIBSSH_API int sftp_init(sftp_session sftp);
* @param sftp The sftp session where the error is saved.
*
* @return The saved error (see server responses), < 0 if an error
* in the function occured.
* in the function occurred.
*
* @see Server responses
*/
@@ -413,7 +413,7 @@ LIBSSH_API void sftp_attributes_free(sftp_attributes file);
*
* @param dir The sftp directory handle to close.
*
* @return Returns SSH_NO_ERROR or SSH_ERROR if an error occured.
* @return Returns SSH_NO_ERROR or SSH_ERROR if an error occurred.
*/
LIBSSH_API int sftp_closedir(sftp_dir dir);
@@ -422,7 +422,7 @@ LIBSSH_API int sftp_closedir(sftp_dir dir);
*
* @param file The open sftp file handle to close.
*
* @return Returns SSH_NO_ERROR or SSH_ERROR if an error occured.
* @return Returns SSH_NO_ERROR or SSH_ERROR if an error occurred.
*
* @see sftp_open()
*/
@@ -478,7 +478,7 @@ LIBSSH_API void sftp_file_set_blocking(sftp_file handle);
*
* @param file The opened sftp file handle to be read from.
*
* @param buf Pointer to buffer to recieve read data.
* @param buf Pointer to buffer to receive read data.
*
* @param count Size of the buffer in bytes.
*
@@ -527,7 +527,7 @@ LIBSSH_API int sftp_async_read_begin(sftp_file file, uint32_t len);
*
* @param file The opened sftp file handle to be read from.
*
* @param data Pointer to buffer to recieve read data.
* @param data Pointer to buffer to receive read data.
*
* @param len Size of the buffer in bytes. It should be bigger or
* equal to the length parameter of the
@@ -537,7 +537,7 @@ LIBSSH_API int sftp_async_read_begin(sftp_file file, uint32_t len);
* function.
*
* @return Number of bytes read, 0 on EOF, SSH_ERROR if an error
* occured, SSH_AGAIN if the file is opened in nonblocking
* occurred, SSH_AGAIN if the file is opened in nonblocking
* mode and the request hasn't been executed yet.
*
* @warning A call to this function with an invalid identifier
@@ -632,7 +632,7 @@ LIBSSH_API void sftp_rewind(sftp_file file);
LIBSSH_API int sftp_unlink(sftp_session sftp, const char *file);
/**
* @brief Remove a directoy.
* @brief Remove a directory.
*
* @param sftp The sftp session handle.
*
@@ -854,7 +854,7 @@ LIBSSH_API int sftp_server_version(sftp_session sftp);
LIBSSH_API sftp_session sftp_server_new(ssh_session session, ssh_channel chan);
/**
* @brief Intialize the sftp server.
* @brief Initialize the sftp server.
*
* @param sftp The sftp session to init.
*