javadoc Parameter ohne Paketnamen

Question

Grundsätzlich Format Eclipse Export javadoc Ausgabe wie:

 

    Method 
    Modifier and type  Method and description 
    java.lang.String   getData(java.lang.String key) 
    java.lang.String   echo(java.lang.String string) 
    ... 

Wenn ich will ein anderes Format wie:

 
    Method 
    Modifier and type  Method and description 
    String     getData(String key) 
    String     echo(String string) 
    ... 

(ohne Paketnamen)

was sollte ich tun, in der Eclipse javadoc Extra javadoc Optionen? vielen dank.

Answer 1

Ich bin mir nicht sicher, wie man dies in Eclipse konfiguriert, aber das Standard-Doclet hat die -noqualifier option.

Wenn keine Paketnamen angezeigt werden sollen, können Sie -noqualifier all verwenden. Wenn Sie nur einige Paketnamen auslassen möchten, können Sie diese wie folgt auflisten: -noqualifier java.lang:java.io.

Hinweis: In diesen Fällen ist es eine gute Idee, auch eine -link oder -linkoffline Option zu haben, die auf die Dokumentation dieser Klassen verweist, so dass die Leser herausfinden können, welche Klasse hier gemeint ist.

Answer 2

Für diejenigen, die Maven (und das maven-javadoc-plugin) verwenden, ist hier ein Beispiel für die Angabe von "noqualifier" und "links" für das javadocs-Plugin (innerhalb der pom.xml-Datei des Projekts).

<build> 
    <plugins> 
     <plugin> 
     <groupId>org.apache.maven.plugins</groupId> 
     <artifactId>maven-javadoc-plugin</artifactId> 
     <version>2.10.3</version> 
     <configuration> 
      <noqualifier>all</noqualifier> 
      <links> 
      <link>http://hbase.apache.org/apidocs/</link> 
      <link>http://docs.oracle.com/javase/7/docs/api/</link> 
      </links> 
     </configuration> 
     <executions> 
      <execution> 
      <id>javadocs</id> 
      <phase>package</phase> 
      <goals> 
       <goal>javadoc</goal> 
      </goals> 
      </execution> 
     </executions> 
     </plugin> 
    </plugins> 
</build> 

Dokumentation über die "noqualifier" Parameter ist sehr prägnant und kann hier bestellt werden: https://maven.apache.org/plugins/maven-javadoc-plugin/javadoc-mojo.html#noqualifier auf dem "Links" Parameter

Die vollständige Dokumentation finden Sie hier: https://maven.apache.org/plugins/maven-javadoc-plugin/examples/links-configuration.html