diff options
author | Fabiano Fidêncio <fidencio@redhat.com> | 2015-09-19 23:42:55 +0200 |
---|---|---|
committer | Fabiano Fidêncio <fidencio@redhat.com> | 2016-01-19 11:31:07 +0100 |
commit | 5d685ecab5852f92a35e2b4add0d1416abda9ee9 (patch) | |
tree | dba3b77b61d51800de5d97e1938a6130ee06b5b1 | |
parent | f5adedc372e94f57c38e8a99025b5d2c77e0e195 (diff) | |
download | libssh-5d685ecab5852f92a35e2b4add0d1416abda9ee9.tar.gz libssh-5d685ecab5852f92a35e2b4add0d1416abda9ee9.tar.xz libssh-5d685ecab5852f92a35e2b4add0d1416abda9ee9.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 b386dcae..bf1888de 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)); |