[CDRIVER-2768] Delete comment blocks for functions documented in RST Created: 26/Jul/18  Updated: 06/Mar/23  Resolved: 06/Mar/23

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

Type: Improvement Priority: Trivial - P5
Reporter: A. Jesse Jiryu Davis Assignee: Unassigned
Resolution: Won't Do Votes: 0
Labels: bgtrack
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Related
Backwards Compatibility: Fully Compatible

 Description   

The large comment blocks in .c files for public functions are an artifact of the Doxygen system we abandoned years ago. They're drifting apart from the proper docs maintained in Restructured Text .RST files now. Delete all such comment blocks from .c files for functions documented in RST.



 Comments   
Comment by Kevin Albertson [ 06/Mar/23 ]

Closing in favor of CDRIVER-4574. CDRIVER-4574 proposes using Doxygen to document API.

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