|
mjc | ||||||||||
| PREV NEXT | FRAMES NO FRAMES | ||||||||||
| Packages that use MjClassDoc | |
| org.multijava.mjdoc.mjdoc_142 | The mjdoc tool documents java programs that contain MultiJava (MJ) extensions to the Java progamming language; it produces html pages very similar to those produced by the javadoc tool. |
| Uses of MjClassDoc in org.multijava.mjdoc.mjdoc_142 |
| Fields in org.multijava.mjdoc.mjdoc_142 declared as MjClassDoc | |
private MjClassDoc |
MjProgramElementDoc.containingClass
Holder for the class that contains this program element (a nested class is contained by its outer class). |
private MjClassDoc |
MjSeeTag.classDoc
Cached value of the class indicated in the tag. |
private MjClassDoc |
MjThrowsTag.exception
Cached value of the class of the exception. |
private static MjClassDoc |
MjThrowsTag.mjRuntimeException
The MjClassDoc object for java.lang.RuntimeException . |
private static MjClassDoc |
MjThrowsTag.mjRuntimeError
The MjClassDoc object for java.lang.Error . |
| Methods in org.multijava.mjdoc.mjdoc_142 that return MjClassDoc | |
static MjClassDoc |
MjdocWrapper.lookup(CClass cclass)
Returns the MjClassDoc object generated from the given CClass; if the CClass object was not previously registered, an MjClassDoc object is created. |
MjClassDoc |
MjdocWrapper.CClassMap.lookup(CClass cclass)
|
MjClassDoc |
MjdocWrapper.CClassMap.newClassDoc(CClass cclass)
|
MjClassDoc |
MjTag.containingClass()
Returns the class that this tag modifies or is in (note that 'owner' is the program element the tag modifies. |
MjClassDoc |
MjTag.resolveReference(String name)
This is used by tags to resolve references to classes as they are given in tags (such as @see, @link, @throws, @exception tags). |
| Methods in org.multijava.mjdoc.mjdoc_142 with parameters of type MjClassDoc | |
int |
MjClassDoc.compare(MjClassDoc mjd)
Returns 0 if the classes are not comparable, 1 if the argument supercedes the object, -1 if the object supercedes the argument. |
(package private) static boolean |
MjThrowsTag.unchecked(MjClassDoc exception)
Returns true if the argument represents an unchecked Java Throwable class, that is one that need not be declared in the throws-list of a method declaration. |
| Constructors in org.multijava.mjdoc.mjdoc_142 with parameters of type MjClassDoc | |
MjProgramElementDoc(MjClassDoc container)
Creates this super class object for the situation that the derived class represents some program element other than a class or interface; the argument is the class or interface that contains the program element. |
|
MjMemberDoc(MjClassDoc container)
Constructs an object, by simply constructing the super class object. |
|
MjExecutableMemberDoc(CMethod cm,
MjClassDoc container)
Constructs a wrapper object; to be used when no source is available. |
|
MjExecutableMemberDoc(JMethodDeclarationType jmethod,
MjClassDoc container)
Constructs a wrapper object; to be used when source code is available; this makes available the javadoc comments and parameter identifiers. |
|
MjMethodDoc(CMethod cm,
MjClassDoc container)
This constructs an object in cases where only binary code is available. |
|
MjMethodDoc(JMethodDeclarationType jm,
MjClassDoc container)
This constructs an object in cases where source code is available and hence a JMethodDeclarationType object is available. |
|
MjConstructorDoc(CMethod cm,
MjClassDoc container)
Constructs a wrapper object for a CMethod; use when source code (i.e. a JMethodDeclarationType object) is not available. |
|
MjConstructorDoc(JMethodDeclarationType jm,
MjClassDoc container)
Constructs a wrapper object for a method; use when source code is available; using this constructor makes the javadoc information available. |
|
MjFieldDoc(MjClassDoc container,
CField field)
Constructor of an object wrapping a specific field, used when source code is not available. |
|
MjFieldDoc(MjClassDoc container,
JFieldDeclarationType jfield)
Constructor of an object wrapping a specific field, used when source code is available, since information such as the javadoc comments are available from a JMemberDeclarationType object, but not from a CField object. |
|
|
mjc | ||||||||||
| PREV NEXT | FRAMES NO FRAMES | ||||||||||