com.togethersoft.sca.ast
Interface AstJavadocTag

All Superinterfaces:

AstObject

public interface AstJavadocTag

extends AstObject

A tag that appears in a Javadoc comment. It has a name and optionally a text argument.

Fields inherited from interface com.togethersoft.sca.ast.AstObject

ARRAY_CREATION, ARRAY_INITIALIZER, ARRAY_REFERENCE, ASSERT_STATEMENT, ASSIGNMENT_EXPRESSION, BINARY_EXPRESSION, BREAK_STATEMENT, CASE_LABEL, CAST_EXPRESSION, CATCH_CLAUSE, CLASS_FILE, COMMENT, COMPILATION_UNIT, COMPOUND_STATEMENT, CONDITIONAL_EXPRESSION, CONSTRUCTOR_INVOCATION, CONTINUE_STATEMENT, DBC_RESULT, DECLARATION_STATEMENT, DO_STATEMENT, EMPTY_STATEMENT, EXPRESSION_STATEMENT, FIELD_REFERENCE, FINALLY_CLAUSE, FOR_STATEMENT, IF_STATEMENT, IMPORT, INITIALIZER, JAVADOC_TAG, LITERAL, METHOD, METHOD_CALL_EXPRESSION, N_A, OBJECT_CREATION_EXPRESSION, PACKAGE, PARENTHESIZED_EXPRESSION, RETURN_STATEMENT, SIMPLE_REFERENCE, SUPER_EXPRESSION, SWITCH_GROUP, SWITCH_STATEMENT, SYNCHRONIZED_STATEMENT, THIS_EXPRESSION, THROW_SPECIFIER, THROW_STATEMENT, TRY_STATEMENT, TYPE, TYPE_EXPRESSION, UNARY_EXPRESSION, VARIABLE, VARIABLE_DECLARATION, WHILE_STATEMENT

Method Summary

java.lang.String	getArgument() Returns the argument of this tag.
java.lang.String	getTag() Returns the name of this tag, for example "#param".

Methods inherited from interface com.togethersoft.sca.ast.AstObject

addComment, getChildren, getComments, getCompilationUnit, getDeclaringMethod, getDeclaringType, getObjectKind, getPackage, getParent, getPosition, isDeleted, remove, replaceWith, replaceWith, setPosition, setPositionAfter, visitExpressions, visitStatements

Method Detail

getArgument

public java.lang.String getArgument()

Returns the argument of this tag. Returns null, if this tag does not have an argument.

Returns:

the argument of this tag.

getTag

public java.lang.String getTag()

Returns the name of this tag, for example "#param".

Returns:

the name of this tag.