On where to document the API.
Bob Tarling wrote:
...
> Should we keep some document for this in CVS to update as required.
My answer is, yes.
Firstly it should be documented in the java classes by having the API
methods public/protected and the API classes and interfaces public while
the non-API methods should be default or private. This will be generated
(nightly) into the API-version of the javadoc. This will make sure that
the code is always consistent with the documentation since it is the
same.
If there are needs for any specific discussions it should also be
documented in the Cookbook, chapter 5 in the correct section for the
subsystem providing the API.
/Linus
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
