diff options
author | Fabiano Fidêncio <fidencio@redhat.com> | 2015-09-19 23:42:55 +0200 |
---|---|---|
committer | Fabiano Fidêncio <fidencio@redhat.com> | 2015-10-12 13:56:21 +0200 |
commit | 32b80f3aeab6218fd035152e150b0c596a5e0660 (patch) | |
tree | 4c77b1f235812b82b4bd315543a846fddd573d6f | |
parent | 25a45eb6f83fac264d2ee476ac710938f5ce6ff9 (diff) | |
download | libssh-32b80f3aeab6218fd035152e150b0c596a5e0660.tar.gz libssh-32b80f3aeab6218fd035152e150b0c596a5e0660.tar.xz libssh-32b80f3aeab6218fd035152e150b0c596a5e0660.zip |
buffer: fix documentation for ssh_buffer_get_u32()
Signed-off-by: Fabiano Fidêncio <fidencio@redhat.com>
-rw-r--r-- | src/buffer.c | 16 |
1 files changed, 10 insertions, 6 deletions
diff --git a/src/buffer.c b/src/buffer.c index a327aa6c..73db6d1a 100644 --- a/src/buffer.c +++ b/src/buffer.c @@ -591,12 +591,16 @@ int ssh_buffer_get_u8(struct ssh_buffer_struct *buffer, uint8_t *data){ return ssh_buffer_get_data(buffer,data,sizeof(uint8_t)); } -/** \internal - * \brief gets a 32 bits unsigned int out of the buffer. Adjusts the read pointer. - * \param buffer Buffer to read - * \param data pointer to a uint32_t where to store the data - * \returns 0 if there is not enough data in buffer - * \returns 4 otherwise. +/** + * @internal + * + * @brief gets a 32 bits unsigned int out of the buffer. Adjusts the read pointer. + * + * @param[in] buffer The buffer to read. + * + * @param[in] data A pointer to a uint32_t where to store the data. + * + * @returns 0 if there is not enough data in buffer, 4 otherwise. */ int ssh_buffer_get_u32(struct ssh_buffer_struct *buffer, uint32_t *data){ return ssh_buffer_get_data(buffer,data,sizeof(uint32_t)); |