aspose file tools*
The moose likes Java in General and the fly likes JavaDoc problem Big Moose Saloon
  Search | Java FAQ | Recent Topics | Flagged Topics | Hot Topics | Zero Replies
Register / Login
JavaRanch » Java Forums » Java » Java in General
Bookmark "JavaDoc problem" Watch "JavaDoc problem" New topic
Author

JavaDoc problem

Kay Tracid
Ranch Hand

Joined: Mar 06, 2002
Posts: 148
Hi,
I have one .java file with some classes and I dont know how to seperate them. I want to use javadoc but I it seems only to work with packages. Can you help me please?
Thanks a lot!
Kay Tracid
Ranch Hand

Joined: Mar 06, 2002
Posts: 148
Ok, I get it, but always only the one public class in the .java file is documented.
I call:
>javadoc -d C:\Test\Projekt\ C:\Test\Projekt\aFile.java
can you help?
Cindy Glass
"The Hood"
Sheriff

Joined: Sep 29, 2000
Posts: 8521
JavaDoc is a tool to explain to the public how to access the "application public interface".
If the public can not get at the class - it will not be documented in the API.
From javadoc - The Java API Documentation Generator.
The JavadocTM tool parses the declarations and documentation comments in a set of Java source files and produces a corresponding set of HTML pages describing (by default) the public and protected classes, nested classes (but not anonymous inner classes), interfaces, constructors, methods, and fields.


"JavaRanch, where the deer and the Certified play" - David O'Meara
Kay Tracid
Ranch Hand

Joined: Mar 06, 2002
Posts: 148
Thanks! Is there a way to change my single file with the classes into a package with different files? I get always an error if I make a class to a .java file. For example the class "Statement" is not found, but i imported all i need...
Cindy Glass
"The Hood"
Sheriff

Joined: Sep 29, 2000
Posts: 8521
Well, yeah. You would put each class in a separate file, and add a package statement to each file, then make sure that the files reside in a subdirectory with the name of that package until you get it jarred up.
Of course that is not really going to affect your JavaDoc unless you also make the classes public or protected.
 
I agree. Here's the link: http://aspose.com/file-tools
 
subject: JavaDoc problem