Win a copy of The Business Blockchain this week in the Cloud forum!
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic

Need help on javadoc

 
Konstantin Vedernikov
Greenhorn
Posts: 6
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi guys!

I am working on javadoc now.

Can anybody say how to make comment for some particular package so
index page that contains two column table of packages will show the
comment for the package in second column.

In fact I use ant to generate doc and to make build for submission.
I would be greatly appreciated if you pointed how to accomplish it in ant.

Thank you. Konstantin.
[ October 23, 2004: Message edited by: Konstantin Vedernikov ]
 
Anton Golovin
Ranch Hand
Posts: 527
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Good to see a fellow compatriot doing the project as well... I submitted mine about three weeks ago and currently am waiting for the score. About Javadoc... my IDE put a package.html file in source package directory (in this case, suncertify)... that file had the following information:

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<html>
<head><!--
Copyright (c) 2004 by URLyBird, Inc. URLyBird, Inc.
All Rights Reserved.
--></head>

<body bgcolor="white">Contains the classes which comprise the URLyBird Room-Booking application.
<!-- Put @see and @since tags here. --></body>
</html>

I would guess that only the first text sentence from this file is actually displayed in the manner you wish it to be displayed. Any folloup info is displayed on the page for that package.

The tool which was used to generate documentation was the generic javadoc, so it should work for you as well
[ October 23, 2004: Message edited by: Anton Golovin ]
 
Konstantin Vedernikov
Greenhorn
Posts: 6
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
It works! Thanks Anton!
 
Anton Golovin
Ranch Hand
Posts: 527
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Originally posted by Konstantin Vedernikov:
It works! Thanks Anton!


You're most welcome. Good luck with your project!
 
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic