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: 6558804
Votes 1
Synopsis Specification for Elements.getDocComment(Element e) should be clarified
Category java:classes_lang_model
Reported Against 1.6
Release Fixed 7(b75)
State 10-Fix Delivered, request for enhancement
Priority: 4-Low
Related Bugs
Submit Date 17-MAY-2007
Description
The spec on the method javax.lang.model.util.Elements.getDocComment(Element e) should refer to the normative definition of the text of a documentation comment.
Posted Date : 2007-05-17 15:03:36.0
Work Around
N/A
Evaluation
>I tried to find a definition of  "the text of a documentation comment" 
>term in normative Java SE platform specs, but  found it only in the old 
>JLS 1-ed  18.1 "The Text of a Documentation Comment" 
>(http://java.sun.com/docs/books/jls/first_edition/html/18.doc.html).

The intention is that Elements.getDocComment follow the above
definition of "documentation comment".  This definition is also given,
somewhat sloppily, in the javadoc reference page at
http://java.sun.com/javase/6/docs/technotes/tools/solaris/javadoc.html.
Since the definition is not part of later JLS versions the situation
obviously isn't ideal.  In the jdk 7 time frame we plan to take the
definition from JLS 1 and make it "offical" though JSR 260.  We should
then update the Elements.getDocComment spec to refer to this new spec,
to remove all ambiguity.

*** (#1 of 1): [ UNSAVED ]   xxxxx@xxxxx  
Posted Date : 2007-05-17 16:21:48.0
Comments
  
  Include a link with my name & email   


PLEASE NOTE: JDK6 is formerly known as Project Mustang