[CDRIVER-2881] Remove comment blocks on public functions Created: 12/Nov/18  Updated: 09/Feb/23

Status: Backlog
Project: C Driver
Component/s: docs, Docs Examples, libbson, libmongoc
Affects Version/s: None
Fix Version/s: None

Type: Task Priority: Trivial - P5
Reporter: Kevin Albertson Assignee: Unassigned
Resolution: Unresolved Votes: 0
Labels: neweng
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified


 Description   

Per our documentation convention, we should only document public facing functions in one place.

This helps prevents cases like this where we have multiple contradictory copies of a function's documentation.

Let's do one big sweep of our public API:

  • transfer any useful info from comment blocks into the .rst doc page
  • remove those comment blocks

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