Source code: javax/ide/model/java/source/tree/DocTagT.java
1 /*
2 * @(#)DocTagT.java
3 */
4
5 package javax.ide.model.java.source.tree;
6
7 /**
8 * A tag within a doc comment. Unlike com.sun.javadoc.Tag, a DocTagT
9 * does not represent text. A DocTagT only represents words prefixed
10 * with a leading {@literal '@'} that follow the javadoc rules, i.e. a
11 * block tag starts on its own line and an inline tag is prefixed with
12 * {@literal "{@"} and is terminated by a '}'. <p/>
13 *
14 * The doc tag name are composed of a leading {@literal '@'} followed
15 * by a qualified name where, unlike in Java, '-' in considered to be
16 * part of a tag identifier. <p/>
17 *
18 * "Standard tag" means a tag defined by the standard doclet. <p/>
19 *
20 * @author Louis Tribble, Andy Yu
21 */
22 public interface DocTagT
23 extends DocElementT, HasNameT
24 {
25 // ----------------------------------------------------------------------
26
27 public static final DocTagT[] EMPTY_ARRAY = new DocTagT[ 0 ];
28
29 /**
30 * Gets the doc comment which owns this doc element.
31 *
32 * @return The enclosing doc comment.
33 */
34 public DocCommentT getOwningDocComment();
35
36 /**
37 * True if this is a block tag.
38 *
39 * @return True if this is a block tag.
40 */
41 public boolean isBlockTag();
42
43 /**
44 * True if this is an inline tag.
45 *
46 * @return True if this is an inline tag.
47 */
48 public boolean isInlineTag();
49
50 /**
51 * True if this is a standard tag.
52 *
53 * @return True if this is a standard tag.
54 */
55 public boolean isStandardTag();
56 }