Permalink
Browse files

CBD-160: Improved the documentation for get_value

Change-Id: I39ef32453b8a337d787a3f2ace55856c1261a7d2
Reviewed-on: http://review.couchbase.org/16049
Tested-by: Trond Norbye <trond.norbye@gmail.com>
Reviewed-by: Trond Norbye <trond.norbye@gmail.com>
  • Loading branch information...
1 parent 877bacc commit 63c9ae6d7f42615bbd2fbd74d51e46c463c2814b @trondn trondn committed May 16, 2012
Showing with 3 additions and 2 deletions.
  1. +3 −2 include/libcbio/cbio.h
@@ -312,10 +312,11 @@ extern "C" {
*
* Please note that the values returned points to the data inside
* the document and will be invalidated as soon as the docment is
- * invalidated.
+ * invalidated. If you just want to query the length of the value
+ * you should specify NULL for the value pointer.
*
* @param doc the document to get the value from
- * @param value where to store the pointer to the value
+ * @param value where to store the pointer to the value.
* @param value the number of bytes in the value
* @return CBIO_SUCCESS upon success, or an appropriate error code
* describing the problem.

0 comments on commit 63c9ae6

Please sign in to comment.