lib/libssh
1
0
Fork 0
mirror of https://git.libssh.org/projects/libssh.git synced 2025-11-29 01:03:57 +03:00
Code Activity

buffer: fix documentation for ssh_buffer_get_u32()

Browse Source 
Signed-off-by: Fabiano Fidêncio <fidencio@redhat.com>
Reviewed-by: Andreas Schneider <asn@cryptomilk.org>
This commit is contained in:
Fabiano Fidêncio
2015-09-19 23:42:55 +02:00
parent 1226add976
commit d7349d04d0
1 changed files with 10 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
src/buffer.c
View File

@@ -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)); 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. * @internal
* \param buffer Buffer to read *
* \param data pointer to a uint32_t where to store the data * @brief gets a 32 bits unsigned int out of the buffer. Adjusts the read pointer.
* \returns 0 if there is not enough data in buffer *
* \returns 4 otherwise. * @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){ int ssh_buffer_get_u32(struct ssh_buffer_struct *buffer, uint32_t *data){
return ssh_buffer_get_data(buffer,data,sizeof(uint32_t)); return ssh_buffer_get_data(buffer,data,sizeof(uint32_t));