• Post Reply
  • Bookmark Topic Watch Topic
  • New Topic

B&S: How to provide javadoc for Packages?

 
Darya Akbari
Ranch Hand
Posts: 1855
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi,

I like to provide javadoc comments for all my packages but don't know how .

Any hints are welcome

Regards,
Darya
 
Frans Janssen
Ranch Hand
Posts: 357
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Put a file called "package.html" in every package and add comments in html format to these files.

Frans.

Note: the name must really be "package.html", so don't replace package with the actual package name.
 
Darya Akbari
Ranch Hand
Posts: 1855
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi Frans,

thanks for the info and thanks Andrew for your example in How to include package info into Javadocs

Regards,
Darya
 
Darya Akbari
Ranch Hand
Posts: 1855
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
... and how can I get a title lets say "Bodgitt and Scarper API Specification" onto my javadoc HTML

Regards,
Darya
 
Frans Janssen
Ranch Hand
Posts: 357
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Originally posted by Darya Akbari:
... and how can I get a title lets say "Bodgitt and Scarper API Specification" onto my javadoc HTML

If you want a specific header to all generated files, use the following option to the javadoc command:


Frans.
 
Darya Akbari
Ranch Hand
Posts: 1855
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi Frans,

the -header option is also nice I'll keep that, however I want the text to be on Overview right above the Package descriptions.

Any hint

Regards,
Darya
 
Olena Golub
Ranch Hand
Posts: 113
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hallo Darya,


-doctitle title
Specifies the title to be placed near the top of the overview summary file. The title will be placed as a centered, level-one heading directly beneath the upper navigation bar. The title may contain html tags and white space, though if it does, it must be enclosed in quotes. Any internal quotation marks within title may have to be escaped.

C:> javadoc -doctitle "Java<sup><font size=\"-2\">TM</font></sup>" com.mypackage


You can find all javadoc option at
javadoc

Regards,
Olena
[ June 02, 2005: Message edited by: Olena Golub ]
 
Darya Akbari
Ranch Hand
Posts: 1855
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi Olena,

that's exactly I was looking for.

Thanks,
Darya
 
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic