Win a copy of Mesos in Action this week in the Cloud/Virtualizaton forum!
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic

javadoc and......

 
Ashik Uzzaman
Ranch Hand
Posts: 2373
Eclipse IDE Firefox Browser Java
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi,
(1) I want to document the project i am working in. What i did earlier was copied hundreds of files to a common directory and tried javadoc -private *.java . But i did not know that there is a option to that javadoc will itself find out all the java files to document in a directory structure. Want to know of that parameter from u guys.
(2) If a few of my java files are not properly coded (so will give javac compiler error), then would javadoc not create the html pages?
 
Roy Ben Ami
Ranch Hand
Posts: 732
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
as to your second question:
you are correct in your assumption.
javadoc first compiles the code using javac then generates the html, therefore if your files wont compile , it wont generate help for them either (or should it be neither)
 
Rob Ross
Bartender
Posts: 2205
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
I've heard rumors that the newest Javadoc will traverse source directories recursively, but I don't know if that's true or not.
What I usually do is I create a text file that contains the names of all the packages in my project, then I pass this textfile as a paramater to javadoc via the @files paramater.
Also, you are correct that the source files must compile. Javadoc actually pre-parses the sourcecode by calling javac on your source files, so if they won't compile, it won't create any javadocs for them.
 
Ashik Uzzaman
Ranch Hand
Posts: 2373
Eclipse IDE Firefox Browser Java
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Thnx Roy & Rob....i have tested my second assumption that i was correct. So the files that won't compile should be out of the folder.
The first query should be true as i have heard....so still waiting .....
 
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic