javadoc sin nombre del paquete

Question

Básicamente, el formato de salida de javadoc exportación Eclipse tales como:

 

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

si quiero otro formato, como:

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

(sin nombre del paquete)

lo ¿Debo hacerlo en el elemento eclipse javadoc Extra javadoc options? muchas gracias.

Answer 1

No estoy seguro de cómo se configura esto en Eclipse, pero el doclet estándar tiene el -noqualifier option.

Si no desea que se muestren los nombres de los paquetes, puede usar -noqualifier all, si solo desea omitir algunos nombres de paquetes, puede enumerarlos, como este: -noqualifier java.lang:java.io.

Tenga en cuenta que en estos casos es una buena idea tener también una opción -link o -linkoffline vinculándose a la documentación de estas clases, para que los lectores tengan la oportunidad de averiguar qué clase se entiende aquí.

Answer 2

Para aquellos que usan Maven (y el plugin maven-javadoc), aquí hay un ejemplo de especificación de "noqualifier" y "enlaces" para el plugin javadocs (dentro del archivo pom.xml del proyecto).

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

Documentación sobre el parámetro "noqualifier" es muy sucinta, y se puede encontrar aquí: https://maven.apache.org/plugins/maven-javadoc-plugin/javadoc-mojo.html#noqualifier

la documentación completa sobre el parámetro "enlaces" está disponible aquí: https://maven.apache.org/plugins/maven-javadoc-plugin/examples/links-configuration.html