Follow Techotopia on Twitter

On-line Guides
All Guides
eBook Store
iOS / Android
Linux for Beginners
Office Productivity
Linux Installation
Linux Security
Linux Utilities
Linux Virtualization
Linux Kernel
System/Network Admin
Programming
Scripting Languages
Development Tools
Web Development
GUI Toolkits/Desktop
Databases
Mail Systems
openSolaris
Eclipse Documentation
Techotopia.com
Virtuatopia.com

How To Guides
Virtualization
General System Admin
Linux Security
Linux Filesystems
Web Servers
Graphics & Desktop
PC Hardware
Windows
Problem Solutions
Privacy Policy

  




 

 


Eclipse JDT
Release 3.5

org.eclipse.jdt.core.dom
Class Javadoc

java.lang.Object
  extended by 

org.eclipse.jdt.core.dom.ASTNode
      extended by 

org.eclipse.jdt.core.dom.Comment
          extended by 
org.eclipse.jdt.core.dom.Javadoc

public class Javadoc
extends Comment

AST node for a Javadoc-style doc comment.

 Javadoc:
   /**  { TagElement } *
/
 

Since:
2.0
Restriction:
This class is not intended to be instantiated by clients.

Field Summary
static  SimplePropertyDescriptor COMMENT_PROPERTY
          Deprecated. Replaced by TAGS_PROPERTY in the JLS3 API.
static  ChildListPropertyDescriptor TAGS_PROPERTY
          The "tags" structural property of this node type.
 
Fields inherited from class org.eclipse.jdt.core.dom. ASTNode
ANNOTATION_TYPE_DECLARATION, ANNOTATION_TYPE_MEMBER_DECLARATION, ANONYMOUS_CLASS_DECLARATION, ARRAY_ACCESS, ARRAY_CREATION, ARRAY_INITIALIZER, ARRAY_TYPE, ASSERT_STATEMENT, ASSIGNMENT, BLOCK, BLOCK_COMMENT, BOOLEAN_LITERAL, BREAK_STATEMENT, CAST_EXPRESSION, CATCH_CLAUSE, CHARACTER_LITERAL, CLASS_INSTANCE_CREATION, COMPILATION_UNIT, CONDITIONAL_EXPRESSION, CONSTRUCTOR_INVOCATION, CONTINUE_STATEMENT, DO_STATEMENT, EMPTY_STATEMENT, ENHANCED_FOR_STATEMENT, ENUM_CONSTANT_DECLARATION, ENUM_DECLARATION, EXPRESSION_STATEMENT, FIELD_ACCESS, FIELD_DECLARATION, FOR_STATEMENT, IF_STATEMENT, IMPORT_DECLARATION, INFIX_EXPRESSION, INITIALIZER, INSTANCEOF_EXPRESSION, JAVADOC, LABELED_STATEMENT, LINE_COMMENT, MALFORMED, MARKER_ANNOTATION, MEMBER_REF, MEMBER_VALUE_PAIR, METHOD_DECLARATION, METHOD_INVOCATION, METHOD_REF, METHOD_REF_PARAMETER, MODIFIER, NORMAL_ANNOTATION, NULL_LITERAL, NUMBER_LITERAL, ORIGINAL, PACKAGE_DECLARATION, PARAMETERIZED_TYPE, PARENTHESIZED_EXPRESSION, POSTFIX_EXPRESSION, PREFIX_EXPRESSION, PRIMITIVE_TYPE, PROTECT, QUALIFIED_NAME, QUALIFIED_TYPE, RECOVERED, RETURN_STATEMENT, SIMPLE_NAME, SIMPLE_TYPE, SINGLE_MEMBER_ANNOTATION, SINGLE_VARIABLE_DECLARATION, STRING_LITERAL, SUPER_CONSTRUCTOR_INVOCATION, SUPER_FIELD_ACCESS, SUPER_METHOD_INVOCATION, SWITCH_CASE, SWITCH_STATEMENT, SYNCHRONIZED_STATEMENT, TAG_ELEMENT, TEXT_ELEMENT, THIS_EXPRESSION, THROW_STATEMENT, TRY_STATEMENT, TYPE_DECLARATION, TYPE_DECLARATION_STATEMENT, TYPE_LITERAL, TYPE_PARAMETER, VARIABLE_DECLARATION_EXPRESSION, VARIABLE_DECLARATION_FRAGMENT, VARIABLE_DECLARATION_STATEMENT, WHILE_STATEMENT, WILDCARD_TYPE
 
Method Summary
  String getComment ()
          Deprecated. The comment string was replaced in the 3.0 release by a representation of the structure of the doc comment. See tags.
static  List propertyDescriptors (int apiLevel)
          Returns a list of structural property descriptors for this node type.
 void setComment ( String docComment)
          Deprecated. The comment string was replaced in the 3.0 release by a representation of the structure of the doc comment. See tags.
  List tags ()
          Returns the live list of tag elements that make up this doc comment.
 
Methods inherited from class org.eclipse.jdt.core.dom. Comment
getAlternateRoot, isBlockComment, isDocComment, isLineComment, setAlternateRoot
 
Methods inherited from class org.eclipse.jdt.core.dom. ASTNode
accept, copySubtree, copySubtrees, delete, equals, getAST, getFlags, getLength, getLocationInParent, getNodeType, getParent, getProperty, getRoot, getStartPosition, getStructuralProperty, hashCode, nodeClassForType, properties, setFlags, setProperty, setSourceRange, setStructuralProperty, structuralPropertiesForType, subtreeBytes, subtreeMatch, toString
 
Methods inherited from class java.lang. Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

COMMENT_PROPERTY

public static final 
SimplePropertyDescriptor COMMENT_PROPERTY
Deprecated. Replaced by TAGS_PROPERTY in the JLS3 API.
The "comment" structural property of this node type (JLS2 API only).

Since:
3.0

TAGS_PROPERTY

public static final 
ChildListPropertyDescriptor TAGS_PROPERTY
The "tags" structural property of this node type.

Since:
3.1
Method Detail

propertyDescriptors

public static 
List propertyDescriptors(int apiLevel)
Returns a list of structural property descriptors for this node type. Clients must not modify the result.

Parameters:
apiLevel - the API level; one of the AST.JLS* constants
Returns:
a list of property descriptors (element type: StructuralPropertyDescriptor)
Since:
3.0

getComment

public 
String getComment()
Deprecated. The comment string was replaced in the 3.0 release by a representation of the structure of the doc comment. See tags.

Returns the doc comment string, including the starting and ending comment delimiters, and any embedded line breaks.

Returns:
the doc comment string
Throws:
UnsupportedOperationException - if this operation is used in an AST later than JLS2

setComment

public void setComment(
String docComment)
Deprecated. The comment string was replaced in the 3.0 release by a representation of the structure of the doc comment. See tags.

Sets or clears the doc comment string. The documentation string must include the starting and ending comment delimiters, and any embedded line breaks.

Parameters:
docComment - the doc comment string
Throws:
IllegalArgumentException - if the Java comment string is invalid
UnsupportedOperationException - if this operation is used in an AST later than JLS2

tags

public 
List tags()
Returns the live list of tag elements that make up this doc comment.

The tag elements cover everything except the starting and ending comment delimiters, and generally omit leading whitespace (including a leading "*") and embedded line breaks. The first tag element of a typical doc comment represents all the material before the first explicit doc tag; this first tag element has a null tag name and generally contains 1 or more TextElements, and possibly interspersed with tag elements for nested tags like " String ". Subsequent tag elements represent successive top-level doc tag (e.g., "@param", "@return", "@see").

Adding and removing nodes from this list affects this node dynamically.

Returns:
the live list of tag elements in this doc comment (element type: TagElement)
Since:
3.0

Eclipse JDT
Release 3.5

Copyright (c) IBM Corp. and others 2000, 2008. All Rights Reserved.

 
 
  Published under the terms of the Eclipse Public License Version 1.0 ("EPL") Design by Interspire