[CXX-297] C++ "Examples" doc is incomplete Created: 06/Aug/14  Updated: 23/Oct/14  Resolved: 23/Oct/14

Status: Closed
Project: C++ Driver
Component/s: Documentation
Affects Version/s: None
Fix Version/s: legacy-1.0.0-rc1

Type: Bug Priority: Major - P3
Reporter: Stennie Steneker (Inactive) Assignee: Tyler Brock
Resolution: Done Votes: 0
Labels: legacy-cxx
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified


 Description   

The docs/nav for 0.11.0 and 1.0.0 include an examples page:
http://api.mongodb.org/cxx/legacy-0.11.0/examples.html
http://api.mongodb.org/cxx/legacy-1.0.0-rc0/examples.html

In both cases the "using" example is incomplete:
http://api.mongodb.org/cxx/legacy-1.0.0-rc0/_using-example.html

Not sure if that is a doxygen fail, but these pages aren't useful at the moment.



 Comments   
Comment by Tyler Brock [ 20/Aug/14 ]

https://github.com/mongodb/mongo-cxx-driver/commit/425563cce6d697edd507f6162d6aee9954512bf2

Comment by Githook User [ 20/Aug/14 ]

Author:

{u'username': u'TylerBrock', u'name': u'Tyler Brock', u'email': u'tyler.brock@gmail.com'}

Message: CXX-297 prevent rogue example from entering docs
Branch: legacy
https://github.com/mongodb/mongo-cxx-driver/commit/425563cce6d697edd507f6162d6aee9954512bf2

Comment by Tyler Brock [ 20/Aug/14 ]

This is a source fail. We have an @example directive in src/mongodb/json.h

I will remove the @.

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