Javadoc newbie - how to get "USE" content
I don't understand how to get content from the USE button. At the moment all my attempts produce a USE button which links to a page stating something like "No usage of root.package.class".
My current argument string for Javadoc is something like
-d c:\Doc -use C:\Source\
This doesn't work (produces a nice set of pages with the above problem on the "USE" page). To be specific there is no USE content even for two classes in the same package where one is used by the other.
I've tried guessing some longer combinations of terms leading up to:
-d c:\Doc -use -sourcepath C:\Source\ -classpath C:\Classes\ -subpackages root.packageA root.packageB C:\Source\*.java
though still to no avail. Please can someone offer some advice? Thanks very much
No. Imports are considered by Javadoc to be part of the implementation. If you notice, javadoc does not document imports. Imports are completely ignored by Javadoc, other than to resolve names.
A "use" is where a type appears in a declaration, not an import or other implementation.
"Given class C, things that use class C would include subclasses of C, fields declared as C, methods that return C, and methods and constructors with parameters of type C."
http://java.sun.com/j2se/1.5.0/docs/tooldocs/windows/javadoc.html#use
--
Example 1: Class A does *not* use class B:
import B;
public class A {
new B();
}
public class B {
}
--
Example 2: method getValue uses B:
public class A
void getValue(B b) {
}
}
public class B {
}
OK, thankyou, this has been helpful.
However, I'm still not there yet as I believe that several classes meet the "USE" criteria, e.g. have class field declarations such as
C c = new C(c);
And I note also the sentence from the same link:
"Note that this documents only uses of the API, not the implementation. If a method uses String in its implementation but does not take a string as an argument or return a string, that is not considered a "use" of String."
Which is interesting but I don't yet see how one could fall foul of this rule without having passed the criteria that you quoted to me.
Anyway, thankyou for your help todate - I need to think a little more on this to workout where I've gone wrong.
