From da27d2312511bfb474c6fb0cc95e8d352d011a5c Mon Sep 17 00:00:00 2001 From: Madhav Vasisth Date: Wed, 21 Jan 2026 19:56:05 +0000 Subject: [PATCH] docs: document sftp_session public API type Signed-off-by: Madhav Vasisth Reviewed-by: Jakub Jelen --- doc/CMakeLists.txt | 1 - include/libssh/sftp.h | 15 +++++++++++++++ 2 files changed, 15 insertions(+), 1 deletion(-) diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt index 7b699e5e..0e7a9521 100644 --- a/doc/CMakeLists.txt +++ b/doc/CMakeLists.txt @@ -189,7 +189,6 @@ if (DOXYGEN_FOUND) sftp_message, sftp_packet, sftp_request_queue, - sftp_session, sftp_status_message, sftp_statvfs_t, poll_fn, diff --git a/include/libssh/sftp.h b/include/libssh/sftp.h index 5f15b1f2..b7d6ad94 100644 --- a/include/libssh/sftp.h +++ b/include/libssh/sftp.h @@ -74,6 +74,21 @@ typedef struct sftp_file_struct* sftp_file; typedef struct sftp_message_struct* sftp_message; typedef struct sftp_packet_struct* sftp_packet; typedef struct sftp_request_queue_struct* sftp_request_queue; + +/** + * @brief SFTP session handle. + * + * This type represents an active SFTP session associated with an SSH channel. + * It is created and destroyed via the libssh SFTP API and is internally + * managed by libssh. It is used by applications to perform SFTP operations + * such as file access and directory management. + * + * The internal structure of this type is opaque and must not be accessed + * directly by applications. + * + * @see sftp_new + * @see sftp_free + */ typedef struct sftp_session_struct* sftp_session; typedef struct sftp_status_message_struct* sftp_status_message; typedef struct sftp_statvfs_struct* sftp_statvfs_t;