This week's book giveaway is in the OO, Patterns, UML and Refactoring forum. We're giving away four copies of Refactoring for Software Design Smells: Managing Technical Debt and have Girish Suryanarayana, Ganesh Samarthyam & Tushar Sharma on-line! See this thread for details.
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?
Ashik Uzzaman Lead Member of Technical Staff, Salesforce.com, San Francisco, CA, USA.
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)
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.
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 .....
I’ve looked at a lot of different solutions, and in my humble opinion Aspose is the way to go. Here’s the link: http://aspose.com