FullXmlDoclet (Starjava TTOOLS API)

java.lang.Object
- uk.ac.starlink.ttools.build.MemberDoclet
- - uk.ac.starlink.ttools.build.XmlDoclet
  - - 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

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`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(java.lang.String option)`	Define permitted command-line flags.
`protected void`	`outDescription(java.lang.String desc)`	Output a description item.
`protected void`	`outParameters(com.sun.javadoc.Parameter[] params, 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 boolean`	`process()`	Works through the root document invoking the various protected methods to produce output.
`static boolean`	`start(com.sun.javadoc.RootDoc root)`	Begin processing document.
`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).

Methods inherited from class uk.ac.starlink.ttools.build.MemberDoclet
languageVersion, processClass, processPackage, pWrap, typeString, varargTypeString, warning

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from class uk.ac.starlink.ttools.build.XmlDoclet
doctorText, flush, out, out, outExamples, outItem

- Method Detail
  - start
```
public static boolean start(com.sun.javadoc.RootDoc root)
                     throws java.io.IOException
```
    Begin processing document. This method is part of the Doclet public interface.
    
    Throws:
    
    java.io.IOException
  - optionLength
```
public static int optionLength(java.lang.String option)
```
    Define permitted command-line flags. This method is part of the Doclet public interface.
  - process
```
protected boolean process()
                   throws java.io.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:
    
    java.io.IOException
  - startClass
```
protected void startClass(com.sun.javadoc.ClassDoc clazz)
                   throws java.io.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:
    
    java.io.IOException
  - endClass
```
protected void endClass()
                 throws java.io.IOException
```
    Description copied from class: MemberDoclet
    
    End output of documentation for the most recently started class.
    
    Overrides:
    
    endClass in class XmlDoclet
    
    Throws:
    
    java.io.IOException
  - startMember
```
protected void startMember(com.sun.javadoc.MemberDoc mem,
                           java.lang.String memType,
                           java.lang.String memName)
                    throws java.io.IOException
```
    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 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:
    
    java.io.IOException
  - endMember
```
protected void endMember()
                  throws java.io.IOException
```
    Description copied from class: MemberDoclet
    
    End output of the most recently started member.
    
    Overrides:
    
    endMember in class XmlDoclet
    
    Throws:
    
    java.io.IOException
  - outDescription
```
protected void outDescription(java.lang.String desc)
                       throws java.io.IOException
```
    Description copied from class: MemberDoclet
    
    Output a description item.
    
    Overrides:
    
    outDescription in class XmlDoclet
    
    Parameters:
    
    desc - description string
    
    Throws:
    
    java.io.IOException
  - outParameters
```
protected void outParameters(com.sun.javadoc.Parameter[] params,
                             java.lang.String[] comments,
                             boolean isVararg)
                      throws java.io.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
    
    isVararg - true if the method is known to have its final formal argument declared with variable length
    
    Throws:
    
    java.io.IOException
  - outReturn
```
protected void outReturn(com.sun.javadoc.Type rtype,
                         java.lang.String rdesc)
                  throws java.io.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:
    
    java.io.IOException

Class FullXmlDoclet

Method Summary

Methods inherited from class uk.ac.starlink.ttools.build.MemberDoclet

Methods inherited from class java.lang.Object

Methods inherited from class uk.ac.starlink.ttools.build.XmlDoclet

Method Detail

start

optionLength

process

startClass

endClass

startMember

endMember

outDescription

outParameters

outReturn