A B C D E F G H I J L M O P R S

A

AbstractReportMojo - Class in de.smartics.maven.apidoc

The Mojo reports on issues reported by the Javadoc tool.

AbstractReportMojo() - Constructor for class de.smartics.maven.apidoc. AbstractReportMojo

ADDITIONAL_PARAMS - Static variable in class de.smartics.maven.apidoc. Constants

The key to store additional parameters in the javadoc param map found in the configuration of the maven-javadoc-plugin.

addJavadocPluginArguments(MavenProject, String, Map<String, String>) - Method in class de.smartics.maven.apidoc. JavadocPluginConfigurationExtractor

Adds additional parameters found in the configuration of the maven-javadoc-plugin to the given javadocArguments.

ApiDocReportMojo - Class in de.smartics.maven.apidoc

API doc report.

ApiDocReportMojo() - Constructor for class de.smartics.maven.apidoc. ApiDocReportMojo

B

build() - Method in class de.smartics.maven.apidoc. JavadocMessageConfig.Builder

The builder to create the configuration.

C

canGenerateReport() - Method in class de.smartics.maven.apidoc. AbstractReportMojo

Checks if all required information is provided to run the report successfully.

Constants - Class in de.smartics.maven.apidoc

Constants of this package.

D

de.smartics.maven.apidoc - package de.smartics.maven.apidoc

The core package for generating API documentation reports with Maven.

E

execute() - Method in class de.smartics.maven.apidoc. AbstractReportMojo

Runs the report generation.

executeReport(Locale) - Method in class de.smartics.maven.apidoc. AbstractReportMojo

Configures the plugin logger.

executeReport(Locale) - Method in class de.smartics.maven.apidoc. ApiDocReportMojo

Configures the plugin logger.

F

factory - Variable in class de.smartics.maven.apidoc. AbstractReportMojo

The factory to create dependent artifacts.

filter(List<IssueMessage>) - Method in class de.smartics.maven.apidoc. JavadocMessageConfig

Creates a copy of the passed in messages that contains only those messages that are note filtered.

G

getBundle(Locale) - Method in class de.smartics.maven.apidoc. AbstractReportMojo

Returns the resource bundle for the given locale.

getBundle() - Method in class de.smartics.maven.apidoc. JavadocMessageConfig

Returns the resource bundle to fetch messages to be rendered into the report.

getClassName() - Method in class de.smartics.maven.apidoc. IssueMessageWrapper

Returns the name of the class the issue is located in.

getDescription(Locale) - Method in class de.smartics.maven.apidoc. ApiDocReportMojo

getErrMessages() - Method in class de.smartics.maven.apidoc. MessageHelper

Returns the filtered error messages.

getFooterText() - Method in class de.smartics.maven.apidoc. JavadocMessageConfig

Returns the text to be rendered in the footer.

getLocale() - Method in class de.smartics.maven.apidoc. JavadocMessageConfig

Returns the locale to use for the report.

getMessage() - Method in class de.smartics.maven.apidoc. IssueMessageWrapper

Returns the message being wrapped.

getName(Locale) - Method in class de.smartics.maven.apidoc. ApiDocReportMojo

getNoticeMessages() - Method in class de.smartics.maven.apidoc. MessageHelper

Returns the filtered notice messages.

getOutputDirectory() - Method in class de.smartics.maven.apidoc. AbstractReportMojo

getOutputName() - Method in class de.smartics.maven.apidoc. ApiDocReportMojo

getProject() - Method in class de.smartics.maven.apidoc. AbstractReportMojo

getSiteRenderer() - Method in class de.smartics.maven.apidoc. AbstractReportMojo

getSourceRoots() - Method in class de.smartics.maven.apidoc. JavadocMessageConfig

Returns the root directories in which the source files reside.

getTitle() - Method in class de.smartics.maven.apidoc. JavadocMessageReportRenderer

getWarnMessages() - Method in class de.smartics.maven.apidoc. MessageHelper

Returns the filtered warn messages.

getXref() - Method in class de.smartics.maven.apidoc. IssueMessageWrapper

Returns the reference to the class in the XRef report.

getXrefLocation() - Method in class de.smartics.maven.apidoc. JavadocMessageConfig

Returns the location where the XRef report is written to.

H

hasMessages() - Method in class de.smartics.maven.apidoc. MessageHelper

Checks if there are messages logged.

I

ID_PREFIX_OF_RELEVANT_ELEMENT - Static variable in class de.smartics.maven.apidoc. JavadocPluginConfigurationExtractor

The prefix of the id attribute of an additionalParam element to be relevant for the extractor.

isNoticeMessagesRendered() - Method in class de.smartics.maven.apidoc. JavadocMessageConfig

Returns the flag that indicates if notice messages should be rendered in the report ( true) or if only error and warn messages are rendered ( false).

IssueMessageWrapper - Class in de.smartics.maven.apidoc

Wraps a message to provide report specific information.

IssueMessageWrapper(Collection<String>, String, IssueMessage) - Constructor for class de.smartics.maven.apidoc. IssueMessageWrapper

Default constructor.

J

JavadocMessageConfig - Class in de.smartics.maven.apidoc

Configuration to control the rendering of the report.

JavadocMessageConfig.Builder - Class in de.smartics.maven.apidoc

Builder for the configuration instance.

JavadocMessageConfig.Builder() - Constructor for class de.smartics.maven.apidoc. JavadocMessageConfig.Builder

JavadocMessageReportRenderer - Class in de.smartics.maven.apidoc

Renders the Javadoc tool messages to a Maven report.

JavadocMessageReportRenderer(Sink, JavadocMessageConfig, JavadocMessageLogger) - Constructor for class de.smartics.maven.apidoc. JavadocMessageReportRenderer

Default constructor.

JavadocPluginConfigurationExtractor - Class in de.smartics.maven.apidoc

Helper to add additional parameters provided by the maven-javadoc-plugin to be passed to the Javadoc tool.

JavadocPluginConfigurationExtractor() - Constructor for class de.smartics.maven.apidoc. JavadocPluginConfigurationExtractor

Default constructor.

L

locale - Variable in class de.smartics.maven.apidoc. AbstractReportMojo

The locale to use regardless of the report.

localRepository - Variable in class de.smartics.maven.apidoc. AbstractReportMojo

Local Repository.

logLevel - Variable in class de.smartics.maven.apidoc. AbstractReportMojo

Specifies the log level used for this plugin.

M

MessageHelper - Class in de.smartics.maven.apidoc

A helper to control access to the filtered messages.

MessageHelper(JavadocMessageConfig, JavadocMessageLogger) - Constructor for class de.smartics.maven.apidoc. MessageHelper

Default constructor.

O

outputDirectory - Variable in class de.smartics.maven.apidoc. AbstractReportMojo

Specifies the directory where the report will written to.

P

pluginArtifacts - Variable in class de.smartics.maven.apidoc. ApiDocReportMojo

The plugin's dependencies to build the classpath for tools to be called.

project - Variable in class de.smartics.maven.apidoc. AbstractReportMojo

The Maven project.

provideSink() - Method in class de.smartics.maven.apidoc. AbstractReportMojo

Ensures that a writeable sink is provided.

R

renderBody() - Method in class de.smartics.maven.apidoc. JavadocMessageReportRenderer

renderFooter() - Method in class de.smartics.maven.apidoc. JavadocMessageReportRenderer

Renders the footer text.

renderTitle(boolean) - Method in class de.smartics.maven.apidoc. JavadocMessageReportRenderer

Renders the title block of the report.

resolver - Variable in class de.smartics.maven.apidoc. AbstractReportMojo

The resolver for resolving artifacts.

S

setBundle(ResourceBundle) - Method in class de.smartics.maven.apidoc. JavadocMessageConfig.Builder

Sets the resource bundle to fetch messages to be rendered into the report.

setMessageFilter(Collection<String>) - Method in class de.smartics.maven.apidoc. JavadocMessageConfig.Builder

Sets the list of message fragments that are used to filter messages.

setNoticeMessagesRendered(boolean) - Method in class de.smartics.maven.apidoc. JavadocMessageConfig.Builder

Sets the flag that indicates if notice messages should be rendered in the report ( true) or if only error and warn messages are rendered ( false).

setSourceRoots(Collection<String>) - Method in class de.smartics.maven.apidoc. JavadocMessageConfig.Builder

Sets the root directories in which the source files reside.

setXrefLocation(String) - Method in class de.smartics.maven.apidoc. JavadocMessageConfig.Builder

Sets the location where the XRef report is written to.

siteRenderer - Variable in class de.smartics.maven.apidoc. AbstractReportMojo

The Doxia site renderer.

skip - Variable in class de.smartics.maven.apidoc. AbstractReportMojo

A simple flag to skip the generation of the reports.

A B C D E F G H I J L M O P R S