Finalise tutorial material and API documentation
S-01708
As a prospective end-user I want more information about the ExSeisDat project and the ExSeisPIOL and the ExSeisFlow so that I can use the libraries.
PreDev Notes:
An approach could be as follows: Add a doxygen command, e.g. @docs_reviewed
, and add it to each reviewed piece of documentation. Ideally, there may be some mechanism for generating an error if a doc doesn't have the command. Then, remove the command.
Implementation Notes:
ADDME
System Test Changes:
ADDME
Bug Fixes:
ADDME
C++ API Changes:
ADDME
C API Changes:
ADDME
Success Criteria:
-
Ensure the API documentation is complete, correct, and useful. -
Documentation Review process is updated
CREATED ON - 05/02/2018