eugene:tag-values-report

Note :Ce goal doit être utilisé comme un rapport de Maven.

Nom complet :

org.nuiton.eugene:eugene-maven-plugin:3.1-SNAPSHOT:tag-values-report

Description :

To report a TagValueMetadatasProvider. Created on 5/31/14.

Attributs :

  • Exige un projet Maven pour être exécuté.
  • S'exécute seulement comme un reportSet (goal de reporting).
  • Exige une résolution des dépendances des artefacts dans le scope : compile.
  • Depuis la version : 2.10.

Paramètres requis

Nom Type Depuis Description
<outputDirectory> File 2.10 Report output directory. Note that this parameter is only relevant if the goal is run from the command line or from the default build lifecycle. If the goal is run indirectly as part of a site generation, the output directory configured in the Maven Site Plugin is used instead.
Valeur par défaut : ${project.reporting.outputDirectory}.
Propriété utilisateur : config.outputDirectory.
<outputEncoding> String 2.10 Report output encoding. Note that this parameter is only relevant if the goal is run from the command line or from the default build lifecycle. If the goal is run indirectly as part of a site generation, the output encoding configured in the Maven Site Plugin is used instead.
Valeur par défaut : ${project.reporting.outputEncoding}.
Propriété utilisateur : config.outputEncoding.
<providerName> String 2.10 Name of the tagValue provider. This is the role-hint given to the tag value provider to describe.
Valeur par défaut : ${project.artifactId}.
Propriété utilisateur : eugene.providerName.

Paramètres optionnels

Nom Type Depuis Description
<javaDocDestDir> String 2.10 Location of javadoc report.
Valeur par défaut : apidocs.
Propriété utilisateur : eugene.javaDocDestDir.
<jxrDestDir> String 2.10 Location of xref report.
Valeur par défaut : xref.
Propriété utilisateur : eugene.jxrDestDir.
<skip> boolean 2.10 Skip to generate the report.
Propriété utilisateur : config.skip.

Détails des paramètres

<javaDocDestDir>

Location of javadoc report.
  • Type : java.lang.String
  • Depuis : 2.10
  • Exigé : Non
  • Propriété utilisateur : eugene.javaDocDestDir
  • Défaut : apidocs

<jxrDestDir>

Location of xref report.
  • Type : java.lang.String
  • Depuis : 2.10
  • Exigé : Non
  • Propriété utilisateur : eugene.jxrDestDir
  • Défaut : xref

<outputDirectory>

Report output directory. Note that this parameter is only relevant if the goal is run from the command line or from the default build lifecycle. If the goal is run indirectly as part of a site generation, the output directory configured in the Maven Site Plugin is used instead.
  • Type : java.io.File
  • Depuis : 2.10
  • Exigé : Oui
  • Propriété utilisateur : config.outputDirectory
  • Défaut : ${project.reporting.outputDirectory}

<outputEncoding>

Report output encoding. Note that this parameter is only relevant if the goal is run from the command line or from the default build lifecycle. If the goal is run indirectly as part of a site generation, the output encoding configured in the Maven Site Plugin is used instead.
  • Type : java.lang.String
  • Depuis : 2.10
  • Exigé : Oui
  • Propriété utilisateur : config.outputEncoding
  • Défaut : ${project.reporting.outputEncoding}

<providerName>

Name of the tagValue provider. This is the role-hint given to the tag value provider to describe.
  • Type : java.lang.String
  • Depuis : 2.10
  • Exigé : Oui
  • Propriété utilisateur : eugene.providerName
  • Défaut : ${project.artifactId}

<skip>

Skip to generate the report.
  • Type : boolean
  • Depuis : 2.10
  • Exigé : Non
  • Propriété utilisateur : config.skip