Javadoc без имени пакета

Question

В основном, затмение выходной формат экспорта Javadoc, такие как:

 

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

Если я хочу другой формат, такой как:

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

(без имени пакета)

, что должен ли я делать в элементе javadoc Extra javadoc для eclipse? большое спасибо.

Answer 1

Я не уверен, как это можно настроить в Eclipse, но у стандартного doclet есть -noqualifier option.

Если вы не хотите, чтобы имена пакетов отображались, вы можете использовать -noqualifier all, если вы хотите, чтобы некоторые имена пакетов были опущены, вы можете их перечислить следующим образом: -noqualifier java.lang:java.io.

Обратите внимание, что тогда в этих случаях также есть опция -link или -linkoffline, связанная с документацией этих классов, поэтому у читателей есть возможность узнать, какой класс здесь имеет в виду.

Answer 2

Для тех, кто использует Maven (и maven-javadoc-plugin), приведен пример указания «noqualifier» и «links» для плагина javadocs (в файле pom.xml проекта).

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

Документация по параметру «noqualifier» очень сжатое, и можно найти здесь: https://maven.apache.org/plugins/maven-javadoc-plugin/javadoc-mojo.html#noqualifier

Полная документация по параметру «ссылки» доступна здесь: https://maven.apache.org/plugins/maven-javadoc-plugin/examples/links-configuration.html