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 at in a function browser.- Since:
- 1 Sep 2004
- Author:
- Mark Taylor (Starlink)
-
-
Constructor Summary
Constructors Constructor Description HtmlDoclet(com.sun.javadoc.RootDoc root)
Constructor.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static java.io.File
classDocFile(java.io.File baseDir, com.sun.javadoc.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 java.io.File
fieldDocFile(java.io.File baseDir, com.sun.javadoc.FieldDoc field)
Returns the file used to store documentation about a field.static java.io.File
methodDocFile(java.io.File baseDir, com.sun.javadoc.MethodDoc method)
Returns the file used to store documentation about a method.static int
optionLength(java.lang.String option)
Define permitted command-line flags.protected void
outDescription(java.lang.String descrip)
Output a description item.protected void
outExamples(java.lang.String[] examples)
Output examples of the current documentandum (presumably a method).protected void
outItem(java.lang.String name, java.lang.String val)
Output an item to the current documentandum (class/member).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.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
isDocumentable, languageVersion, process, processClass, processPackage, pWrap, typeString, varargTypeString, warning
-
-
-
-
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.
-
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.- Specified by:
startClass
in classMemberDoclet
- 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.- Specified by:
endClass
in classMemberDoclet
- 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.- Specified by:
startMember
in classMemberDoclet
- 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:
java.io.IOException
-
endMember
protected void endMember() throws java.io.IOException
Description copied from class:MemberDoclet
End output of the most recently started member.- Specified by:
endMember
in classMemberDoclet
- Throws:
java.io.IOException
-
outItem
protected void outItem(java.lang.String name, java.lang.String val) throws java.io.IOException
Description copied from class:MemberDoclet
Output an item to the current documentandum (class/member).- Specified by:
outItem
in classMemberDoclet
- Parameters:
name
- item titleval
- item content (HTML text)- 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).- Specified by:
outParameters
in classMemberDoclet
- 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:
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.- Specified by:
outReturn
in classMemberDoclet
- Parameters:
rtype
- type of return valuerdesc
- text of return value description (may be null)- Throws:
java.io.IOException
-
outDescription
protected void outDescription(java.lang.String descrip) throws java.io.IOException
Description copied from class:MemberDoclet
Output a description item.- Specified by:
outDescription
in classMemberDoclet
- Parameters:
descrip
- description string- Throws:
java.io.IOException
-
outExamples
protected void outExamples(java.lang.String[] examples) throws java.io.IOException
Description copied from class:MemberDoclet
Output examples of the current documentandum (presumably a method).- Specified by:
outExamples
in classMemberDoclet
- Parameters:
examples
- array of strings each representing an example- Throws:
java.io.IOException
-
classDocFile
public static java.io.File classDocFile(java.io.File baseDir, com.sun.javadoc.ClassDoc clazz)
Returns the file used to store documentation about a class.- Parameters:
baseDir
- root of output filesetclazz
- class specification- Returns:
- location for storing documentation text
-
fieldDocFile
public static java.io.File fieldDocFile(java.io.File baseDir, com.sun.javadoc.FieldDoc field)
Returns the file used to store documentation about a field.- Parameters:
baseDir
- root of output filesetfield
- field specification- Returns:
- location for storing documentation text
-
methodDocFile
public static java.io.File methodDocFile(java.io.File baseDir, com.sun.javadoc.MethodDoc method)
Returns the file used to store documentation about a method.- Parameters:
baseDir
- root of output filesetmethod
- method specification- Returns:
- location for storing documentation text
-
-