From 500f2faa39349a461dcdf14657541f40b6a1a65c Mon Sep 17 00:00:00 2001
From: Konrad Windszus <kwin@apache.org>
Date: Mon, 12 Sep 2022 19:53:07 +0200
Subject: [PATCH] clarify getComment() javadoc with regards to Standard doclet
 inline and block tags

This closes #102
---
 .../com/thoughtworks/qdox/model/JavaAnnotatedElement.java     | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/src/main/java/com/thoughtworks/qdox/model/JavaAnnotatedElement.java b/src/main/java/com/thoughtworks/qdox/model/JavaAnnotatedElement.java
index 3ed8b6fe..dac89a6f 100644
--- a/src/main/java/com/thoughtworks/qdox/model/JavaAnnotatedElement.java
+++ b/src/main/java/com/thoughtworks/qdox/model/JavaAnnotatedElement.java
@@ -50,7 +50,9 @@ public interface JavaAnnotatedElement extends JavaModel
     
     /**
      * Retrieve the javadoc comment of this annotated element.
-     * This is the part between &#47;&#42;&#42; and the &#42;&#47;, 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>
      */