• Post Reply Bookmark Topic Watch Topic
  • New Topic

how to use javadoc for getting API like Java  RSS feed

 
Maulin Vasavada
Ranch Hand
Posts: 1873
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
hi all,
i've two packages,
com.company.pk1
com.company.pk2
now i want to generate javadoc such that we have for java api. meaning with three frames.
1. package list
2. class list (below the package list)
3. description frame that displays class details on right
how do i do that?
i'm doing following,
c:\maulin>javadoc -d JavaDocs -author com\company\pk1\*.java com\company\pk2\*.java
i have com\ directory under c:\maulin only.
but i don't get the view i want in generated index.html page. i get only two frames.
left frame has list of classes. right frame has description of a class selected in left frame.
how can i get three frames as i described?
thank you.
maulin.
 
michael o'malley
Greenhorn
Posts: 2
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Maulin
Try declaring them as packages instead com.company.pk1 com.company.pk2 but remember to set the classpath to the current directory so javadoc knows where to start searching (-classpath . ).
Michael
 
Michael Morris
Ranch Hand
Posts: 3451
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi Maulin,
You need to let javadoc know what the packages are. The easiest way to do that is to put a file at the top level (.) of the package listing the packages.
Here is the batch file I used to genereate the docs for my developer assignment:
makedocs.bat

What you're interested in here is the variable %PK% which is set to @package.txt. Here are the contents:
package.txt

Of course, you'll want to use your packages here.
Hope this helps,
Michael Morris
 
Maulin Vasavada
Ranch Hand
Posts: 1873
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
hi Michael,
great help!
i prepared my batch file and now it works the way i want.
thanks a lot.
regards
maulin.
 
It is sorta covered in the JavaRanch Style Guide.
  • Post Reply Bookmark Topic Watch Topic
  • New Topic
Boost this thread!