Uploaded image for project: 'WiredTiger'
  1. WiredTiger
  2. WT-8172

Create and generate the docs for the CPP testing framework

    • Type: Icon: Documentation Documentation
    • Resolution: Duplicate
    • Priority: Icon: Major - P3 Major - P3
    • None
    • Affects Version/s: None
    • Component/s: None
    • None
    • 0

      This ticket is a placeholder to think about how we could generate documentation about the cpp testing framework.

      We could use Doxygen and host the doc in our usual repo for documentation.

      Adding the cppsuite folder is easy, we simply need to add ../../test/cppsuite to the INPUT tag of the Doxyfile.

      Since the files are not documented yet, we need to keep running despite all the warnings by setting WARN_AS_ERROR to NO.

      However, it gets mixed with the existing documentation which is not great, see the screenshot attached.

        1. cpp doxygen.png
          264 kB
          Etienne Petrel

            Assignee:
            etienne.petrel@mongodb.com Etienne Petrel
            Reporter:
            etienne.petrel@mongodb.com Etienne Petrel
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Created:
              Updated:
              Resolved: