-
Bug
-
Resolution: Not an Issue
-
P4
-
7u45
-
x86
-
os_x
FULL PRODUCT VERSION :
java version "1.7.0_45"
Java(TM) SE Runtime Environment (build 1.7.0_45-b18)
Java HotSpot(TM) 64-Bit Server VM (build 24.45-b08, mixed mode)
ADDITIONAL OS VERSION INFORMATION :
Darwin retina.dellroad.org 12.5.0 Darwin Kernel Version 12.5.0: Sun Sep 29 13:33:47 PDT 2013; root:xnu-2050.48.12~1/RELEASE_X86_64 x86_64
A DESCRIPTION OF THE PROBLEM :
When the first sentence of a method is this:
Add SQL parameter {@code ?1}, if any.
then running javadoc -breakiterator generates this broken HTML summary for the method:
Add SQL parameter {@code ?
However, the method itself has the correct HTML generated:
Add SQL parameter ?1, if any.
STEPS TO FOLLOW TO REPRODUCE THE PROBLEM :
1. Create the following Java source file:
public class Bug {
/**
* Add SQL parameter {@code ?1}, if any.
*/
public String addParameter() {
return null;
}
}
2. Run "javadoc -breakiterator Bug.java"
3. View the generated Bug.html. Compare Method Summary vs. Method Detail.
The generated HTML summary contains:
<td class="colLast"><code><strong><a href="Bug.html#addParameter()">addParameter</a></strong>()</code>
<div class="block">Add SQL parameter {@code ?</div>
</td>
EXPECTED VERSUS ACTUAL BEHAVIOR :
EXPECTED -
The generated HTML summary should contain:
<td class="colLast"><code><strong><a href="Bug.html#addParameter()">addParameter</a></strong>()</code>
<div class="block">Add SQL parameter <code>?1</code>, if any.</div>
</td>
ACTUAL -
The generated HTML summary contains:
<td class="colLast"><code><strong><a href="Bug.html#addParameter()">addParameter</a></strong>()</code>
<div class="block">Add SQL parameter {@code ?</div>
</td>
REPRODUCIBILITY :
This bug can be reproduced always.
---------- BEGIN SOURCE ----------
public class Bug {
/**
* Add SQL parameter {@code ?1}, if any.
*/
public String addParameter() {
return null;
}
}
---------- END SOURCE ----------
CUSTOMER SUBMITTED WORKAROUND :
Don't use -breakiterator.
java version "1.7.0_45"
Java(TM) SE Runtime Environment (build 1.7.0_45-b18)
Java HotSpot(TM) 64-Bit Server VM (build 24.45-b08, mixed mode)
ADDITIONAL OS VERSION INFORMATION :
Darwin retina.dellroad.org 12.5.0 Darwin Kernel Version 12.5.0: Sun Sep 29 13:33:47 PDT 2013; root:xnu-2050.48.12~1/RELEASE_X86_64 x86_64
A DESCRIPTION OF THE PROBLEM :
When the first sentence of a method is this:
Add SQL parameter {@code ?1}, if any.
then running javadoc -breakiterator generates this broken HTML summary for the method:
Add SQL parameter {@code ?
However, the method itself has the correct HTML generated:
Add SQL parameter ?1, if any.
STEPS TO FOLLOW TO REPRODUCE THE PROBLEM :
1. Create the following Java source file:
public class Bug {
/**
* Add SQL parameter {@code ?1}, if any.
*/
public String addParameter() {
return null;
}
}
2. Run "javadoc -breakiterator Bug.java"
3. View the generated Bug.html. Compare Method Summary vs. Method Detail.
The generated HTML summary contains:
<td class="colLast"><code><strong><a href="Bug.html#addParameter()">addParameter</a></strong>()</code>
<div class="block">Add SQL parameter {@code ?</div>
</td>
EXPECTED VERSUS ACTUAL BEHAVIOR :
EXPECTED -
The generated HTML summary should contain:
<td class="colLast"><code><strong><a href="Bug.html#addParameter()">addParameter</a></strong>()</code>
<div class="block">Add SQL parameter <code>?1</code>, if any.</div>
</td>
ACTUAL -
The generated HTML summary contains:
<td class="colLast"><code><strong><a href="Bug.html#addParameter()">addParameter</a></strong>()</code>
<div class="block">Add SQL parameter {@code ?</div>
</td>
REPRODUCIBILITY :
This bug can be reproduced always.
---------- BEGIN SOURCE ----------
public class Bug {
/**
* Add SQL parameter {@code ?1}, if any.
*/
public String addParameter() {
return null;
}
}
---------- END SOURCE ----------
CUSTOMER SUBMITTED WORKAROUND :
Don't use -breakiterator.