Comment inclure des objectifs et des paramètres dans la documentation pour un site de plugin maven

Question

Il semble que vous pouvez générer un site de documentation standard (comme celui-ci ) d'un projet de plugin Maven. J'ai essayé d'exécuter mvn site dans un projet de plugin, mais il ne génère pas la documentation attendue (une page qui montre les objectifs Mojo, paramètres, etc.). Y at-il un autre objectif qui doit être invoqué pour générer ces pages web? J'utilise Maven v. 2.1.0.

Answer 1

Pour obtenir la documentation du plug-in (objectifs, params, etc.) inclus dans la documentation du site, vous devez ajouter ce qui suit au pom.xml

<project>
  ...
  <reporting>
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-plugin-plugin</artifactId>
        <version>2.5.1</version>
      </plugin>
    </plugins>
  </reporting>    
  ...
</project>

Cela ajoute un lien « Rapports du projet » dans le menu du site, ce qui montre l'équivalent de Javadoc de plugin Maven.

Answer 2

Hors de la boîte, mvn site devrait au moins générer une page d'index (et l'effet de levier du name et descriptionfrom le POM de votre projet) et un ensemble de base de rapports (A propos, numéro de suivi, l'équipe du projet, dépendances, Plugins projet, intégration continue, dépôt Source, Licence projet, listes de diffusion, gestion des plugins, Résumé du projet).

Si vous souhaitez personnaliser l'ensemble des rapports, vous pouvez configurer le descripteur de site (src/site/site.xml par défaut). Dans ce cas, vous devez inclure une entrée de <menu ref="reports"/> pour les rapports ci-dessus.

Si vous voulez ajouter du contenu , vous devrez fournir à l'aide de l'un des formats pris en charge (par exemple APT, FML, XDoc). La plupart du temps, APT est utilisé de nos jours.

Consultez la documentation du Maven Plugin site pour plus de détails.

Answer 3

Il ne génère rien? Ce serait étrange, il devrait au moins construire un site très simple, avec des informations générales et une documentation des dépendances. maven siteis l'appel correct.

Pour d'autres (javadoc documentations, rapports d'essais, etc.) dont vous avez besoin d'ajouter d'autres éléments dans le fichier de construction. Jetez un oeil à la documentation pour quelques exemples plug-in surefire.

Answer 4

Non, mais votre projet doit contenir une structure spécifique comme le montre ici .