From 64e73b8d8ab216c5dd8812c8cdad39b7f1bfc4d2 Mon Sep 17 00:00:00 2001
From: Aris Adamantiadis <aris@0xbadc0de.be>
Date: Tue, 4 Nov 2008 21:59:12 +0000
Subject: doxygen fixes. Mostly typos and some comments. sftp must be fully
 documented !

git-svn-id: svn+ssh://svn.berlios.de/svnroot/repos/libssh/trunk@187 7dcaeef0-15fb-0310-b436-a5af3365683c
---
 libssh/string.c | 9 ++++++---
 1 file changed, 6 insertions(+), 3 deletions(-)

(limited to 'libssh/string.c')

diff --git a/libssh/string.c b/libssh/string.c
index fc730a48..18ad0dbb 100644
--- a/libssh/string.c
+++ b/libssh/string.c
@@ -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){
-- 
cgit