[CDRIVER-1531] Document libbson helper macros at the same page as the underlying function Created: 08/Sep/16  Updated: 01/May/17  Resolved: 28/Apr/17

Status: Closed
Project: C Driver
Component/s: docs, libbson
Affects Version/s: None
Fix Version/s: 1.7.0

Type: Improvement Priority: Major - P3
Reporter: Hannes Magnusson Assignee: Hannes Magnusson
Resolution: Done Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified


 Description   

libbson has plenty of helper macros to allow skipping passing -1 arguments and have the underlaying function run strlen() on the argument.

These macros aren't really well documented.
We do have a blurb about them at http://mongoc.org/libbson/current/creating.html

Libbson provides macros to....

but it would be better if we would document the BSON_APPEND_UTF8 macro on the same page as we document bson_append_utf8



 Comments   
Comment by Githook User [ 28/Apr/17 ]

Author:

{'name': 'Hannes Magnusson', 'email': 'bjori@php.net', 'username': 'bjori'}

Message: CDRIVER-1531 Document libbson helper macros at the same page as the underlying function
Branch: master
https://github.com/mongodb/libbson/commit/6fd208cd8eef4ebbf893631832738e4368672bdc

Generated at Wed Feb 07 21:12:49 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.