Bug #84
closed
create javadoc documentation
Added by Matt Jones over 24 years ago.
Updated over 22 years ago.
Category:
morpho - general
Description
Need to create javadoc documentation for all public and protected methods and
fields in dmanclient. See the format used in xmltodb for formatting. These are
particulary needed for the querybean can dtclient packages, and the mde
documentation needs to be brought up to date.
I consider this relatively low priority as long as code is changing. (User won't
look at javadoc anyway; developer can always generate it himself)
Increased the priority and milestone for this. I consider it a high priority
for developers to keep all of their code documented as they write it. This
doesn't mean they need to create the javadoc html pages, but only that all
public and protected methods and fields should have javadoc comments in the code
so that other developers (like me) can understand how the code works, in its
current state. Any complex algorithms should be documented in the code as well,
so that the intent of the complex algorithm is clear to others reading the
code. At a minimum, the purpose and approach used in each class should be
documented for the class overall.
Javadoc documentation now exists in all classes
Original Bugzilla ID was 84
Also available in: Atom
PDF