• 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

NX: URLy Bird 1.3.1 JavaDocs

 
Ranch Hand
Posts: 493
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • Quote
  • Report post to moderator
Hello All,
I have a question about JavaDoc as applicable to this project. My index.html page lists the packages that I have as follows:
----------------------------------------------------------------------------
Packages
----------------------------------------------------------------------------
suncertify.dbnothing here, I would like to see package description
----------------------------------------------------------------------------
Pardon my terrible graphics, but what I am after is that the index page contains an html table in the right pane which lists the packages that I have and should contain a brief description of the package. I am not sure how to do that, i.e., how do I get a brief description of the package to appear in the index.html page?
Thanks.
Bharat
[ October 30, 2003: Message edited by: Bharat Ruparel ]
[ October 30, 2003: Message edited by: Bharat Ruparel ]
 
Greenhorn
Posts: 19
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • Quote
  • Report post to moderator
Bharat,
At the package level you need a package.html that should have your description inside the body tag. The first line of your description is put in the header under your package name, while the rest of the description follows at the bottom under the Description header.
hope that helps
- Lanuk
 
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 Bharat,
You might want to look at the Sun tutorial on writing javadoc comments, which includes a section on Package-Level Comments.
Regards, Andrew
reply
    Bookmark Topic Watch Topic
  • New Topic