[CDRIVER-2099] Undocument oldest deprecated functions Created: 24/Mar/17  Updated: 12/May/23  Resolved: 12/May/23

Status: Closed
Project: C Driver
Component/s: docs
Affects Version/s: None
Fix Version/s: 1.24.0

Type: Improvement Priority: Minor - P4
Reporter: A. Jesse Jiryu Davis Assignee: Kevin Albertson
Resolution: Done Votes: 0
Labels: neweng
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Quarter: FY24Q2

 Description   

Rather than rev to 2.0 and actually break API, an alternative way to clean up the user experience of the driver is to remove the oldest and most-regretted APIs from the documentation. This will make it clearer to readers which functions are recommended to accomplish a given task.



 Comments   
Comment by Githook User [ 12/May/23 ]

Author:

{'name': 'Kevin Albertson', 'email': 'kevin.albertson@mongodb.com', 'username': 'kevinAlbs'}

Message: CDRIVER-2099 Remove some deprecated documentation (#1265)

  • remove docs for `bson_md5_*`
  • remove documentation for mongoc_matcher_t
  • remove documentation for `mongoc_client_get_max_*_size`
  • use `BSON_GNUC_DEPRECATED_FOR` in bson_oid_init_sequence

The documentation suggests using bson_oid_init as an alternative.

  • move "Deprecated" sections above "Synopsis"

And uses consistent verbage.

  • add missing `BSON_GNUC_DEPRECATED` attributes
Comment by Kevin Albertson [ 06/Mar/23 ]

I suggest removing documentation for API with the BSON_GNUC_DEPRECATED attribute.
I suggest leaving the documentation for API with the BSON_GNUC_DEPRECATED_FOR, since it may help users find the alternate non-deprecated API.

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