public abstract class XmlDoclet extends MemberDoclet
Optional doclet flags beyond the standard ones are:
Modifier | Constructor and Description |
---|---|
protected |
XmlDoclet(com.sun.javadoc.RootDoc root) |
Modifier and Type | Method and Description |
---|---|
static java.lang.String |
doctorText(java.lang.String text)
Attempts to turn HTML text into XML.
|
protected void |
endClass()
End output of documentation for the most recently started class.
|
protected void |
endMember()
End output of the most recently started member.
|
void |
flush() |
static int |
optionLength(java.lang.String option)
Define permitted command-line flags.
|
void |
out(java.lang.String line)
Outputs a single line of output to the current output stream.
|
void |
out(java.lang.String[] lines)
Outputs some lines of text to the current output stream.
|
protected void |
outDescription(java.lang.String descrip)
Output a description item.
|
protected void |
outExamples(java.lang.String[] examples)
Output examples of the current documentandum (presumably a method).
|
protected void |
outItem(java.lang.String name,
java.lang.String val)
Output an item to the current documentandum (class/member).
|
protected void |
outParameters(com.sun.javadoc.Parameter[] param,
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 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, process, processClass, processPackage, pWrap, typeString, varargTypeString, warning
protected XmlDoclet(com.sun.javadoc.RootDoc root) throws java.io.IOException
java.io.IOException
public static int optionLength(java.lang.String option)
protected void startClass(com.sun.javadoc.ClassDoc clazz) throws java.io.IOException
MemberDoclet
startClass
in class MemberDoclet
clazz
- class to documentjava.io.IOException
protected void endClass() throws java.io.IOException
MemberDoclet
endClass
in class MemberDoclet
java.io.IOException
protected void startMember(com.sun.javadoc.MemberDoc mem, java.lang.String memType, java.lang.String memName) throws java.io.IOException
MemberDoclet
startMember
in class MemberDoclet
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
endMember
in class MemberDoclet
java.io.IOException
protected void outDescription(java.lang.String descrip) throws java.io.IOException
MemberDoclet
outDescription
in class MemberDoclet
descrip
- description stringjava.io.IOException
protected void outItem(java.lang.String name, java.lang.String val)
MemberDoclet
outItem
in class MemberDoclet
name
- item titleval
- item content (HTML text)protected void outParameters(com.sun.javadoc.Parameter[] param, java.lang.String[] comments, boolean isVararg) throws java.io.IOException
MemberDoclet
outParameters
in class MemberDoclet
param
- 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
outReturn
in class MemberDoclet
rtype
- type of return valuerdesc
- text of return value description (may be null)java.io.IOException
protected void outExamples(java.lang.String[] examples)
MemberDoclet
outExamples
in class MemberDoclet
examples
- array of strings each representing an examplepublic void out(java.lang.String[] lines) throws java.io.IOException
out(java.lang.String)
.lines
- text for outputjava.io.IOException
public void out(java.lang.String line) throws java.io.IOException
line
- text for outputjava.io.IOException
public void flush() throws java.io.IOException
java.io.IOException
public static java.lang.String doctorText(java.lang.String text)
text
- HTML-type textCopyright © 2017 Central Laboratory of the Research Councils. All Rights Reserved.