Java Solaris Communities Sun Store Join SDN My Profile Why Join?
 
Bug Database
Bug Detail
Quick Lists
Top 25 Bugs
Top 25 RFE's
Recently Closed Bugs
Printable Page Printable Page


Bug Database
Bug ID: 4935515
Votes 0
Synopsis Cannot override Javadoc's sentence bounary algorithm
Category java:javadoctool
Reported Against 1.4.2
Release Fixed
State 11-Closed, duplicate of 4921374, request for enhancement
Priority: 4-Low
Related Bugs 4921374
Submit Date 09-OCT-2003
Description




A DESCRIPTION OF THE REQUEST :
At times Javadoc incorrectly interprets the sentence bounaries in Javadoc comments.

Ex: "Looks for occurances of the ? conditional-operator." is incorrectly interpreted by current BreakIterator algorithm as: "Looks for occurances of the ?" followed by "conditional-operator."

It would be useful if there was a way to insert explicit sentence startpoint/endpoint markers in these cases to override the default algorithm.

JUSTIFICATION :
Presently, there is no way to construct single sentences that contain one of the sequences of characters that are interpreted to be sentence-boundary markers.

EXPECTED VERSUS ACTUAL BEHAVIOR :
EXPECTED -
It would be convienient if there was a method to explicitly define where the sentence boundaries are by inserting markers in the source-code.

One way might be to allow a construct similar to:
"<sentence>Looks for occurances of the ? conditional-operator.</sentence>"

This construct would tell Javadoc to override its default sentence-boundary algorithm and use the sentence boundary points explictly defined in the source-code.
ACTUAL -
Sentence boundaries can only be detected through the default algorithm. There is no way to override its behavior.

---------- BEGIN SOURCE ----------
class Test {
/**
  * Looks for occurances of the ? conditional-operator.
  */
public static void findConditionalOperator() {
     // ...
}
}
---------- END SOURCE ----------
(Incident Review ID: 209127) 
======================================================================
Work Around
N/A
Evaluation
N/A
Comments
  
  Include a link with my name & email   


PLEASE NOTE: JDK6 is formerly known as Project Mustang