|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectuk.ac.starlink.ttools.build.MemberDoclet
uk.ac.starlink.ttools.build.HtmlDoclet
public class HtmlDoclet
Generates HTML pages for display at in a function browser.
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 |
---|
public HtmlDoclet(RootDoc root) throws IOException
IOException
Method Detail |
---|
public static boolean start(RootDoc root) throws IOException
IOException
public static int optionLength(String option)
protected void startClass(ClassDoc clazz) throws IOException
MemberDoclet
startClass
in class MemberDoclet
clazz
- class to document
IOException
protected void endClass() throws IOException
MemberDoclet
endClass
in class MemberDoclet
IOException
protected void startMember(MemberDoc mem, String memType, String memName) throws IOException
MemberDoclet
startMember
in class MemberDoclet
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
IOException
protected void endMember() throws IOException
MemberDoclet
endMember
in class MemberDoclet
IOException
protected void outItem(String name, String val) throws IOException
MemberDoclet
outItem
in class MemberDoclet
name
- item titleval
- item content (HTML text)
IOException
protected void outParameters(Parameter[] params, String[] comments) throws IOException
MemberDoclet
outParameters
in class MemberDoclet
params
- array of Parameter objectscomments
- array of comment strings matching params;
if there's no comment, the element may be null
IOException
protected void outReturn(Type rtype, String rdesc) throws IOException
MemberDoclet
outReturn
in class MemberDoclet
rtype
- type of return valuerdesc
- text of return value description (may be null)
IOException
protected void outDescription(String descrip) throws IOException
MemberDoclet
outDescription
in class MemberDoclet
descrip
- description string
IOException
protected void outExamples(String[] examples) throws IOException
MemberDoclet
outExamples
in class MemberDoclet
examples
- array of strings each representing an example
IOException
public static File classDocFile(File baseDir, ClassDoc clazz)
baseDir
- root of output filesetclazz
- class specification
public static File fieldDocFile(File baseDir, FieldDoc field)
baseDir
- root of output filesetfield
- field specification
public static File methodDocFile(File baseDir, MethodDoc method)
baseDir
- root of output filesetmethod
- method specification
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |