Generated javadoc pages ignore method method arguments with annotations

If I create javadoc for a method, the parameters / exceptions of the method are unnecessarily wrapped in a new line, for example:

enter image description here

There is a lot of horizontal space left on the page. Using Oracle javadoc.exe 8u60.

How can I prevent these unnecessary line breaks without having to manually edit the HTML files?

This is the source code of the part shown in the screenshot:

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

The source code above is extracted, condensed and processed by HTML formatting for easier reading, here is the most unprocessed complete file .

+8
java javadoc
source share
1 answer

You can customize the format of your javadoc by writing a custom document.

Please check this section in the javadoc generator documentation:

Javadoc doclets

You can customize the content and output format of the javadoc command with doclets. The javadoc command has a default built-in doclet called the standard doclet, which generates HTML API documentation. You can change or subclass the standard doclet or write your own document to generate HTML, XML, MIF, RTF or any other output format you want.

If a custom doclet is not specified with the -doclet option, the javadoc command uses the standard doclet by default. The javadoc command has several options that are available regardless of which doclet is used. The standard doclet adds an additional set of command line options. See the Parameters section.

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

+8
source share

All Articles