infernap12/jdk
1
0
Fork 0
mirror of https://github.com/openjdk/jdk.git synced 2026-02-11 19:08:23 +00:00
Code Issues Packages Projects Releases Wiki Activity

6558804: Specification for Elements.getDocComment(Element e) should be clarified

Browse Source 
Reviewed-by: jjg
This commit is contained in:
Joe Darcy 2009-10-14 18:56:37 -07:00
parent 44767bbfbe
commit bb0ea6325c
1 changed files with 16 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
langtools/src/share/classes/javax/lang/model/util/Elements.java
View File

@ -77,9 +77,25 @@ public interface Elements {
* Returns the text of the documentation ("Javadoc")
* comment of an element.
*
* <p> A documentation comment of an element is a comment that
* begins with "{@code /**}" , ends with a separate
* "<code>*&#47</code>", and immediately precedes the element,
* ignoring white space. Therefore, a documentation comment
* contains at least three"{@code *}" characters. The text
* returned for the documentation comment is a processed form of
* the comment as it appears in source code. The leading "{@code
* /**}" and trailing "<code>*&#47</code>" are removed. For lines
* of the comment starting after the initial "{@code /**}",
* leading white space characters are discarded as are any
* consecutive "{@code *}" characters appearing after the white
* space or starting the line. The processed lines are then
* concatenated together (including line terminators) and
* returned.
*
* @param e the element being examined
* @return the documentation comment of the element, or {@code null}
* if there is none
* @jls3 3.6 White Space
*/
String getDocComment(Element e);