2015-09-27 6 views
8

Gdybym wygenerować javadoc dla metody Parametry metody/wyjątki niepotrzebnie się zawinięty do nowej linii, na przykład:generowanych stron javadoc unneccesarily argumenty metoda okład z adnotacjami

enter image description here

Jest mnóstwo przestrzeni poziomej pozostawione na stronie. Korzystanie z Oracle javadoc.exe 8u60.

Jak mogę zapobiec tym niepotrzebnym podziałom linii bez konieczności ręcznej edycji plików HTML?

to kod źródłowy części pokazano na zdjęcie:

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

kod źródłowy powyżej ekstrahuje, skrapla się i przetwarzane przez formater HTML dla łatwiejszego odczytu here is the very raw complete file.

+0

Więc masz już formatowania HTML, ale nie wiesz jak go używać? – EJP

+0

Użyłem szybkiego formatyzatora HTML online, aby ułatwić czytanie, pierwotny i wbudowany kod w zasadzie równy. Nic więcej. – RAnders00

+0

Czy używasz docletów, aby ominąć ten problem? Jest to wykonalne, ale wymaga wiele wysiłku przy stosunkowo niewielkiej zmianie. – approxiblue

Odpowiedz

8

Możesz dostosować format swojego javadoc, pisząc niestandardowy dokument.

Proszę sprawdzić tę sekcję w dokumentacji generatora javadoc:

javadoc Doclets

można dostosować treść i formę wyjścia polecenia javadoc z doclets. Komenda javadoc ma domyślny wbudowany doclet, zwany standardową doclet, który generuje dokumentację API w formacie HTML. Możesz modyfikować lub tworzyć podklasę standardowego docletu lub napisać własny dokument, aby wygenerować HTML, XML, MIF, RTF lub dowolny format wyjściowy, który chcesz.

Gdy niestandardowy doclet nie jest określony opcją -doclet, komenda javadoc używa domyślnego standardowego docletu. Komenda javadoc ma kilka opcji, które są dostępne niezależnie od tego, który dokument jest używany. Standardowy doclet dodaje dodatkowy zestaw opcji wiersza poleceń. Zobacz Opcje.

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

+3

Ponowne wdrożenie całego dokumentu, aby pozbyć się tylko kilku linii, jest trudnym rozwiązaniem ... – Holger

Powiązane problemy