[CDRIVER-4133] Document possible values for mongoc_host_list_t.family Created: 18/Aug/21 Updated: 10/Feb/23 |
|
| Status: | Backlog |
| Project: | C Driver |
| Component/s: | docs |
| Affects Version/s: | None |
| Fix Version/s: | None |
| Type: | Improvement | Priority: | Minor - P4 |
| Reporter: | Jeremy Mikola | Assignee: | Unassigned |
| Resolution: | Unresolved | Votes: | 0 |
| Labels: | documentation, neweng | ||
| Remaining Estimate: | Not Specified | ||
| Time Spent: | Not Specified | ||
| Original Estimate: | Not Specified | ||
| Issue Links: |
|
||||||||||||
| Description |
|
mongoc_host_list_t is a public struct, but no documentation is provided for its int family field. AFAIK, possible values for that field come from a subset of the AF_* constants defined in socket(2). The documentation would do well to discuss this. This came up during a code review for |