Skip navigation links
A C E G H I J O P R S 

A

AbstractJxrReport - Class in org.apache.maven.plugin.jxr
Base class for the JXR reports.
AbstractJxrReport() - Constructor for class org.apache.maven.plugin.jxr.AbstractJxrReport
 
AggregatorJxrReport - Class in org.apache.maven.plugin.jxr
Generates a combined JXR report in an aggregating project.
AggregatorJxrReport() - Constructor for class org.apache.maven.plugin.jxr.AggregatorJxrReport
 
AggregatorJxrTestReport - Class in org.apache.maven.plugin.jxr
Generates a combined JXR report for test code in an aggregating project.
AggregatorJxrTestReport() - Constructor for class org.apache.maven.plugin.jxr.AggregatorJxrTestReport
 

C

canGenerateReport() - Method in class org.apache.maven.plugin.jxr.AbstractJxrReport
 
constructSourceDirs() - Method in class org.apache.maven.plugin.jxr.AbstractJxrReport
Gets the list of the source directories to be included in the JXR report generation

E

execute() - Method in class org.apache.maven.plugins.maven_jxr_plugin.HelpMojo
executeReport(Locale) - Method in class org.apache.maven.plugin.jxr.AbstractJxrReport
 

G

getBundle(Locale) - Method in class org.apache.maven.plugin.jxr.AbstractJxrReport
Returns the correct resource bundle according to the locale.
getDescription(Locale) - Method in class org.apache.maven.plugin.jxr.JxrReport
 
getDescription(Locale) - Method in class org.apache.maven.plugin.jxr.JxrTestReport
 
getDestinationDirectory() - Method in class org.apache.maven.plugin.jxr.AbstractJxrReport
Abstract method that returns the target directory where the generated JXR reports will be put.
getDestinationDirectory() - Method in class org.apache.maven.plugin.jxr.JxrReport
 
getDestinationDirectory() - Method in class org.apache.maven.plugin.jxr.JxrTestReport
 
getJavadocDir() - Method in class org.apache.maven.plugin.jxr.AbstractJxrReport
Abstract method that returns the directory of the javadoc files.
getJavadocDir() - Method in class org.apache.maven.plugin.jxr.JxrReport
 
getJavadocDir() - Method in class org.apache.maven.plugin.jxr.JxrTestReport
 
getMavenJavadocPluginBasicOption(MavenProject, String, String) - Static method in class org.apache.maven.plugin.jxr.JxrReportUtil
Returns the optionName value defined in a project for the "maven-javadoc-plugin" plugin.
getMavenJavadocPlugins(MavenProject) - Static method in class org.apache.maven.plugin.jxr.JxrReportUtil
Returns the plugin references for the javadoc plugin in a project.
getName(Locale) - Method in class org.apache.maven.plugin.jxr.JxrReport
 
getName(Locale) - Method in class org.apache.maven.plugin.jxr.JxrTestReport
 
getOutputName() - Method in class org.apache.maven.plugin.jxr.JxrReport
 
getOutputName() - Method in class org.apache.maven.plugin.jxr.JxrTestReport
 
getProject() - Method in class org.apache.maven.plugin.jxr.AbstractJxrReport
 
getSession() - Method in class org.apache.maven.plugin.jxr.AbstractJxrReport
Returns the Maven session.
getSourceRoots() - Method in class org.apache.maven.plugin.jxr.AbstractJxrReport
Abstract method that returns the specified source directories that will be included in the JXR report generation.
getSourceRoots(MavenProject) - Method in class org.apache.maven.plugin.jxr.AbstractJxrReport
Abstract method that returns the compile source directories of the specified project that will be included in the JXR report generation
getSourceRoots() - Method in class org.apache.maven.plugin.jxr.JxrReport
 
getSourceRoots(MavenProject) - Method in class org.apache.maven.plugin.jxr.JxrReport
 
getSourceRoots() - Method in class org.apache.maven.plugin.jxr.JxrTestReport
 
getSourceRoots(MavenProject) - Method in class org.apache.maven.plugin.jxr.JxrTestReport
 
getStructure(MavenProject, boolean) - Static method in class org.apache.maven.plugin.jxr.JxrReportUtil
Generates the site structure using the project hierarchy (project and its modules) or using the distributionManagement elements from the pom.xml.

H

HelpMojo - Class in org.apache.maven.plugins.maven_jxr_plugin
Display help information on maven-jxr-plugin.
Call mvn jxr:help -Ddetail=true -Dgoal=<goal-name> to display parameter details.
HelpMojo() - Constructor for class org.apache.maven.plugins.maven_jxr_plugin.HelpMojo
 

I

init() - Method in class org.apache.maven.plugin.jxr.AbstractJxrReport
Initialize some attributes required during the report generation
isAggregate() - Method in class org.apache.maven.plugin.jxr.AbstractJxrReport
Is the current report aggregated?
isAggregate() - Method in class org.apache.maven.plugin.jxr.AggregatorJxrReport
 
isAggregate() - Method in class org.apache.maven.plugin.jxr.AggregatorJxrTestReport
 
isExternalReport() - Method in class org.apache.maven.plugin.jxr.AbstractJxrReport
 
isJavadocAggregated(MavenProject) - Static method in class org.apache.maven.plugin.jxr.JxrReportUtil
Determine if javadoc is aggregated in this project, paying attention to both TODO: take cognizance of javadoc versus test-javadoc the old parameter and the new mojo.

J

JxrNoForkReport - Class in org.apache.maven.plugin.jxr
Creates an html-based, cross referenced version of Java source code for a project without forking.
JxrNoForkReport() - Constructor for class org.apache.maven.plugin.jxr.JxrNoForkReport
 
JxrReport - Class in org.apache.maven.plugin.jxr
Creates an html-based, cross referenced version of Java source code for a project.
JxrReport() - Constructor for class org.apache.maven.plugin.jxr.JxrReport
 
JxrReportUtil - Class in org.apache.maven.plugin.jxr
Utility class for the jxr report.
JxrReportUtil() - Constructor for class org.apache.maven.plugin.jxr.JxrReportUtil
 
JxrTestNoForkReport - Class in org.apache.maven.plugin.jxr
Creates an html-based, cross referenced version of Java source code for a project's test sources without forking.
JxrTestNoForkReport() - Constructor for class org.apache.maven.plugin.jxr.JxrTestNoForkReport
 
JxrTestReport - Class in org.apache.maven.plugin.jxr
Creates an html-based, cross referenced version of Java source code for a project's test sources.
JxrTestReport() - Constructor for class org.apache.maven.plugin.jxr.JxrTestReport
 

O

org.apache.maven.plugin.jxr - package org.apache.maven.plugin.jxr
 
org.apache.maven.plugins.maven_jxr_plugin - package org.apache.maven.plugins.maven_jxr_plugin
 

P

pruneSourceDirs(List<String>) - Method in class org.apache.maven.plugin.jxr.AbstractJxrReport
Compiles the list of directories which contain source files that will be included in the JXR report generation.

R

reactorProjects - Variable in class org.apache.maven.plugin.jxr.AbstractJxrReport
The projects in the reactor for aggregation report.

S

setReportOutputDirectory(File) - Method in class org.apache.maven.plugin.jxr.JxrReport
 
setReportOutputDirectory(File) - Method in class org.apache.maven.plugin.jxr.JxrTestReport
 
skip - Variable in class org.apache.maven.plugin.jxr.AbstractJxrReport
Whether to skip this execution.
A C E G H I J O P R S 
Skip navigation links

Copyright © 2005–2023 The Apache Software Foundation. All rights reserved.