uk.ac.starlink.ttools.build
Class FullXmlDoclet

java.lang.Object
  extended by uk.ac.starlink.ttools.build.MemberDoclet
      extended by uk.ac.starlink.ttools.build.XmlDoclet
          extended by uk.ac.starlink.ttools.build.FullXmlDoclet

public class FullXmlDoclet
extends XmlDoclet

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.

Since:
22 Apr 2005
Author:
Mark Taylor (Starlink)

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

start

public static boolean start(RootDoc root)
                     throws IOException
Begin processing document. This method is part of the Doclet public interface.

Throws:
IOException

optionLength

public static int optionLength(String option)
Define permitted command-line flags. This method is part of the Doclet public interface.


process

protected boolean process()
                   throws IOException
Description copied from class: MemberDoclet
Works through the root document invoking the various protected methods to produce output.

Overrides:
process in class MemberDoclet
Throws:
IOException

startClass

protected void startClass(ClassDoc clazz)
                   throws IOException
Description copied from class: MemberDoclet
Begin output of documentation for a given class. Subsequent calls to outItem refer to this.

Overrides:
startClass in class XmlDoclet
Parameters:
clazz - class to document
Throws:
IOException

endClass

protected void endClass()
                 throws IOException
Description copied from class: MemberDoclet
End output of documentation for the most recently started class.

Overrides:
endClass in class XmlDoclet
Throws:
IOException

startMember

protected void startMember(MemberDoc mem,
                           String memType,
                           String memName)
                    throws IOException
Description copied from class: MemberDoclet
Begin output of documentation for a given clas member (field or method). Subsequent calls to outItem etc refer to this.

Overrides:
startMember in class XmlDoclet
Parameters:
mem - class member
memType - some user-viewable (that is not necessarily using technical terms) description of what kind of member it is
memName - some user-viewable label for the member
Throws:
IOException

endMember

protected void endMember()
                  throws IOException
Description copied from class: MemberDoclet
End output of the most recently started member.

Overrides:
endMember in class XmlDoclet
Throws:
IOException

outDescription

protected void outDescription(String desc)
                       throws IOException
Description copied from class: MemberDoclet
Output a description item.

Overrides:
outDescription in class XmlDoclet
Parameters:
desc - description string
Throws:
IOException

outParameters

protected void outParameters(Parameter[] params,
                             String[] comments)
                      throws IOException
Description copied from class: MemberDoclet
Output parameters to the current documentandum (presumably a method).

Overrides:
outParameters in class XmlDoclet
Parameters:
params - array of Parameter objects
comments - array of comment strings matching params; if there's no comment, the element may be null
Throws:
IOException

outReturn

protected void outReturn(Type rtype,
                         String rdesc)
                  throws IOException
Description copied from class: MemberDoclet
Output return value for the current method.

Overrides:
outReturn in class XmlDoclet
Parameters:
rtype - type of return value
rdesc - text of return value description (may be null)
Throws:
IOException


Copyright © 2015 Central Laboratory of the Research Councils. All Rights Reserved.