docs: add bson_string_t docs.

finnoon · Dec 4, 2013 · 314b96c · 314b96c
1 parent c13b519
commit 314b96c
Show file tree

Hide file tree

Showing 6 changed files with 41 additions and 172 deletions.
diff --git a/doc/bson_string_append.txt b/doc/bson_string_append.txt
@@ -5,7 +5,7 @@ bson_string_append(3)
 NAME
 ----
 
-bson_string_append - TODO
+bson_string_append, bson_string_append_c, bson_string_append_printf, bson_string_append_unichar - append to a bson_string_t
 
 
 SYNOPSIS
@@ -18,33 +18,49 @@ SYNOPSIS
 void
 bson_string_append (bson_string_t *string,
                     const char    *str);
+
+void
+bson_string_append_c (bson_string_t *string,
+                      char           str);
+
+void
+bson_string_append_printf (bson_string_t *string,
+                           const char    *format,
+                           ...);
+
+void
+bson_string_append_unichar (bson_string_t *string,
+                            bson_unichar_t unichar);
 -----------------------
 
 
 DESCRIPTION
 -----------
 
-The _bson_string_append()_ function shall 
+The _bson_string_append()_ function shall copy the contents of _str_ onto the end of _string_.
 
+The _bson_string_append_c()_ function shall append a single ascii character to the end of _string_.
 
-RETURN VALUE
-------------
+The _bson_string_append_printf()_ function shall format a string as specified by _format_ and append it to _string_.
 
-TODO
+The _bson_string_append_unichar()_ function shall append a single unicode character to the end of _string_.
+It will be encoded into UTF-8.
 
 
 ERRORS
 ------
+
 No errors are defined.
 
 
 SEE ALSO
 --------
 
-TODO
+linkbson:bson_string_new[3]
+linkbson:bson_string_free[3]
 
 
 AUTHORS
 -------
-This page was written by MongoDB, Inc.
 
+This page was written by MongoDB, Inc.
diff --git a/doc/bson_string_append_c.txt b/doc/bson_string_append_c.txt
diff --git a/doc/bson_string_append_c.txt b/doc/bson_string_append_c.txt
@@ -0,0 +1 @@
+bson_string_append.txt
diff --git a/doc/bson_string_append_printf.txt b/doc/bson_string_append_printf.txt
diff --git a/doc/bson_string_append_printf.txt b/doc/bson_string_append_printf.txt
@@ -0,0 +1 @@
+bson_string_append.txt
diff --git a/doc/bson_string_append_unichar.txt b/doc/bson_string_append_unichar.txt
diff --git a/doc/bson_string_append_unichar.txt b/doc/bson_string_append_unichar.txt
@@ -0,0 +1 @@
+bson_string_append.txt
diff --git a/doc/bson_string_free.txt b/doc/bson_string_free.txt
@@ -5,7 +5,7 @@ bson_string_free(3)
 NAME
 ----
 
-bson_string_free - TODO
+bson_string_free - free a bson_string_t.
 
 
 SYNOPSIS
@@ -24,27 +24,24 @@ bson_string_free (bson_string_t *string,
 DESCRIPTION
 -----------
 
-The _bson_string_free()_ function shall 
+The _bson_string_free()_ function shall free _string_.
+If _free_segment_ is FALSE, then the built string will be returned to the caller.
+Otherwise, the built string is also freed.
 
 
 RETURN VALUE
 ------------
 
-TODO
+The built string if _free_segment_ is FALSE, otherwise NULL.
 
 
 ERRORS
 ------
-No errors are defined.
-
-
-SEE ALSO
---------
 
-TODO
+No errors are defined.
 
 
 AUTHORS
 -------
-This page was written by MongoDB, Inc.
 
+This page was written by MongoDB, Inc.
diff --git a/doc/bson_string_new.txt b/doc/bson_string_new.txt
@@ -5,7 +5,7 @@ bson_string_new(3)
 NAME
 ----
 
-bson_string_new - TODO
+bson_string_new - create a new bson_string_t
 
 
 SYNOPSIS
@@ -23,24 +23,28 @@ bson_string_new (const char *str);
 DESCRIPTION
 -----------
 
-The _bson_string_new()_ function shall 
+The _bson_string_new()_ function shall create a new instance of _bson_string_t_.
+
+If _str_ is non-NULL, it will be copied.
 
 
 RETURN VALUE
 ------------
 
-TODO
+A newly allocated _bson_string_t_.
 
 
 ERRORS
 ------
+
 No errors are defined.
 
 
 SEE ALSO
 --------
 
-TODO
+linkbson:bson_string_append[3]
+linkbson:bson_string_free[3]
 
 
 AUTHORS