Automate Test Plan Document Creation

Description

Add standardized code commenting blocks to the integration test functions to allow for automatic test plan document generation using a standard tool such as Doxygen or Javadoc. The content will be standardized across all drivers, but some syntax special cases may exist. Content should include items like (list below is an example, will be discussed before implementation):

Name of the test
Brief Description of what the test is intended to do
Parameter descriptions
Return value description (if any)
Thrown exception description (if any)
Driver version when test was introduced
Expected Test Result
List of special test setup/assumptions that must be satisfied before test is run (if any)

Environment

None

Pull Requests

None
Won't Do

Assignee

Unassigned

Reporter

Rick Smith

Labels

PM Priority

None

External issue ID

None

Doc Impact

None

Reviewer

None

Pull Request

None

Size

None

Epic Link

Sprint

CPP P-TEST

Priority

Minor