DocTagT

Overview

Package

Class

Use

Deprecated

Index

Home >> All >> javax >> ide >> model >> java >> source >> [ tree overview ]

PREV CLASS NEXT CLASS

SUMMARY:

JAVADOC |

SOURCE |

DOWNLOAD | NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

javax.ide.model.java.source.tree
Interface DocTagT

All Superinterfaces:: DocElementT, HasNameT, Tree

public interface DocTagT
extends DocElementT, HasNameT

A tag within a doc comment. Unlike com.sun.javadoc.Tag, a DocTagT does not represent text. A DocTagT only represents words prefixed with a leading that follow the javadoc rules, i.e. a block tag starts on its own line and an inline tag is prefixed with '.

The doc tag name are composed of a leading followed by a qualified name where, unlike in Java, '-' in considered to be part of a tag identifier.

"Standard tag" means a tag defined by the standard doclet.

Field Summary

static DocTagT[] EMPTY_ARRAY


Method Summary

DocCommentT getOwningDocComment()
          Gets the doc comment which owns this doc element.

boolean isBlockTag()
          True if this is a block tag.

boolean isInlineTag()
          True if this is an inline tag.

boolean isStandardTag()
          True if this is a standard tag.

Methods inherited from interface javax.ide.model.java.source.tree.DocElementT

getCommentText, getOwningDeclaration, getRawCommentText, getTags, getTags

Methods inherited from interface javax.ide.model.java.source.tree.Tree

accept, accept, addSelf, addSelf, addSelfAfter, addSelfBefore, clearProperty, cloneSelf, getChildren, getOwningFile, getParent, getPosition, getProperty, getSiblingAfter, getSiblingBefore, getSiblings, getTreeKind, isSynthetic, removeSelf, replaceSelf, setProperty

Methods inherited from interface javax.ide.model.java.source.tree.HasNameT

getName, getNameElement, setName, setNameElement

Field Detail

EMPTY_ARRAY

public static final DocTagT[] EMPTY_ARRAY

Method Detail

getOwningDocComment

public DocCommentT getOwningDocComment()

Gets the doc comment which owns this doc element.

isBlockTag

public boolean isBlockTag()

True if this is a block tag.

isInlineTag

public boolean isInlineTag()

True if this is an inline tag.

isStandardTag

public boolean isStandardTag()

True if this is a standard tag.