• Post Reply Bookmark Topic Watch Topic
  • New Topic
programming forums Java Mobile Certification Databases Caching Books Engineering Micro Controllers OS Languages Paradigms IDEs Build Tools Frameworks Application Servers Open Source This Site Careers Other Pie Elite all forums
this forum made possible by our volunteer staff, including ...
Marshals:
  • Campbell Ritchie
  • Jeanne Boyarsky
  • Ron McLeod
  • Paul Clapham
  • Liutauras Vilda
Sheriffs:
  • paul wheaton
  • Rob Spoor
  • Devaka Cooray
Saloon Keepers:
  • Stephan van Hulst
  • Tim Holloway
  • Carey Brown
  • Frits Walraven
  • Tim Moores
Bartenders:
  • Mikalai Zaikin

How do you use javadoc arguments?

 
Ranch Hand
Posts: 92
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • 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
 
author and jackaroo
Posts: 12200
280
Mac IntelliJ IDE Firefox Browser Oracle C++ Java
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • 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
    Number of slices to send:
    Optional 'thank-you' note:
  • 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
Posts: 12200
280
Mac IntelliJ IDE Firefox Browser Oracle C++ Java
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • 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
    Number of slices to send:
    Optional 'thank-you' note:
  • 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
 
Ranch Hand
Posts: 357
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • 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
    Number of slices to send:
    Optional 'thank-you' note:
  • 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
reply
    Bookmark Topic Watch Topic
  • New Topic