Documentation updates. Fixes a few formating bugs, adds various minor missing api documentation, fixes a few typos. Also fixes a few tiny code issues, mostly missing consts, etc

darcs-hash:20060617130708-ac50b-cc2ec5aa3e4bfb8e28d7b86441bfb4661f1dd7e7.gz

1 files changed, 23 insertions, 0 deletions

diff --git a/common.h b/common.h
index ce5ff3a0..900cd567 100644
--- a/common.h
+++ b/common.h
@@ -103,16 +103,39 @@ void sort_list( array_list_t *comp );
 /**
    Returns a newly allocated wide character string equivalent of the
    specified multibyte character string
+
+   This function encodes illegal character sequences in a reversible
+   way using the private use area.
 */
 wchar_t *str2wcs( const char *in );
+
+/**
+   Converts the narrow character string \c in into it's wide
+   equivalent, stored in \c out. \c out must have enough space to fit
+   the entire string.
+
+   This function encodes illegal character sequences in a reversible
+   way using the private use area.
+*/
 wchar_t *str2wcs_internal( const char *in, wchar_t *out );
 
 /**
    Returns a newly allocated multibyte character string equivalent of
    the specified wide character string
+
+   This function decodes illegal character sequences in a reversible
+   way using the private use area.
 */
 char *wcs2str( const wchar_t *in );
 
+/**
+   Converts the wide character string \c in into it's narrow
+   equivalent, stored in \c out. \c out must have enough space to fit
+   the entire string.
+
+   This function decodes illegal character sequences in a reversible
+   way using the private use area.
+*/
 char *wcs2str_internal( const wchar_t *in, char *out );
 
 /**