-
Bug
-
Resolution: Won't Fix
-
P4
-
8, 11
-
x86_64
-
generic
A DESCRIPTION OF THE PROBLEM :
The <pre> HTML tag makes javadoc include the space after asterisks:
/**
* Some doc
* <pre>
* String example = "";
* int someValue = 1;
* </pre>
*/
public class MyClass { }
Will result in the documentation (with leading spaces replaced with #):
Some doc
#String example = "";
#int someValue = 1;
As you can see the <pre> tag causes the space between the asterisk and the start of the code to be included. This is very likely in most cases not the wanted behavior.
Examples for this can be seen in the documentation https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Throwable.html#initCause(java.lang.Throwable) where each code line is indented with a space.
The <pre> HTML tag makes javadoc include the space after asterisks:
/**
* Some doc
* <pre>
* String example = "";
* int someValue = 1;
* </pre>
*/
public class MyClass { }
Will result in the documentation (with leading spaces replaced with #):
Some doc
#String example = "";
#int someValue = 1;
As you can see the <pre> tag causes the space between the asterisk and the start of the code to be included. This is very likely in most cases not the wanted behavior.
Examples for this can be seen in the documentation https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Throwable.html#initCause(java.lang.Throwable) where each code line is indented with a space.