Wie Ziele und Parameter in der Dokumentation für ein Maven Plugin Website enthalten

Question

Es scheint, dass, dass Sie eine Standard-Dokumentation Website generieren können (wie dieses ) von einem Maven Plugin-Projekt. Ich habe versucht, in einem Plugin-Projekt ausführen mvn site aber nicht die erwartete Dokumentation erzeugen (eine Seite, die zeigt die Mojo Ziele, Parameter, etc.). Gibt es ein anderes Ziel, die aufgerufen werden, müssen diese Web-Seiten zu generieren? Ich verwende Maven v. 2.1.0.

Answer 1

Um die Plugin-Dokumentation (Ziele, params, etc.) zu erhalten in der Website-Dokumentation enthalten ist, müssen Sie die folgenden auf die pom.xml

hinzufügen

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

Das fügt eine „Projektberichte“ Link zu der Website-Menü, das zeigt das Maven Plugin Äquivalent von Javadoc.

Answer 2

Aus dem Kasten heraus, mvn site sollte mindestens eine Indexseite erzeugen (und nutzen die name und die descriptionfrom das POM des Projekts) und einen Basissatz von Berichten (About, Issue Tracking, Projektteam, Abhängigkeiten, Projekt Plugins, Continuous Integration, Quellcode-Depot, Projektlizenz, Mailinglisten, Plugin-Management, Projektzusammenfassung).

Wenn Sie den Satz von Berichten anpassen möchten, können Sie die Site Descriptor (src/site/site.xml Standard). In diesem Fall erhalten Sie einen <menu ref="reports"/> Eintrag für die oben genannten Berichte enthalten müssen.

Wenn Sie auf Inhalte hinzufügen , werden Sie es bieten haben eines der unterstützten Formate (zB APT, FML, XDoc). Die meisten der Zeit, APT wird verwendet, heutzutage.

überprüfen Sie die Dokumentation der Maven Site-Plugin für weitere Details.

Answer 3

Es hat nichts generieren? Das wäre seltsam, sollte es zumindest eine sehr einfache Website mit allgemeinen Informationen und einer Dokumentation der Abhängigkeiten aufzubauen. maven siteis den richtigen Anruf.

Für weitere Dokumentationen (javadoc, Prüfberichte, etc) Sie müssen mehr Elemente in die Build-Datei hinzuzufügen. Werfen Sie einen Blick auf die todsichere Plugin Dokumentation für einige Beispiele.

Answer 4

Nein, aber Ihr Projekt sollte eine spezifische Struktur enthalten, wie hier .