uk.ac.starlink.ttools.build
Class HtmlDoclet

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

public class HtmlDoclet
extends MemberDoclet

Generates HTML pages for display at in a function browser.

Since:
1 Sep 2004
Author:
Mark Taylor (Starlink)

Constructor Summary
HtmlDoclet(RootDoc root)
          Constructor.
 
Method Summary
static File classDocFile(File baseDir, ClassDoc clazz)
          Returns the file used to store documentation about a class.
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 File fieldDocFile(File baseDir, FieldDoc field)
          Returns the file used to store documentation about a field.
static File methodDocFile(File baseDir, MethodDoc method)
          Returns the file used to store documentation about a method.
static int optionLength(String option)
          Define permitted command-line flags.
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[] 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.
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.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

HtmlDoclet

public HtmlDoclet(RootDoc root)
           throws IOException
Constructor.

Throws:
IOException
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.


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.

Specified by:
startClass in class MemberDoclet
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.

Specified by:
endClass in class MemberDoclet
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.

Specified by:
startMember in class MemberDoclet
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.

Specified by:
endMember in class MemberDoclet
Throws:
IOException

outItem

protected void outItem(String name,
                       String val)
                throws IOException
Description copied from class: MemberDoclet
Output an item to the current documentandum (class/member).

Specified by:
outItem in class MemberDoclet
Parameters:
name - item title
val - item content (HTML text)
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).

Specified by:
outParameters in class MemberDoclet
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.

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

outDescription

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

Specified by:
outDescription in class MemberDoclet
Parameters:
descrip - description string
Throws:
IOException

outExamples

protected void outExamples(String[] examples)
                    throws IOException
Description copied from class: MemberDoclet
Output examples of the current documentandum (presumably a method).

Specified by:
outExamples in class MemberDoclet
Parameters:
examples - array of strings each representing an example
Throws:
IOException

classDocFile

public static File classDocFile(File baseDir,
                                ClassDoc clazz)
Returns the file used to store documentation about a class.

Parameters:
baseDir - root of output fileset
clazz - class specification
Returns:
location for storing documentation text

fieldDocFile

public static File fieldDocFile(File baseDir,
                                FieldDoc field)
Returns the file used to store documentation about a field.

Parameters:
baseDir - root of output fileset
field - field specification
Returns:
location for storing documentation text

methodDocFile

public static File methodDocFile(File baseDir,
                                 MethodDoc method)
Returns the file used to store documentation about a method.

Parameters:
baseDir - root of output fileset
method - method specification
Returns:
location for storing documentation text


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