Tooling for documenting tests and cross-referencing them with the code they test

Christopher Werner
2018-11-06T13:57:00Z

S-01743

As a ExSeisDat Developer I want the tests to be documentable, with a cross-reference between functions and their unit tests.

PreDev Notes:

Doxygen has capabilities for cross-referencing. It looks like there's a \test command, but it's not clear if it does the cross-referencing.

Implementation Notes:

ADDME

System Test Changes:

ADDME

Bug Fixes:

ADDME

C++ API Changes:

ADDME

C API Changes:

ADDME

Success Criteria:

The test documentation, and the test to function cross reference should reside with the test code.

When looking at a function in the documentation, a link to the relevant test or tests should be available.

CREATED ON 03/08/2018