javadoc bez nazwy pakietu

Question

Zasadniczo zaćmienie format javadoc eksport takich jak:

 

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

Jeśli chcę innego formatu, takie jak:

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

(bez nazwy pakietu)

co powinienem zrobić w opcji javadoc dodatkowe opcje javadoc Eclipse? wielkie dzięki.

Answer 1

Nie jestem pewien, jak skonfigurować to w Eclipse, ale standardowy doclet ma -noqualifier option.

Jeśli nie chcesz, aby wyświetlane były jakiekolwiek nazwy pakietów, możesz użyć opcji -noqualifier all, jeśli chcesz pominąć tylko niektóre nazwy pakietów, możesz wymienić je w następujący sposób: -noqualifier java.lang:java.io.

Uwaga: w takich przypadkach warto również dodać opcję -link lub -linkoffline łączącą się z dokumentacją tych zajęć, aby czytelnicy mieli szansę dowiedzieć się, która klasa jest tutaj przeznaczona.

Answer 2

Dla tych, którzy używają Mavena (i maven-javadoc-plugin), tutaj jest przykład określenia "noqualifier" i "links" dla wtyczki javadocs (w ramach pliku pom.xml projektu).

<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> 

Dokumentacja parametru „noqualifier” jest bardzo zwięzłe, a można znaleźć tutaj: https://maven.apache.org/plugins/maven-javadoc-plugin/javadoc-mojo.html#noqualifier

Pełna dokumentacja na parametrze „powiązania” jest dostępny tutaj: https://maven.apache.org/plugins/maven-javadoc-plugin/examples/links-configuration.html