The IJavaDocComment interface represents the documentation comment for a class, field, or method.
IJavaDocComment : Idispatch
A documentation comment is delimited by /** and */ and immediately precedes the source element that it describes. For a description of the contents of documentation comments, see Chapter 18 of The Java Language Specification.
This interface defines the following members.
| Member | Description |
| Authors | Provides access to the first of @author tags in the documentation comment. |
| Description | Provides access to all text preceding the first tag in the comment. |
| Exception | Provides access to the list of @exception tags in the documentation comment. |
| Links | Provides access to the list of @see tags in the documentation comment. |
| Params | Provides access to the list of @param tags in the documentation comment. |
| RemoveTag | Deletes a tag with the given name. |
| Return | Provides access to the @return tag in the documentation comment. |
| Summary | Provides access to the summary sentence of the documentation comment. |
| TagValue | Allows read/write access to the tag with the given name. |
| Text | Provides access to the complete text of the documentation comment. |
| Version | Provides access to the @version tag in the documentation comment. |