|
|||||||||
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
uk.ac.starlink.ttools.build.FullXmlDoclet
public class FullXmlDoclet
Doclet which documents public static members of classes in XML for insertion into the TTOOLS user document. Unlike the TOPCAT version, this gives farily complete information, since it is not supplemented by an online help window.
Method Summary | |
---|---|
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(String option)
Define permitted command-line flags. |
protected void |
outDescription(String desc)
Output a description item. |
protected void |
outParameters(Parameter[] params,
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 boolean |
process()
Works through the root document invoking the various protected methods to produce output. |
static boolean |
start(RootDoc root)
Begin processing document. |
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.XmlDoclet |
---|
doctorText, flush, out, out, outExamples, outItem |
Methods inherited from class uk.ac.starlink.ttools.build.MemberDoclet |
---|
processClass, processPackage, pWrap, typeString, warning |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public static boolean start(RootDoc root) throws IOException
IOException
public static int optionLength(String option)
protected boolean process() throws IOException
MemberDoclet
process
in class MemberDoclet
IOException
protected void startClass(ClassDoc clazz) throws IOException
MemberDoclet
startClass
in class XmlDoclet
clazz
- class to document
IOException
protected void endClass() throws IOException
MemberDoclet
endClass
in class XmlDoclet
IOException
protected void startMember(MemberDoc mem, String memType, String memName) throws 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 member
IOException
protected void endMember() throws IOException
MemberDoclet
endMember
in class XmlDoclet
IOException
protected void outDescription(String desc) throws IOException
MemberDoclet
outDescription
in class XmlDoclet
desc
- description string
IOException
protected void outParameters(Parameter[] params, String[] comments) throws 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 null
IOException
protected void outReturn(Type rtype, String rdesc) throws IOException
MemberDoclet
outReturn
in class XmlDoclet
rtype
- type of return valuerdesc
- text of return value description (may be null)
IOException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |