Skip to content

Commit

Permalink
clarify getComment() javadoc with regards to Standard doclet inline and
Browse files Browse the repository at this point in the history
block tags

This closes #102
  • Loading branch information
kwin committed Sep 12, 2022
1 parent c57b152 commit 500f2fa
Showing 1 changed file with 3 additions and 1 deletion.
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,9 @@ public interface JavaAnnotatedElement extends JavaModel

/**
* Retrieve the javadoc comment of this annotated element.
* This is the part between /** and the */, but without the doclet tags
* This is the part between <code>&#47;&#42;&#42;</code> and <code>&#42;&#47;</code>, but without the
* <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/javadoc/doc-comment-spec.html#block-tags">Standard doclet block tags</a>.
* It may still contain <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/javadoc/doc-comment-spec.html#inline-tags">Standard doclet inline tags</a>, though.
*
* @return the comment, otherwise <code>null</code>
*/
Expand Down

0 comments on commit 500f2fa

Please sign in to comment.