public class HtmlDoclet extends MemberDoclet
Constructor | Description |
---|---|
HtmlDoclet(com.sun.javadoc.RootDoc root) |
Constructor.
|
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).
|
isDocumentable, languageVersion, process, processClass, processPackage, pWrap, typeString, varargTypeString, warning
public HtmlDoclet(com.sun.javadoc.RootDoc root) throws java.io.IOException
java.io.IOException
public static boolean start(com.sun.javadoc.RootDoc root) throws java.io.IOException
java.io.IOException
public static int optionLength(java.lang.String option)
protected void startClass(com.sun.javadoc.ClassDoc clazz) throws java.io.IOException
MemberDoclet
startClass
in class MemberDoclet
clazz
- class to documentjava.io.IOException
protected void endClass() throws java.io.IOException
MemberDoclet
endClass
in class MemberDoclet
java.io.IOException
protected void startMember(com.sun.javadoc.MemberDoc mem, java.lang.String memType, java.lang.String memName) throws java.io.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 memberjava.io.IOException
protected void endMember() throws java.io.IOException
MemberDoclet
endMember
in class MemberDoclet
java.io.IOException
protected void outItem(java.lang.String name, java.lang.String val) throws java.io.IOException
MemberDoclet
outItem
in class MemberDoclet
name
- item titleval
- item content (HTML text)java.io.IOException
protected void outParameters(com.sun.javadoc.Parameter[] params, java.lang.String[] comments, boolean isVararg) throws java.io.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 nullisVararg
- true if the method is known to have its final
formal argument declared with variable lengthjava.io.IOException
protected void outReturn(com.sun.javadoc.Type rtype, java.lang.String rdesc) throws java.io.IOException
MemberDoclet
outReturn
in class MemberDoclet
rtype
- type of return valuerdesc
- text of return value description (may be null)java.io.IOException
protected void outDescription(java.lang.String descrip) throws java.io.IOException
MemberDoclet
outDescription
in class MemberDoclet
descrip
- description stringjava.io.IOException
protected void outExamples(java.lang.String[] examples) throws java.io.IOException
MemberDoclet
outExamples
in class MemberDoclet
examples
- array of strings each representing an examplejava.io.IOException
public static java.io.File classDocFile(java.io.File baseDir, com.sun.javadoc.ClassDoc clazz)
baseDir
- root of output filesetclazz
- class specificationpublic static java.io.File fieldDocFile(java.io.File baseDir, com.sun.javadoc.FieldDoc field)
baseDir
- root of output filesetfield
- field specificationpublic static java.io.File methodDocFile(java.io.File baseDir, com.sun.javadoc.MethodDoc method)
baseDir
- root of output filesetmethod
- method specificationCopyright © 2018 Central Laboratory of the Research Councils. All Rights Reserved.