Package uk.ac.starlink.ttools.build
Class FullXmlDoclet
java.lang.Object
uk.ac.starlink.ttools.build.MemberDoclet
uk.ac.starlink.ttools.build.XmlDoclet
uk.ac.starlink.ttools.build.FullXmlDoclet
Doclet which documents public static members of classes in XML
for insertion into SUN-style XML user documents.
Optional doclet flags beyond the standard ones are:
- -headonly
- Write only the first sentence of the class headers, and not information about the methods.
- Since:
- 22 Apr 2005
- Author:
- Mark Taylor (Starlink)
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected void
endClass()
End output of documentation for the most recently started class.protected void
End output of the most recently started member.protected String
getXmlId
(ClassDoc clazz) Returns the value to use for the XML ID attached to the subsection describing a given class.static int
optionLength
(String option) Define permitted command-line flags.void
Outputs a single line of output to the current output stream.protected void
outDescription
(String desc) Output a description item.protected void
outExamples
(String[] examples) Output examples of the current documentandum (presumably a method).protected void
outParameters
(Parameter[] params, String[] comments, boolean isVararg) Output parameters to the current documentandum (presumably a method).protected void
Output return value for the current method.protected void
outSees
(SeeTag[] seeTags) Output any See tags from the current documentandum.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 class member (field or method).protected boolean
useClass
(ClassDoc clazz) Indicates whether a given class should be documented by this doclet or ignored.Methods inherited from class uk.ac.starlink.ttools.build.XmlDoclet
doctorText, flush, out, outItem
Methods inherited from class uk.ac.starlink.ttools.build.MemberDoclet
firstSentence, isDocumentable, languageVersion, processClass, processPackage, pWrap, typeString, varargTypeString, warning
-
Constructor Details
-
FullXmlDoclet
Constructor.- Parameters:
root
- root document- Throws:
IOException
-
-
Method Details
-
start
Begin processing document. This method is part of the Doclet public interface.- Throws:
IOException
-
optionLength
Define permitted command-line flags. This method is part of the Doclet public interface. -
getXmlId
Returns the value to use for the XML ID attached to the subsection describing a given class.- Parameters:
clazz
- class doc- Returns:
- XML ID string
-
useClass
protected boolean useClass(ClassDoc clazz) Indicates whether a given class should be documented by this doclet or ignored. The default implementation returns true always, but it may be overridden by subclasses.- Parameters:
clazz
- class doc- Returns:
- true to use class, false to ignore it
-
process
Description copied from class:MemberDoclet
Works through the root document invoking the various protected methods to produce output.- Overrides:
process
in classMemberDoclet
- Throws:
IOException
-
startClass
Description copied from class:MemberDoclet
Begin output of documentation for a given class. Subsequent calls to outItem refer to this.- Overrides:
startClass
in classXmlDoclet
- Parameters:
clazz
- class to document- Throws:
IOException
-
endClass
Description copied from class:MemberDoclet
End output of documentation for the most recently started class.- Overrides:
endClass
in classXmlDoclet
- Throws:
IOException
-
startMember
Description copied from class:MemberDoclet
Begin output of documentation for a given class member (field or method). Subsequent calls to outItem etc refer to this.- Overrides:
startMember
in classXmlDoclet
- Parameters:
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- Throws:
IOException
-
endMember
Description copied from class:MemberDoclet
End output of the most recently started member.- Overrides:
endMember
in classXmlDoclet
- Throws:
IOException
-
outDescription
Description copied from class:MemberDoclet
Output a description item.- Overrides:
outDescription
in classXmlDoclet
- Parameters:
desc
- description string- Throws:
IOException
-
outParameters
protected void outParameters(Parameter[] params, String[] comments, boolean isVararg) throws IOException Description copied from class:MemberDoclet
Output parameters to the current documentandum (presumably a method).- Overrides:
outParameters
in classXmlDoclet
- Parameters:
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 length- Throws:
IOException
-
outReturn
Description copied from class:MemberDoclet
Output return value for the current method.- Overrides:
outReturn
in classXmlDoclet
- Parameters:
rtype
- type of return valuerdesc
- text of return value description (may be null)- Throws:
IOException
-
outExamples
Description copied from class:MemberDoclet
Output examples of the current documentandum (presumably a method).- Overrides:
outExamples
in classXmlDoclet
- Parameters:
examples
- array of strings each representing an example- Throws:
IOException
-
outSees
Description copied from class:MemberDoclet
Output any See tags from the current documentandum. This only includes explicit @see tags, not @links.- Overrides:
outSees
in classXmlDoclet
- Throws:
IOException
- See Also:
-
contents
-
out
Outputs a single line of output to the current output stream.- Overrides:
out
in classXmlDoclet
- Parameters:
line
- text for output- Throws:
IOException
-