• Post Reply
  • Bookmark Topic Watch Topic
  • New Topic

am I using the javadoc tool correctly

 
Mike Tilling
Ranch Hand
Posts: 86
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
It was mentioned in my assignment:

1. �You must create a full suite of documentation for the classes of the completed project. This must be generated using the tool javadoc and must be in HTML format. Provide javadoc documentation for all classes you write�.
2. � the submission package must contain a directory called docs which must contain a subdirectory called javadoc, containing HTML/Javadoc documentation for all classes and interfaces you are submitting.�

-I used javadoc tool like that:

Javadoc c:\suncertify\db\*.java c:\suncertify\gui\*.java c:\suncertify\rmi\*.java c:\suncertify\locking\*:java -d c:\javadoc

As a result, two folders are created within javadoc : resources and suncertify and four folders are created within the suncertify folder (db, rmi, locking and gui), an html file was created for each class plus the package-frame.html, package-tree.html and package-summary.html files,

Do I keep everything within the javadoc folder in the final submission or I have to keep only the html files that have the same name as the class names (I mean do I have to remove) :
1-the folder resources
2-the files package-frame.html, package-tree.html, package-summary.html from each folder
3- do I have to keep the same folder structure, I mean can I put all the html files that have the same names as the classes directly within the the javadoc folder.

Please which one fits the best with the exam spec?
 
Thirumurugan Mylrajan
Ranch Hand
Posts: 64
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
In my personal opinion, you should not modify the output of javadoc tool. Just generate the javadocs inside the "javadocs" folder.

To modify the javedocs, just modify the comments in the code and run javadoc again.

Modifying the directory structure inside might create missing links and other hedaches.
 
Ed Tse
Ranch Hand
Posts: 183
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
You shouldn't remove anything that javadoc built for you
 
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic