Uploaded image for project: 'C Driver'
  1. C Driver
  2. CDRIVER-1497

libbson: Document all exported symbols

    XMLWordPrintable

    Details

    • Type: Epic
    • Status: Closed
    • Priority: Major - P3
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 1.7.0
    • Component/s: None
    • Labels:
      None
    • Epic Name:
      document-exported-symbols

      Description

      Currently the following exported symbols are missing a manpage:

      • bcon_append
      • bcon_append_ctx
      • bcon_append_ctx_init
      • bcon_append_ctx_va
      • bcon_extract
      • bcon_extract_ctx
      • bcon_extract_ctx_init
      • bcon_extract_ctx_va
      • bcon_new
      • bson_array_as_json
      • bson_ascii_strtoll
      • bson_atomic_int64_add
      • bson_atomic_int_add
      • bson_bcone_magic
      • bson_bcon_magic
      • bson_copy_to_excluding_noinit
      • bson_get_monotonic_time
      • bson_gettimeofday

      I don't think we need to be documenting the bcon_ ones, since they aren't exactly invoked directly but through the BCON macros, but the others really should be documented.

        Attachments

          Activity

            People

            Assignee:
            backlog-c-driver Backlog - C Driver Team
            Reporter:
            bjori Hannes Magnusson
            Participants:
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Dates

              Created:
              Updated:
              Resolved: