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

sftp: Improve the documentation of sftp_init() and sftp_new()

Browse Source 
Fixes: T137

Signed-off-by: Jakub Jelen <jjelen@redhat.com>
Reviewed-by: Anderson Toshiyuki Sasaki <ansasaki@redhat.com>
(cherry picked from commit 618b858e49)
This commit is contained in:
Jakub Jelen
2019-09-13 14:43:08 +02:00
committed by Anderson Toshiyuki Sasaki
parent d2af62624d
commit 0e3dbd6c69
1 changed files with 10 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
include/libssh/sftp.h
View File

@@ -201,13 +201,18 @@ struct sftp_statvfs_struct {
}; };
/** /**
* @brief Start a new sftp session. * @brief Creates a new sftp session.
*
* This function creates a new sftp session and allocates a new sftp channel
* with the server inside of the provided ssh session. This function call is
* usually followed by the sftp_init(), which initializes SFTP protocol itself.
* *
* @param session The ssh session to use. * @param session The ssh session to use.
* *
* @return A new sftp session or NULL on error. * @return A new sftp session or NULL on error.
* *
* @see sftp_free() * @see sftp_free()
* @see sftp_init()
*/ */
LIBSSH_API sftp_session sftp_new(ssh_session session); LIBSSH_API sftp_session sftp_new(ssh_session session);
@@ -232,7 +237,10 @@ LIBSSH_API sftp_session sftp_new_channel(ssh_session session, ssh_channel channe
LIBSSH_API void sftp_free(sftp_session sftp); LIBSSH_API void sftp_free(sftp_session sftp);
/** /**
* @brief Initialize the sftp session with the server. * @brief Initialize the sftp protocol with the server.
*
* This function involves the SFTP protocol initialization (as described
* in the SFTP specification), including the version and extensions negotiation.
* *
* @param sftp The sftp session to initialize. * @param sftp The sftp session to initialize.
* *