75 |
75 |
76 /** |
76 /** |
77 * Returns the text of the documentation ("Javadoc") |
77 * Returns the text of the documentation ("Javadoc") |
78 * comment of an element. |
78 * comment of an element. |
79 * |
79 * |
|
80 * <p> A documentation comment of an element is a comment that |
|
81 * begins with "{@code /**}" , ends with a separate |
|
82 * "<code>*/</code>", and immediately precedes the element, |
|
83 * ignoring white space. Therefore, a documentation comment |
|
84 * contains at least three"{@code *}" characters. The text |
|
85 * returned for the documentation comment is a processed form of |
|
86 * the comment as it appears in source code. The leading "{@code |
|
87 * /**}" and trailing "<code>*/</code>" are removed. For lines |
|
88 * of the comment starting after the initial "{@code /**}", |
|
89 * leading white space characters are discarded as are any |
|
90 * consecutive "{@code *}" characters appearing after the white |
|
91 * space or starting the line. The processed lines are then |
|
92 * concatenated together (including line terminators) and |
|
93 * returned. |
|
94 * |
80 * @param e the element being examined |
95 * @param e the element being examined |
81 * @return the documentation comment of the element, or {@code null} |
96 * @return the documentation comment of the element, or {@code null} |
82 * if there is none |
97 * if there is none |
|
98 * @jls3 3.6 White Space |
83 */ |
99 */ |
84 String getDocComment(Element e); |
100 String getDocComment(Element e); |
85 |
101 |
86 /** |
102 /** |
87 * Returns {@code true} if the element is deprecated, {@code false} otherwise. |
103 * Returns {@code true} if the element is deprecated, {@code false} otherwise. |