public class FullXmlDoclet extends XmlDoclet
Modifier and Type | Method | Description |
---|---|---|
protected void |
endClass() |
End output of documentation for the most recently started class.
|
protected void |
endMember() |
End output of the most recently started member.
|
static int |
optionLength(java.lang.String option) |
Define permitted command-line flags.
|
protected void |
outDescription(java.lang.String desc) |
Output a description item.
|
protected void |
outParameters(com.sun.javadoc.Parameter[] params,
java.lang.String[] comments,
boolean isVararg) |
Output parameters to the current documentandum (presumably a method).
|
protected void |
outReturn(com.sun.javadoc.Type rtype,
java.lang.String rdesc) |
Output return value for the current method.
|
protected boolean |
process() |
Works through the root document invoking the various protected methods
to produce output.
|
static boolean |
start(com.sun.javadoc.RootDoc root) |
Begin processing document.
|
protected void |
startClass(com.sun.javadoc.ClassDoc clazz) |
Begin output of documentation for a given class.
|
protected void |
startMember(com.sun.javadoc.MemberDoc mem,
java.lang.String memType,
java.lang.String memName) |
Begin output of documentation for a given class member (field or method).
|
languageVersion, processClass, processPackage, pWrap, typeString, varargTypeString, warning
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
doctorText, flush, out, out, outExamples, outItem
public static boolean start(com.sun.javadoc.RootDoc root) throws java.io.IOException
java.io.IOException
public static int optionLength(java.lang.String option)
protected boolean process() throws java.io.IOException
MemberDoclet
process
in class MemberDoclet
java.io.IOException
protected void startClass(com.sun.javadoc.ClassDoc clazz) throws java.io.IOException
MemberDoclet
startClass
in class XmlDoclet
clazz
- class to documentjava.io.IOException
protected void endClass() throws java.io.IOException
MemberDoclet
protected void startMember(com.sun.javadoc.MemberDoc mem, java.lang.String memType, java.lang.String memName) throws java.io.IOException
MemberDoclet
startMember
in class XmlDoclet
mem
- class membermemType
- some user-viewable (that is not necessarily using
technical terms) description of what kind of member it ismemName
- some user-viewable label for the memberjava.io.IOException
protected void endMember() throws java.io.IOException
MemberDoclet
protected void outDescription(java.lang.String desc) throws java.io.IOException
MemberDoclet
outDescription
in class XmlDoclet
desc
- description stringjava.io.IOException
protected void outParameters(com.sun.javadoc.Parameter[] params, java.lang.String[] comments, boolean isVararg) throws java.io.IOException
MemberDoclet
outParameters
in class XmlDoclet
params
- array of Parameter objectscomments
- array of comment strings matching params;
if there's no comment, the element may be nullisVararg
- true if the method is known to have its final
formal argument declared with variable lengthjava.io.IOException
protected void outReturn(com.sun.javadoc.Type rtype, java.lang.String rdesc) throws java.io.IOException
MemberDoclet
Copyright © 2018 Central Laboratory of the Research Councils. All Rights Reserved.