web-dev-qa-db-fra.com

Comment désactiver les avertissements Javadoc dans le plugin Maven Javadoc?

J'utilise le plugin Maven Javadoc. Il émet des avertissements comme suit:

[ERROR] /home/monperrus/spoon/src/main/Java/spoon/visitor/CtVisitor.Java:144:
      warning: no @param for <T>

Comment afficher ces avertissements en tant que [WARNING] (et non le [ERROR] prêtant à confusion)?

mavenjavadocmaven-javadoc-plugin
13
Martin Monperrus

Comment afficher ces avertissements en tant que [WARNING] (et non le [ERROR] déroutant)? Comment désactiver complètement les avertissements Javadoc dans Maven?

Si vous parlez des avertissements javadoc lint introduits dans Java 8, vous devriez pouvoir effectuer les opérations suivantes. Il existe plusieurs façons de spécifier les paramètres en fonction de la version du plug-in javadoc que vous utilisez.

<plugins>
   <plugin>
      <groupId>org.Apache.maven.plugins</groupId>
      <artifactId>maven-javadoc-plugin</artifactId>
      <configuration>
         <additionalparam>-Xdoclint:none</additionalparam>
         <additionalOptions>-Xdoclint:none</additionalOptions>
         <additionalJOption>-Xdoclint:none</additionalJOption>
      </configuration>
   </plugin>
</plugins>

Voir cette bonne discussion sur la désactivation de doclint .

Si vous préférez simplement vous débarrasser des avertissements jacadocs manquants, vous pouvez utiliser:

<configuration>
   <additionalparam>-Xdoclint:all -Xdoclint:-missing</additionalparam>
   <additionalOptions>-Xdoclint:all -Xdoclint:-missing</additionalOptions>
   <additionalJOption>-Xdoclint:all -Xdoclint:-missing</additionalJOption>
</configuration>
16
Gray

la version 2.9 de maven-javadoc-plugin, la définition de additionalparam, ne semble pas fonctionner. La nouvelle option à définir est additionalJOption (voir documentation ). Un exemple ici:

<plugin>
        <groupId>org.Apache.maven.plugins</groupId>
        <artifactId>maven-javadoc-plugin</artifactId>
        <configuration>
            <additionalJOption>-Xdoclint:none</additionalJOption>
        </configuration>
   </plugin>

Notez que les avertissements sont toujours affichés dans la console, mais pas avec le préfixe déroutant "[ERREUR]".

11
Spring Monkey

Vous pouvez également le désactiver à partir de la ligne de commande, au cas où vous voudriez simplement supprimer localement mais pas codifier.

mvn clean install -Dadditionalparam=-Xdoclint:none

comme le souligne Spring Monkey, dans les nouvelles versions, vous devrez peut-être le transmettre

mvn clean install -DadditionalJOption=-Xdoclint:none
7
Paul Back

Depuis la version 3.0.0 du maven-javadoc-plugin, vous pouvez utiliser le paramètre de configuration doclint. Si vous souhaitez simplement désactiver les avertissements "manquants", utilisez all,-missing:

<plugin>
    <groupId>org.Apache.maven.plugins</groupId>
    <artifactId>maven-javadoc-plugin</artifactId>
    <version>3.0.1</version>
    <configuration>
        <doclint>all,-missing</doclint>
    </configuration>
</plugin>

Pour plus d'informations, voir la documentation sur les paramètres doclint .

3
hzpz

En compilant toutes les réponses et en ajoutant autre chose, nous avons les éléments suivants.

Pour configurer le projet maven vous devez ajouter ceci au fichier pom:

<plugins>
   <plugin>
      <groupId>org.Apache.maven.plugins</groupId>
      <artifactId>maven-javadoc-plugin</artifactId>
      <configuration>
         <additionalparam>-Xdoclint:none</additionalparam>
         <additionalJOption>-Xdoclint:none</additionalOptions>
      </configuration>
   </plugin>
</plugins>

Pour Maven 2.9+, vous avez besoin de additionalJOption, et avant cela, vous avez besoin de additionalparam. Vous pouvez avoir additionalparam sur Maven 2.9+ car cela ne causera pas d'erreur, mais cela ne fonctionnera pas. Je n'ai pas testé la possibilité d'utiliser additionalJOption sur les versions précédentes de maven.

Pour le configurer à partir de la ligne de commande , vous devez passer ce paramètre:

mvn <goals> -Dadditionalparam=-Xdoclint:none -DadditionalJOption=-Xdoclint:none

Pour le configurer sur votre environnement Shell , afin qu’il s’applique chaque fois à chaque projet sans que vous n’ayez rien à faire, ajoutez cette ligne à votre initialisation Shell (~/.bashrc ou sur Macs ~/.bash_profile, ou tout ce que votre Shell utilise ):

export Java_TOOL_OPTIONS="-Dadditionalparam=-Xdoclint:none -DadditionalJOption=-Xdoclint:none"

Ou, si vous avez un Java_TOOL_OPTIONS, ajoutez-y ces paramètres.

1
Daniel C. Sobral