Source code: javax/ide/model/java/source/tree/DocCommentT.java
1 /*
2 * @(#)DocCommentT.java
3 */
4
5 package javax.ide.model.java.source.tree;
6
7 import java.util.Collection;
8 import java.util.List;
9
10 /**
11 * A doc comment (short for "documentation comment"). Corresponds to
12 * com.sun.javadoc.Doc in the Doclet API. Named DocCommentT to avoid
13 * confusion with the other convention of ExpressionT and StatementT
14 * that indicate common supertypes because the DocCommentT is not a
15 * common supertype.
16 *
17 * @see DocTagT
18 *
19 * @author ltribble
20 */
21 public interface DocCommentT
22 extends DocElementT
23 {
24 // ----------------------------------------------------------------------
25
26 /**
27 * Gets the list of block tags in this doc comment.
28 *
29 * @return The list of contained block tags. <p/>
30 *
31 * List of DocTagTs.
32 */
33 public List getBlockTags();
34
35 /**
36 * Gets the collection of inline tags in this doc comment.
37 *
38 * @return The collection of contained inline tags. <p/>
39 *
40 * List of DocTagTs.
41 */
42 public Collection getInlineTags();
43 }