Package uk.ac.starlink.ttools.build

Class HtmlDoclet

java.lang.Object
uk.ac.starlink.ttools.build.MemberDoclet
uk.ac.starlink.ttools.build.HtmlDoclet
public class HtmlDoclet extends MemberDoclet
Generates HTML pages for display in a function browser.
Since:
1 Sep 2004
Author:
Mark Taylor (Starlink)

  • Constructor Details

  • Method Details

    • 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 class 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, boolean isVararg) 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
      isVararg - true if the method is known to have its final formal argument declared with variable length
      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

    • outSees

      protected void outSees(SeeTag[] seeTags) throws IOException
      Description copied from class: MemberDoclet
      Output any See tags from the current documentandum. This only includes explicit @see tags, not @links.
      Specified by:
      outSees in class MemberDoclet
      Throws:
      IOException
      See Also:
      • contents

    • 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