The Relax NG grammar for an classdoc XML document generated by
GNU Gjdoc.
The root element for a Gjdoc classdoc XML document.
Corresponds to a Javadoc API com.sun.javadoc.ClassDoc
object, the subtree of the full generated documentation
corresponding to a particular Java class.
Corresponds to the abstract class
com.sun.javadoc.Doc
, the common base class for
all documentation classes.
Corresponds to the abstract class
com.sun.javadoc.ProgramElementDoc
.
Corresponds to the abstract class
com.sun.javadoc.MemberDoc
.
Corresponds to the abstract class
com.sun.javadoc.ExecutableMemberDoc
.
Corresponds to an object of class
com.sun.javadoc.ConstructorDoc
.
Corresponds to an object of class
com.sun.javadoc.MethodDoc
.
Corresponds to an object of class
com.sun.javadoc.FieldDoc
.
Specifies a constructor of the class.
Specifies a method of the class.
Specifies a field of the class.
Presence means ClassDoc.isAbstract()
returns
true
.
Presence means Doc.isClass()
returns
true
.
Presence means Doc.isConstructor()
returns
true
.
Presence means Doc.isError()
returns
true
.
Presence means Doc.isException()
returns
true
.
Presence means ClassDoc.isSerializable()
returns
true
.
Presence means ClassDoc.isExternalizable()
returns true
.
Presence means Doc.isField()
returns
true
.
Presence means Doc.isIncluded()
returns
true
.
Presence means Doc.isInterface()
returns
true
.
Presence means Doc.isMethod()
returns
true
.
Presence means Doc.isOrdinaryClass()
returns
true
.
Presence means ProgramElementDoc.isFinal()
returns true
.
Presence means ProgramElementDoc.isStatic()
returns true
.
Presence means FieldDoc.isTransient()
returns true
.
Presence means FieldDoc.isVolatile()
returns true
.
Presence means ExecutableMemberDoc.isNative()
returns true
.
Presence means
ExecutableMemberDoc.isSynchronized()
returns
true
.
Presence means
ClassDoc.definesSerializableFields()
returns
true
.
Corresponds to the access modifier (public, protected,
private) specified by a ProgramElementDoc.
This value is determined by calling
ProgramElementDoc.isPublic()
,
ProgramElementDoc.isProtected()
,
ProgramElementDoc.isPrivate()
and
ProgramElementDoc.isPackagePrivate()
.
public
protected
private
package
Corresponds to the type returned by a call to
com.sun.javadoc.Classdoc.containingClass()
.
The full name of the outer class containing the class, if
this class is an inner class.
Corresponds to an entry in the array returned by a
com.sun.javadoc.ExecutableMemberDoc.parameters()
.
A parameter for a method or constructor call.
Corresponds to an entry in the array returned by a
com.sun.javadoc.ExecutableMemberDoc.thrownExceptions()
.
An exception thrown by a method or constructor.
Corresponds to the signature specified by a
com.sun.javadoc.MethodDoc
.
The signature of a method or constructor.
The full signature of a method or constructor, as
returned by
com.sun.javadoc.ExecutableMemberDoc.signature()
.
The "flat" signature of a method or constructor, as
returned by
com.sun.javadoc.ExecutableMemberDoc.flatSignature()
.
Corresponds to the type returned by
com.sun.javadoc.MethodDoc.returnType()
.
The type returned by a method.