2016-06-30 16 views
2

Ich muss Javadoc von einer Schnittstelle erben, die in einer Maven-Abhängigkeit lebt. Um die Dokumentation zu übernehmen, habe ich dem Javadoc-Plugin in meinem Modul eine Überschreibung hinzugefügt. Ich habe es in den Abschnitt <reporting> meines POM geschrieben, weil ich das Javadoc als Teil des Ziels mvn site generieren möchte.Javadoc-Vererbung aus der Maven-Abhängigkeit

Mein Problem ist, dass das Drehen von <includeDependencySources> bedeutet, dass die Quelle für die angegebenen Abhängigkeiten als Teil des Javadoc für mein Modul generiert wird, was nicht erwünscht ist. Gibt es eine Möglichkeit, die Dokumentation von einer Abhängigkeitsquelle zu übernehmen, ohne das Javadoc für die Abhängigkeitsquelle zu generieren?

<reporting> 
    <plugins> 
     <plugin> 
      <groupId>org.apache.maven.plugins</groupId> 
      <artifactId>maven-javadoc-plugin</artifactId> 
      <version>2.9</version> 
      <configuration combine.self="append"> 
       <source>${jdkVersion}</source> 
       <includeDependencySources>true</includeDependencySources> 
       <includeTransitiveDependencySources>false</includeTransitiveDependencySources> 
       <dependencySourceIncludes> 
        <dependencySourceInclude>com.mysource.object:*</dependencySourceInclude> 
        <dependencySourceInclude>com.mysource.object2:*</dependencySourceInclude> 
        <dependencySourceInclude>com.mysource.common:*</dependencySourceInclude> 
       </dependencySourceIncludes> 
      </configuration> 
      <reportSets> 
       <reportSet> 
        <reports> 
         <report>javadoc</report> 
        </reports> 
       </reportSet> 
      </reportSets> 
     </plugin> 
    </plugins> 
</reporting> 
+0

eine Änderung: In 'mvn site' der' site' kein Ziel ist, aber eine _phase_ von [Maven's Site Lifecycle] (https://maven.apache.org/guides/introduction/introduction-to-the-lifecycle.html#Lifecycle_Reference) (obwohl die Standardbindung an diese Phase das 'site' Ziel ist des 'maven-site-plugin', abgekürzt mit, du hast es erraten,' site'.) –

Antwort

0

Ich habe keinen Hinweis gefunden, dass dies auf den Seiten des Maven Site Plugins möglich ist.

jedoch sehen Apache Maven Site Plugin/FAQ, How do I Integrate static (X)HTML pages into my Maven site?:

Sie können indem Sie die folgenden Schritte, um Ihre statischen Seiten integrieren: Legen Sie Ihre statische Seiten im Ressourcenverzeichnis

  • , ${basedir}/src/site/resources

  • Erstellen Sie Ihre site.xml und setzen Sie es in ${basedir}/src/site

  • Link zu den statischen Seiten, indem Sie den Menüabschnitt ändern, erstellen Elemente und ordnen Sie die Dateinamen der statischen Seiten