documentation
Chad Berkley
berkley at nceas.ucsb.edu
Fri May 3 09:32:45 PDT 2002
Hi,
I'm working on EML and I've come to realize that our documentation tags
seem kind of redundant sometimes. We have a tooltip, summary and
description tag which a lot of times contain mostly the same text. I
would like to propose that we do something similar to javadoc where we
only have one description tag, then as a rule, use the first sentence of
the description for the tooltip, maybe the first two sentences for any
summary and the rest for the full description. that would eliminate a
lot of redundant documentation.
any thoughts?
chad
More information about the Eml-dev
mailing list