I'd like to take a crack at expanding the Javadoc in the sca itests, and
I'd like some feedback on the benefit and conventions of doing so.

I've noticed that the Javadoc in the sca/itests could be enhanced (or in
many cases is absent altogether). Javadoc seems to me a great way to
document the intent of the test cases.  Including the package.html and
overview.html files will allow a single source of documentation.  This will
allow us to more easily assess test coverage of concepts (rather than merely
API's).

As for javadoc conventions:

I'd like to add javadoc to the src/test subdirectories.  This is where we
would document the scenario being tested.  (e.g. Attempt to locate a service
with an invalid name.)

I'd like to add javadoc to the src/main subdirectories to describe the
requirements on the services (e.g.  This must be a composite within a
composite....) for the test case scenario to be achieved.

Please let me know if you'd like me to add or subtract from the above.

Reply via email to