File APIs for Java Developers
Manipulate DOC, XLS, PPT, PDF and many others from your application.
A friendly place for programming greenhorns!
Big Moose Saloon
Register / Login
Win a copy of
REST with Spring (video course)
this week in the
Developer Certification (SCJD/OCMJD)
You must create a full suite of documentation for the classes of the completed projec
Joined: Jan 05, 2006
Feb 20, 2006 11:06:00
A question regarding the specification assignment:
You must create a full suite of documentation for the classes of the completed project.
What is a full suite?
Does this mean that the javadoc must be generated with the
flag when running javadoc?
Note: Default mode when running javadoc is
Joined: Dec 09, 2003
Feb 20, 2006 14:06:00
I interpreted this to mean that you need javadoc for each package, class and method. (The doc for the package and the class is just a few lines long for each.) You don't need to use the -private flag.
It is sorta covered in the
JavaRanch Style Guide
subject: You must create a full suite of documentation for the classes of the completed projec
Disallowed to use private inner classes?
NX: Should I reformat the provided interfaces comments?
java doc for private members
All times are in JavaRanch time: GMT-6 in summer, GMT-7 in winter
| Powered by
Copyright © 1998-2015