From: adam <adamansky@gmail.com>
Date: Sun, 21 Jul 2013 15:33:21 +0000 (+0700)
Subject: bson.h doc fixes
X-Git-Tag: v1.2.12~251^2~1
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=d8bcc3b2a9ccdd6864876cee9bf40225bdb3c171;p=platform%2Fupstream%2Fejdb.git

bson.h doc fixes
---

diff --git a/tcejdb/bson.h b/tcejdb/bson.h
index 35c41de..891c021 100644
--- a/tcejdb/bson.h
+++ b/tcejdb/bson.h
@@ -578,7 +578,7 @@ EJDB_EXPORT void bson_append(bson *b, const void *data, int len);
  *  object using this function.
  *
  *  @note When finished, you must pass the bson object to
- *      bson_destroy( ).
+ *      bson_del( ).
  */
 EJDB_EXPORT void bson_init(bson *b);
 
@@ -632,18 +632,22 @@ EJDB_EXPORT int bson_ensure_space(bson *b, const int bytesNeeded);
  * @param b the bson object to finalize.
  *
  * @return the standard error code. To deallocate memory,
- *   call bson_destroy on the bson object.
+ *   call bson_del on the bson object.
  */
 EJDB_EXPORT int bson_finish(bson *b);
 
 /**
  * Destroy a bson object.
- *
+ * Clears bson object and frees internal memory buffers held by bson
+ * object BUT does not delete bson object itself
  * @param b the bson object to destroy.
- *
  */
 EJDB_EXPORT void bson_destroy(bson *b);
 
+/**
+ * The bson_del() performs bson_destroy() then frees bson object itself.
+ * @param b
+ */
 EJDB_EXPORT void bson_del(bson *b);
 
 EJDB_EXPORT void bson_reset(bson *b);