|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectuk.ac.starlink.ttools.build.MemberDoclet
uk.ac.starlink.ttools.build.XmlDoclet
public abstract class XmlDoclet
Doclet which documents public static members of classes in SUN-type XML. This abstract superclass provides basic XML-type doclet functionality.
Optional doclet flags beyond the standard ones are:
Constructor Summary | |
---|---|
protected |
XmlDoclet(RootDoc root)
|
Method Summary | |
---|---|
static String |
doctorText(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(String option)
Define permitted command-line flags. |
void |
out(String line)
Outputs a single line of output to the current output stream. |
void |
out(String[] lines)
Outputs some lines of text to the current output stream. |
protected void |
outDescription(String descrip)
Output a description item. |
protected void |
outExamples(String[] examples)
Output examples of the current documentandum (presumably a method). |
protected void |
outItem(String name,
String val)
Output an item to the current documentandum (class/member). |
protected void |
outParameters(Parameter[] param,
String[] comments)
Output parameters to the current documentandum (presumably a method). |
protected void |
outReturn(Type rtype,
String rdesc)
Output return value for the current method. |
protected void |
startClass(ClassDoc clazz)
Begin output of documentation for a given class. |
protected void |
startMember(MemberDoc mem,
String memType,
String memName)
Begin output of documentation for a given clas member (field or method). |
Methods inherited from class uk.ac.starlink.ttools.build.MemberDoclet |
---|
process, processClass, processPackage, pWrap, typeString, warning |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
protected XmlDoclet(RootDoc root) throws IOException
IOException
Method Detail |
---|
public static int optionLength(String option)
protected void startClass(ClassDoc clazz) throws IOException
MemberDoclet
startClass
in class MemberDoclet
clazz
- class to document
IOException
protected void endClass() throws IOException
MemberDoclet
endClass
in class MemberDoclet
IOException
protected void startMember(MemberDoc mem, String memType, String memName) throws 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 member
IOException
protected void endMember() throws IOException
MemberDoclet
endMember
in class MemberDoclet
IOException
protected void outDescription(String descrip) throws IOException
MemberDoclet
outDescription
in class MemberDoclet
descrip
- description string
IOException
protected void outItem(String name, String val)
MemberDoclet
outItem
in class MemberDoclet
name
- item titleval
- item content (HTML text)protected void outParameters(Parameter[] param, String[] comments) throws 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 null
IOException
protected void outReturn(Type rtype, String rdesc) throws IOException
MemberDoclet
outReturn
in class MemberDoclet
rtype
- type of return valuerdesc
- text of return value description (may be null)
IOException
protected void outExamples(String[] examples)
MemberDoclet
outExamples
in class MemberDoclet
examples
- array of strings each representing an examplepublic void out(String[] lines) throws IOException
out(java.lang.String)
.
lines
- text for output
IOException
public void out(String line) throws IOException
line
- text for output
IOException
public void flush() throws IOException
IOException
public static String doctorText(String text)
text
- HTML-type text
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |