[CXX-796] Improve bsoncxx doc comments Created: 04/Jan/16  Updated: 08/Jan/24  Resolved: 27/Jan/16

Status: Closed
Project: C++ Driver
Component/s: Documentation
Affects Version/s: None
Fix Version/s: 3.0.0

Type: Improvement Priority: Major - P3
Reporter: Andrew Morrow (Inactive) Assignee: Mira Carey
Resolution: Done Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Epic Link: C++11 Driver MongoDB 3.2

 Description   

The following classes in the bsoncxx directory are missing doxygen documentation:

  • bsoncxx::array::element
  • bsoncxx::array::view::[const_]iterator
  • bsoncxx::builder::array::stream_context
  • bsoncxx::builder::stream::key_context
  • bsoncxx::builder::stream::single_context
  • bsoncxx::builder::stream::value_context
  • bsoncxx::document::element
  • bsoncxx::document::view::[const_]iterator


 Comments   
Comment by Githook User [ 27/Jan/16 ]

Author:

{u'username': u'hanumantmk', u'name': u'Jason Carey', u'email': u'jcarey@argv.me'}

Message: CXX-796 Improve bsoncxx doc comments

Replaced doc todo's under bsoncxx with doc comments.
Branch: master
https://github.com/mongodb/mongo-cxx-driver/commit/6e3c2fd837a3ab86f91d43f8a3eed3115caa5537

Comment by Mira Carey [ 26/Jan/16 ]

https://github.com/mongodb/mongo-cxx-driver/pull/453

Comment by Andrew Morrow (Inactive) [ 25/Jan/16 ]

mira.carey@mongodb.com - I tagged all of the missing documentation with doxygen @todo markers, so it should be very easy to find everything that needs to be documented now.

Generated at Wed Feb 07 22:00:22 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.