2015-09-27 7 views
8

Se genero javadoc per un metodo i parametri del metodo/eccezioni inutilmente vengono avvolti in una nuova linea, in questo modo:pagine Javadoc generati unneccesarily argomenti del metodo involucro con annotazioni

enter image description here

v'è abbondanza di spazio orizzontale lasciato sulla pagina. Utilizzando Oracle javadoc.exe 8u60.

Come posso evitare queste interruzioni di riga non necessarie senza dover modificare manualmente i file HTML?

Questo è il codice sorgente della parte mostrato nella schermata:

<ul class="blockList"> 
    <li class="blockList"> 
     <a name="method.detail"> 
      <!-- --> 
     </a> 
     <h3>Method Detail</h3> 
     <a name="getRootWord--"> 
      <!-- --> 
     </a> 
     <ul class="blockList"> 
      <li class="blockList"> 
       <h4>getRootWord</h4> 
       <pre>@NotNull 
public&nbsp;<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getRootWord()</pre> 
      </li> 
     </ul> 
     <a name="setRootWord-java.lang.String-"> 
      <!-- --> 
     </a> 
     <ul class="blockList"> 
      <li class="blockList"> 
       <h4>setRootWord</h4> 
       <pre>public&nbsp;void&nbsp;setRootWord(@NotNull 
         <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;rootWord)</pre> 
      </li> 
     </ul> 
     <a name="getAdjectiveDeclension--"> 
      <!-- --> 
     </a> 
     <ul class="blockList"> 
      <li class="blockList"> 
       <h4>getAdjectiveDeclension</h4> 
       <pre>@NotNull 
public&nbsp;<a href="../../../../com/kayon/core/adjective/AdjectiveDeclension.html" title="interface in com.kayon.core.adjective">AdjectiveDeclension</a>&nbsp;getAdjectiveDeclension() 
                throws <a href="../../../../com/kayon/core/NoDeclensionException.html" title="class in com.kayon.core">NoDeclensionException</a></pre> 
       <dl> 
        <dt><span class="throwsLabel">Throws:</span></dt> 
        <dd><code><a href="../../../../com/kayon/core/NoDeclensionException.html" title="class in com.kayon.core">NoDeclensionException</a></code></dd> 
       </dl> 
      </li> 
     </ul> 
     <a name="setAdjectiveDeclension-com.kayon.core.adjective.AdjectiveDeclension-"> 
      <!-- --> 
     </a> 
     <ul class="blockList"> 
      <li class="blockList"> 
       <h4>setAdjectiveDeclension</h4> 
       <pre>public&nbsp;void&nbsp;setAdjectiveDeclension(@Nullable 
            <a href="../../../../com/kayon/core/adjective/AdjectiveDeclension.html" title="interface in com.kayon.core.adjective">AdjectiveDeclension</a>&nbsp;adjectiveDeclension)</pre> 
      </li> 
     </ul> 
    </li> 
</ul> 

Il codice sorgente sopra viene estratto, condensato ed elaborati da un formattatore HTML per facilitare la lettura, here is the very raw complete file.

+0

Quindi Hai già un formattatore HTML, ma non sai come usarlo? – EJP

+0

Ho usato un formattatore HTML online rapido per renderlo più facile da leggere, l'originale e il codice in linea sostanzialmente uguale. Niente di più. – RAnders00

+0

Sei pronto per usare doclets per ovviare a questo problema? È fattibile, ma un grande sforzo per un cambiamento relativamente piccolo. – approxiblue

risposta

8

È possibile personalizzare il formato di javadoc scrivendo un doclet personalizzato.

prega di consultare questa sezione nella documentazione generatore javadoc:

doclet Javadoc

è possibile personalizzare il contenuto e il formato del comando javadoc con doclet. Il comando javadoc ha un doclet predefinito predefinito, chiamato doclet standard, che genera documentazione API in formato HTML. È possibile modificare o creare una sottoclasse del doclet standard o scrivere il proprio doclet per generare HTML, XML, MIF, RTF o qualsiasi formato di output desiderato.

Quando un doclet personalizzato non viene specificato con l'opzione -doclet, il comando javadoc utilizza il doclet standard predefinito. Il comando javadoc ha diverse opzioni disponibili indipendentemente dal doclet utilizzato. Il doclet standard aggiunge un set supplementare di opzioni da riga di comando. Vedi Opzioni.

http://docs.oracle.com/javase/8/docs/technotes/tools/windows/javadoc.html

+3

Re-implementare l'intero doclet per liberarsi di poche interruzioni di linea è una soluzione difficile ... – Holger

Problemi correlati