Fork me on GitHub
Built by Maven

aspectj:aspectj-report

Note:

This goal should be used as a Maven report.

Full name:

org.codehaus.mojo:aspectj-maven-plugin:1.16.0:aspectj-report

Description:

Creates an AspectJ HTML report using the ajdoc tool and format. A Maven 2.0 ajdoc report

Attributes:

  • Requires a Maven project to be executed.
  • Requires dependency resolution of artifacts in scope: compile.
  • The goal is not marked as thread-safe and thus does not support parallel builds.
  • Since version: 2.0.

Required Parameters

Name Type Since Description
<outputDirectory> File - The output directory for the report.
Default: ${project.reporting.outputDirectory}/aspectj-report

Optional Parameters

Name Type Since Description
<ajdtBuildDefFile> String - Where to find the ajdt build definition file. If set this will override the use of project sourcedirs.
<aspectDirectory> String - The source directory for the aspects
Default: src/main/aspect
<complianceLevel> String - Specify compiler compliance setting (1.3 to 1.8, default is 1.5)
Default: ${mojo.java.target}
<doctitle> String - Specifies the title to be placed near the top of the overview summary file. The title will be placed as a centered, level-one heading directly beneath the upper navigation bar. The title may contain html tags and white space, though if it does, it must be enclosed in quotes. Any internal quotation marks within title may have to be escaped.
<locale> String - The locale to use when the report generation is invoked directly as a standalone Mojo.
See also: org.apache.maven.doxia.tools.SiteTool.DEFAULT_LOCALE, org.apache.maven.doxia.tools.SiteTool.getSiteLocales(java.lang.String)
Default: default
<outputFormat> String - The report output format: null by default, to represent a site, but can be configured to a Doxia Sink id.
User Property: output.format
<outputTimestamp> String - Timestamp for reproducible output archive entries, either formatted as ISO 8601 yyyy-MM-dd'T'HH:mm:ssXXX or as an int representing seconds since the epoch (like SOURCE_DATE_EPOCH).
Default: ${project.build.outputTimestamp}
<overview> String - Specifies that javadoc should retrieve the text for the overview documentation from the "source" file specified by path/filename and place it on the Overview page (overview-summary.html). The path/filename is relative to the ${basedir}. While you can use any name you want for filename and place it anywhere you want for path, a typical thing to do is to name it overview.html and place it in the source tree at the directory that contains the topmost package directories. In this location, no path is needed when documenting packages, since -sourcepath will point to this file. For example, if the source tree for the java.lang package is /src/classes/java/lang/, then you could place the overview file at /src/classes/overview.html. See Real World Example. For information about the file specified by path/filename, see overview comment file.Note that the overview page is created only if you pass into javadoc two or more package names. For further explanation, see HTML Frames.) The title on the overview page is set by -doctitle.
<packageScope> boolean - Shows only package, protected, and public classes and members.
<privateScope> boolean - Shows all classes and members.
<protectedScope> boolean - Shows only protected and public classes and members. This is the default.
<publicScope> boolean - Shows only public classes and members.
<siteDirectory> File - Directory containing the site.xml file.
Default: ${basedir}/src/site
<testAspectDirectory> String - The source directory for the test aspects
Default: src/test/aspect
<verbose> boolean - Provides more detailed messages while javadoc is running. Without the verbose option, messages appear for loading the source files, generating the documentation (one message per source file), and sorting. The verbose option causes the printing of additional messages specifying the number of milliseconds to parse each java source file.

Parameter Details

<ajdtBuildDefFile>

Where to find the ajdt build definition file. If set this will override the use of project sourcedirs.
  • Type: java.lang.String
  • Required: No

<aspectDirectory>

The source directory for the aspects
  • Type: java.lang.String
  • Required: No
  • Default: src/main/aspect

<complianceLevel>

Specify compiler compliance setting (1.3 to 1.8, default is 1.5)
  • Type: java.lang.String
  • Required: No
  • Default: ${mojo.java.target}

<doctitle>

Specifies the title to be placed near the top of the overview summary file. The title will be placed as a centered, level-one heading directly beneath the upper navigation bar. The title may contain html tags and white space, though if it does, it must be enclosed in quotes. Any internal quotation marks within title may have to be escaped.
  • Type: java.lang.String
  • Required: No

<locale>

The locale to use when the report generation is invoked directly as a standalone Mojo.
See also: org.apache.maven.doxia.tools.SiteTool.DEFAULT_LOCALE, org.apache.maven.doxia.tools.SiteTool.getSiteLocales(java.lang.String)
  • Type: java.lang.String
  • Required: No
  • Default: default

<outputDirectory>

The output directory for the report.
  • Type: java.io.File
  • Required: Yes
  • Default: ${project.reporting.outputDirectory}/aspectj-report

<outputFormat>

The report output format: null by default, to represent a site, but can be configured to a Doxia Sink id.
  • Type: java.lang.String
  • Required: No
  • User Property: output.format

<outputTimestamp>

Timestamp for reproducible output archive entries, either formatted as ISO 8601 yyyy-MM-dd'T'HH:mm:ssXXX or as an int representing seconds since the epoch (like SOURCE_DATE_EPOCH).
  • Type: java.lang.String
  • Required: No
  • Default: ${project.build.outputTimestamp}

<overview>

Specifies that javadoc should retrieve the text for the overview documentation from the "source" file specified by path/filename and place it on the Overview page (overview-summary.html). The path/filename is relative to the ${basedir}. While you can use any name you want for filename and place it anywhere you want for path, a typical thing to do is to name it overview.html and place it in the source tree at the directory that contains the topmost package directories. In this location, no path is needed when documenting packages, since -sourcepath will point to this file. For example, if the source tree for the java.lang package is /src/classes/java/lang/, then you could place the overview file at /src/classes/overview.html. See Real World Example. For information about the file specified by path/filename, see overview comment file.Note that the overview page is created only if you pass into javadoc two or more package names. For further explanation, see HTML Frames.) The title on the overview page is set by -doctitle.
  • Type: java.lang.String
  • Required: No

<packageScope>

Shows only package, protected, and public classes and members.
  • Type: boolean
  • Required: No

<privateScope>

Shows all classes and members.
  • Type: boolean
  • Required: No

<protectedScope>

Shows only protected and public classes and members. This is the default.
  • Type: boolean
  • Required: No

<publicScope>

Shows only public classes and members.
  • Type: boolean
  • Required: No

<siteDirectory>

Directory containing the site.xml file.
  • Type: java.io.File
  • Required: No
  • Default: ${basedir}/src/site

<testAspectDirectory>

The source directory for the test aspects
  • Type: java.lang.String
  • Required: No
  • Default: src/test/aspect

<verbose>

Provides more detailed messages while javadoc is running. Without the verbose option, messages appear for loading the source files, generating the documentation (one message per source file), and sorting. The verbose option causes the printing of additional messages specifying the number of milliseconds to parse each java source file.
  • Type: boolean
  • Required: No