|
|
FlexDoc/Javadoc 2.0
Demo Java Doc |
Interface DocletEnvironment
public interface DocletEnvironment
Represents the operating environment of a single invocation
of the doclet. This object can be used to access the program
structures, various utilities and the user specified elements
on the command line.
Since:
9
Nested Class Summary |
static enum |
The mode specifying the level of detail of module documentation.
|
Method Summary |
|
Returns an instance of the DocTrees utility class.
|
|
Returns an instance of the Elements utility class.
|
|
Returns the file kind of a type element.
|
|
Returns the module, package and type elements that should be
included in the
documentation. |
|
Returns the file manager used to read and write files.
|
|
Returns the required level of module documentation.
|
|
Returns the source version of the source files that were read.
|
|
Returns the elements specified
when the tool is invoked. |
|
Returns an instance of the Types utility class.
|
boolean |
Returns true if an element should be
included in the
documentation. |
boolean |
Returns true if the element is selected. |
Returns the elements
specified
when the tool is invoked.
Returns:
the set of specified elements
Returns the module, package and type elements that should be
included in the
documentation.
Returns:
the set of included elements
Returns an instance of the
DocTrees utility class.
This class provides methods to access
TreePaths,
DocCommentTrees
and so on.
Returns:
a utility class to operate on doc trees
Returns an instance of the
Elements utility class.
This class provides methods for operating on
elements.
Returns:
a utility class to operate on elements
Returns an instance of the
Types utility class.
This class provides methods for operating on
type mirrors.
Returns:
a utility class to operate on type mirrors
Returns true if an element should be
included in the
documentation.
Parameters:
e - the element
Returns:
true if included, false otherwise
Returns true if the element is
selected.
Parameters:
e - the element
Returns:
true if selected, false otherwise
Returns the file manager used to read and write files.
Returns:
the file manager used to read and write files
Returns the source version of the source files that were read.
Returns:
the source version
Returns the required level of module documentation.
Returns:
the required level of module documentation
Returns the file kind of a type element.
Parameters:
type - the type element
Returns:
the file kind
|
|
FlexDoc/Javadoc 2.0
Demo Java Doc |
FlexDoc/Javadoc is a template-driven programming tool for rapid development of any Javadoc-based Java API documentation generators (i.e. doclets). If you need to customize your Javadoc without writing a full-blown doclet from scratch,
FlexDoc/Javadoc may be the only tool able to help you! Find out more at
www.flexdoc.xyz