| Interface | Description |
|---|---|
| UserExtraGapGetter |
Defines "user-created extra" gaps that may be added to Codelet templates.
|
| Class | Description |
|---|---|
| BasicCustomizers |
Pre-made Codelet customizers.
|
| CodeletGap |
A single gap in a Codelet template, including a function that fills it based on the Codelet instance and global configuration.
|
| CodeletInstance |
Represents a single codelet-taglet, as found by
javadoc.exe. |
| CodeletTemplateBase |
What the fully-processed output (source-code, console output, or plain-file text) is put into--The rendered template is what actually replaces the codelet-taglet.
|
| CustomizationInstructions <T extends CodeletTemplateBase> |
The instructions returned by a Codelet Customizer, which is used by the taglet-processor to modify its output.
|
| NewLineFilterFor |
Convenience functions for creating line filters tailored for codelets.
|
| TagletOfTypeProcessor <T extends CodeletTemplateBase> |
Base class for type-specific Codelet processors.
|
| TagletProcessor |
Generates the output for a single Codelet of any type.
|
| TagletTextUtil |
Extract and transform elements from the taglet text.
|
| Enum | Description |
|---|---|
| CodeletBaseConfig |
Immutable, static, and non-template related configuration, used throughout Codelet, as held in a file named
codelet.properties. |
| CodeletBootstrap |
Initializes Codelet by loading all configuration--This is triggered by the first codelet-taglet encountered by
javadoc.exe. |
| CodeletTemplateConfig |
Loads and manages default templates and user-extra gaps.
|
| CodeletType |
The type of a single JavaDoc codelet instance.
|
| TemplateOverrides |
For optional overriding of default templates, for a single JavaDoc page or an entire package.
|
| Exception | Description |
|---|---|
| CodeletFormatException |
Indicates the text in a codelet is invalid.
|
| TemplateOverridesConfigLineException |
Indicates a line in the template-override configuration file is invalid.
|
Main package.
Copyright 2014, Jeff Epstein, All Rights Reserved. See top of source code files for copyright notice.
https://github.com/aliteralmind/codelet