File APIs for Java Developers
Manipulate DOC, XLS, PPT, PDF and many others from your application.
http://aspose.com/file-tools
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic

Javadoc Question

 
David Sham
Ranch Hand
Posts: 61
  • 0
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
I have a stupid question about the javadoc for the assignment. I have about 18 java source files and after I ran javadoc for my project it generated about 43 html files. In the Exam Cram 2 Java 2 Developer book by Alain Trottier he said he had 10 source files that produced 100 javadoc html files.

Are we supposed to somehow link our javadoc to the J2SE javadoc API? Otherwise, references to any J2SE core classes do not show up as links in my javadoc. I would think this is ok - that we do not need to link to the core API.

Just wondering since my project did not generate as many javadoc files as the Exam Cram book related to.

Thanks for any input!!
 
Frans Janssen
Ranch Hand
Posts: 357
  • 0
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi David,

I don't think it matters for the number of generated files if you link to the core classes or not. As far as I can tell the only difference is that it creates links. Which is nicer IMHO.

Your number of files sound about correct by the way. It will generate a html file for every class or interface and some extra for every package and some for the entire project. A 100 would seem a bit too much to me.

Frans.
[ May 27, 2005: Message edited by: Frans Janssen ]
 
David Sham
Ranch Hand
Posts: 61
  • 0
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
So, then how do you link your javadoc to the core classes API javadoc? Or is this required?

Thanks for any input!
 
Daniel Dalton
Ranch Hand
Posts: 146
  • 0
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
You can make your javadoc link to the J2SE docs with the link attribute on the javadoc command. Here's the ant target I use:

 
Frans Janssen
Ranch Hand
Posts: 357
  • 0
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
I used this command:



Frans.
 
It is sorta covered in the JavaRanch Style Guide.
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic