• Post Reply
  • Bookmark Topic Watch Topic
  • New Topic

I am close to submit - quetion about javadoc

 
Mike Tilling
Ranch Hand
Posts: 86
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi

I am close to submit (hopefully)

It was mentionned in my assignement (UrlyBird) that a javadoc style documentation must be provided for all the classes.

-Do We provide a javadoc style (one html page) for each package?
-or we have to provide a java doc style for each class separatly?

Best Regards
 
Andrew Monkhouse
author and jackaroo
Marshal Commander
Pie
Posts: 12014
220
C++ Firefox Browser IntelliJ IDE Java Mac Oracle
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi Mike,

May I suggest you take a look at Use a Meaningful Subject Line? Having the comment that you are close to submitting in the subject line does not help explain what the topic is about, and in fact may induce some people to skip your post if they cant be bothered working out what the subject is about.

I would suggest you look at the javadoc that is provided for the J2SE API. From a single page, I can see every package and every class. I can then narrow it down as desired.

Regards, Andrew
 
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic