From 3c0567cb67a74b78add2cf451566a928feff2771 Mon Sep 17 00:00:00 2001 From: Shiva Kiran Koninty Date: Thu, 26 Feb 2026 19:26:06 +0530 Subject: [PATCH] docs: Fix struct field comment positioning for Doxygen MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Doxygen interprets comments placed beside struct fields to belong to the next field instead of the current field. This could be fixed by moving the comments atop the fields, or by using the `/**< COMMENT */` format. Stay consistent with the comment format used for other structs and move the comments atop the fields. Signed-off-by: Shiva Kiran Koninty Reviewed-by: Jakub Jelen Reviewed-by: Pavol Žáčik --- include/libssh/sftp.h | 58 ++++++++++++++++++++++++++++++++----------- 1 file changed, 43 insertions(+), 15 deletions(-) diff --git a/include/libssh/sftp.h b/include/libssh/sftp.h index f32441cf..7676d89b 100644 --- a/include/libssh/sftp.h +++ b/include/libssh/sftp.h @@ -291,27 +291,55 @@ struct sftp_attributes_struct { * @brief SFTP statvfs structure. */ struct sftp_statvfs_struct { - uint64_t f_bsize; /** file system block size */ - uint64_t f_frsize; /** fundamental fs block size */ - uint64_t f_blocks; /** number of blocks (unit f_frsize) */ - uint64_t f_bfree; /** free blocks in file system */ - uint64_t f_bavail; /** free blocks for non-root */ - uint64_t f_files; /** total file inodes */ - uint64_t f_ffree; /** free file inodes */ - uint64_t f_favail; /** free file inodes for to non-root */ - uint64_t f_fsid; /** file system id */ - uint64_t f_flag; /** bit mask of f_flag values */ - uint64_t f_namemax; /** maximum filename length */ + /** file system block size */ + uint64_t f_bsize; + + /** fundamental fs block size */ + uint64_t f_frsize; + + /** number of blocks (unit f_frsize) */ + uint64_t f_blocks; + + /** free blocks in file system */ + uint64_t f_bfree; + + /** free blocks for non-root */ + uint64_t f_bavail; + + /** total file inodes */ + uint64_t f_files; + + /** free file inodes */ + uint64_t f_ffree; + + /** free file inodes for non-root */ + uint64_t f_favail; + + /** file system id */ + uint64_t f_fsid; + + /** bit mask of f_flag values */ + uint64_t f_flag; + + /** maximum filename length */ + uint64_t f_namemax; }; /** * @brief SFTP limits structure. */ struct sftp_limits_struct { - uint64_t max_packet_length; /** maximum number of bytes in a single sftp packet */ - uint64_t max_read_length; /** maximum length in a SSH_FXP_READ packet */ - uint64_t max_write_length; /** maximum length in a SSH_FXP_WRITE packet */ - uint64_t max_open_handles; /** maximum number of active handles allowed by server */ + /** maximum number of bytes in a single sftp packet */ + uint64_t max_packet_length; + + /** maximum length in a SSH_FXP_READ packet */ + uint64_t max_read_length; + + /** maximum length in a SSH_FXP_WRITE packet */ + uint64_t max_write_length; + + /** maximum number of active handles allowed by server */ + uint64_t max_open_handles; }; /**