HtmlDoclet
, XmlDoclet
public abstract class MemberDoclet
extends java.lang.Object
Modifier | Constructor | Description |
---|---|---|
protected |
MemberDoclet(com.sun.javadoc.RootDoc root) |
Constructor.
|
Modifier and Type | Method | Description |
---|---|---|
protected abstract void |
endClass() |
End output of documentation for the most recently started class.
|
protected abstract void |
endMember() |
End output of the most recently started member.
|
boolean |
isDocumentable(com.sun.javadoc.ProgramElementDoc pel) |
Indicates whether a given item is to be documented or ignored.
|
static com.sun.javadoc.LanguageVersion |
languageVersion() |
This magic static method appears to be required to make the
isVarArgs() method on
com.sun.javadoc.ExecutableMemberDoc report variable
argument status. |
protected abstract void |
outDescription(java.lang.String descrip) |
Output a description item.
|
protected abstract void |
outExamples(java.lang.String[] examples) |
Output examples of the current documentandum (presumably a method).
|
protected abstract void |
outItem(java.lang.String name,
java.lang.String val) |
Output an item to the current documentandum (class/member).
|
protected abstract void |
outParameters(com.sun.javadoc.Parameter[] params,
java.lang.String[] comments,
boolean isVararg) |
Output parameters to the current documentandum (presumably a method).
|
protected abstract void |
outReturn(com.sun.javadoc.Type rtype,
java.lang.String rdesc) |
Output return value for the current method.
|
protected boolean |
process() |
Works through the root document invoking the various protected methods
to produce output.
|
protected void |
processClass(com.sun.javadoc.ClassDoc clazz) |
Generates documentation for a given class.
|
protected void |
processPackage(com.sun.javadoc.PackageDoc pack) |
Generates documentation for a given package.
|
static java.lang.String |
pWrap(java.lang.String text) |
Ensures that a string is a sequence of <p> elements
(though it's not foolproof).
|
protected abstract void |
startClass(com.sun.javadoc.ClassDoc clazz) |
Begin output of documentation for a given class.
|
protected abstract 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).
|
static java.lang.String |
typeString(com.sun.javadoc.Type type) |
Returns a string suitable for user consumption which describes a
non-varargs Type.
|
static java.lang.String |
varargTypeString(com.sun.javadoc.Type type,
boolean isVararg) |
Returns a string suitable for user consumption which describes a
type that may or may not represent a variable-argument parameter.
|
static void |
warning(java.lang.String msg) |
Log a warning.
|
protected abstract void startClass(com.sun.javadoc.ClassDoc clazz) throws java.io.IOException
clazz
- class to documentjava.io.IOException
protected abstract void endClass() throws java.io.IOException
java.io.IOException
protected abstract void startMember(com.sun.javadoc.MemberDoc mem, java.lang.String memType, java.lang.String memName) throws java.io.IOException
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 abstract void endMember() throws java.io.IOException
java.io.IOException
protected abstract void outItem(java.lang.String name, java.lang.String val) throws java.io.IOException
name
- item titleval
- item content (HTML text)java.io.IOException
protected abstract void outParameters(com.sun.javadoc.Parameter[] params, java.lang.String[] comments, boolean isVararg) throws java.io.IOException
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 abstract void outReturn(com.sun.javadoc.Type rtype, java.lang.String rdesc) throws java.io.IOException
rtype
- type of return valuerdesc
- text of return value description (may be null)java.io.IOException
protected abstract void outExamples(java.lang.String[] examples) throws java.io.IOException
examples
- array of strings each representing an examplejava.io.IOException
protected abstract void outDescription(java.lang.String descrip) throws java.io.IOException
descrip
- description stringjava.io.IOException
protected boolean process() throws java.io.IOException
java.io.IOException
protected void processPackage(com.sun.javadoc.PackageDoc pack) throws java.io.IOException
pack
- packagejava.io.IOException
protected void processClass(com.sun.javadoc.ClassDoc clazz) throws java.io.IOException
clazz
- classjava.io.IOException
public boolean isDocumentable(com.sun.javadoc.ProgramElementDoc pel)
@HideDoc
annotation are considered documentable.
Fields must additionally be declared final.pel
- program elementpublic static com.sun.javadoc.LanguageVersion languageVersion()
isVarArgs()
method on
com.sun.javadoc.ExecutableMemberDoc
report variable
argument status. I don't know whether or where that's documented,
but I found out from
StackOverflow.public static java.lang.String typeString(com.sun.javadoc.Type type)
type
- typepublic static java.lang.String varargTypeString(com.sun.javadoc.Type type, boolean isVararg)
type
- typeisVararg
- true if type is known to describe a variable-argument
parameterpublic static java.lang.String pWrap(java.lang.String text)
text
- basic textpublic static void warning(java.lang.String msg)
msg
- messageCopyright © 2018 Central Laboratory of the Research Councils. All Rights Reserved.