shinys000114/libssh
1
0
Fork 0
mirror of https://git.libssh.org/projects/libssh.git synced 2026-02-05 04:40:31 +09:00
Code Issues Packages Projects Releases Wiki Activity

doxygen fixes. Mostly typos and some comments.

Browse Source 
sftp must be fully documented !


git-svn-id: svn+ssh://svn.berlios.de/svnroot/repos/libssh/trunk@187 7dcaeef0-15fb-0310-b436-a5af3365683c
This commit is contained in:
Aris Adamantiadis
2008-11-04 21:59:12 +00:00
parent 90bb81f7b0
commit 64e73b8d8a
12 changed files with 162 additions and 71 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
libssh/string.c
View File

@@ -28,7 +28,7 @@ MA 02111-1307, USA. */
/** \addtogroup ssh_string
* @{ */
/**
/**
* \brief Creates a new SSH String object
* \param size size of the string
* \return the newly allocated string
@@ -71,7 +71,7 @@ int string_len(STRING *str){
* \brief convert a SSH string to a C nul-terminated string
* \param str the input SSH string
* \return a malloc'ed string pointer.
* \warning If the input SSH string contains zeroes, some parts of
* \warning If the input SSH string contains zeroes, some parts of
* the output string may not be readable with regular libc functions.
*/
char *string_to_char(STRING *str){
@@ -89,6 +89,9 @@ STRING *string_copy(STRING *str){
return ret;
}
/** \brief destroy data in a string so it couldn't appear in a core dump
* \param s string to burn
*/
void string_burn(STRING *s){
memset(s->string,'X',string_len(s));
}
@@ -98,7 +101,7 @@ void *string_data(STRING *s){
}
/**
* \brief desallocate a STRING object
* \brief deallocate a STRING object
* \param s String to delete
*/
void string_free(STRING *s){