[Cdk-devel] [Javadoc] A simple way to improve documentation.

[M.Le_maudit <mle...@us...>]

Hello everyone.

For a while, I've been reading CDK, JChemPaint and related projects' source
code and as mentioned on the CDK website, it is obvious that an effort may
be made to improve documentation available through Javadoc comments. Am I
wrong? ;-)

So, in order to help developers writing - let's be ambitious ;-) -
*excellent* Javadoc comments, I though it might be interesting to develop
Javadoc comment templates. These comment templates might be used to document
the CDK project, but they also might be helpful for the other related
projects, such as JChemPaint, Jmol, and the most recent QSAR.

These templates would at least bring these benefits:
- homogenous documentation for all the previously mentioned projects.
- no need to look for Javadoc's expected information: the complete
documentation requirements would be available through these templates.

What do you think about this idea?


Yours.
M.