Win a copy of The Little Book of Impediments (e-book only) this week in the Agile and Other Processes forum!
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic

How do you use javadoc arguments?

 
Ailsa Cape
Ranch Hand
Posts: 92
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi, everyone

I want to know when you use javadoc tools to provide the javadoc documentation for uploading, do you use the "-private" argument to generate all your classes and methods comments?

I also find in the javadoc documentation directory, there are 11 html files such as index.html,index-all.html,help-doc.html etc. and 2 subdirectories. Is this structure correct?

Thanks in advance!
Regards, Ailsa Cape
 
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 Ailsa,

Check your instructions for what Javadoc you must supply.

I would assume that the directory structure created by Javadoc is correct .

Regards, Andrew
 
Ailsa Cape
Ranch Hand
Posts: 92
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi, Andrew

Thank you again!

My instructions state that a subdirectory called doc, containing Javadoc documentation for all classes and interfaces you are submitting. So do I have to use the "-private" argument when I use the javadoc tools?

Thanks in advance!
Best Regards, Ailsa Cape
 
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 Ailsa,

I was meaning that you should look at the "Documentation" sub-section in the "What you must do" section of your instructions.

Regards, Andrew
 
Ailsa Cape
Ranch Hand
Posts: 92
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi, Andrew

Thank you!

I just read my instructions in the subsection, "javadoc style commments must be used for each element of the public interface of each class...Provide javadoc documentsation for all classes you write", so I think I have to use the "private" parameter in javadoc tools.

Best Regards, Ailsa Cape
 
Frans Janssen
Ranch Hand
Posts: 357
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Originally posted by Ailsa Cape:
Hi, Andrew

Thank you!

I just read my instructions in the subsection, "javadoc style commments must be used for each element of the public interface of each class...Provide javadoc documentsation for all classes you write", so I think I have to use the "private" parameter in javadoc tools.

Best Regards, Ailsa Cape


Hi Ailsa,

Are you sure that private methods are part of the public interface of a class?

Frans.
 
Ailsa Cape
Ranch Hand
Posts: 92
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi,Frans

Thank you for your answer. I should change my thought. Private methods are not part of the public interface of a class.

Regards, Ailsa Cape
 
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic