| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!--NewPage--> |
| <HTML> |
| <HEAD> |
| <!-- Generated by javadoc (build 1.5.0_12) on Fri May 30 11:15:56 CDT 2008 --> |
| <TITLE> |
| JSdoc |
| </TITLE> |
| |
| <META NAME="keywords" CONTENT="org.eclipse.wst.jsdt.core.dom.JSdoc class"> |
| |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../../stylesheet.css" TITLE="Style"> |
| |
| <SCRIPT type="text/javascript"> |
| function windowTitle() |
| { |
| parent.document.title="JSdoc"; |
| } |
| </SCRIPT> |
| <NOSCRIPT> |
| </NOSCRIPT> |
| |
| </HEAD> |
| |
| <BODY BGCOLOR="white" onload="windowTitle();"> |
| |
| |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <A NAME="navbar_top"><!-- --></A> |
| <A HREF="#skip-navbar_top" title="Skip navigation links"></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
| <TR> |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_top_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
| <TR ALIGN="center" VALIGN="top"> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/JSdoc.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/JavaScriptUnit.html" title="class in org.eclipse.wst.jsdt.core.dom"><B>PREV CLASS</B></A> |
| <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/LabeledStatement.html" title="class in org.eclipse.wst.jsdt.core.dom"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../../index.html?org/eclipse/wst/jsdt/core/dom/JSdoc.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="JSdoc.html" target="_top"><B>NO FRAMES</B></A> |
| <SCRIPT type="text/javascript"> |
| <!-- |
| if(window==top) { |
| document.writeln('<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); |
| } |
| //--> |
| </SCRIPT> |
| <NOSCRIPT> |
| <A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A> |
| </NOSCRIPT> |
| |
| |
| </FONT></TD> |
| </TR> |
| <TR> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: <A HREF="#field_detail">FIELD</A> | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_top"></A> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| |
| <HR> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <H2> |
| <FONT SIZE="-1"> |
| org.eclipse.wst.jsdt.core.dom</FONT> |
| <BR> |
| Class JSdoc</H2> |
| <PRE> |
| java.lang.Object |
| <IMG SRC="../../../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ASTNode.html" title="class in org.eclipse.wst.jsdt.core.dom">org.eclipse.wst.jsdt.core.dom.ASTNode</A> |
| <IMG SRC="../../../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/Comment.html" title="class in org.eclipse.wst.jsdt.core.dom">org.eclipse.wst.jsdt.core.dom.Comment</A> |
| <IMG SRC="../../../../../../resources/inherit.gif" ALT="extended by "><B>org.eclipse.wst.jsdt.core.dom.JSdoc</B> |
| </PRE> |
| <HR> |
| <DL> |
| <DT><PRE>public class <B>JSdoc</B><DT>extends <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/Comment.html" title="class in org.eclipse.wst.jsdt.core.dom">Comment</A></DL> |
| </PRE> |
| |
| <P> |
| AST node for a Javadoc-style doc comment. |
| <pre> |
| Javadoc: |
| <b>/** </b> { TagElement } <b>*</b><b>/</b> |
| </pre> |
| |
| Provisional API: This class/interface is part of an interim API that is still under development and expected to |
| change significantly before reaching stability. It is being made available at this early stage to solicit feedback |
| from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken |
| (repeatedly) as the API evolves. |
| <P> |
| |
| <P> |
| <HR> |
| |
| <P> |
| <!-- =========== FIELD SUMMARY =========== --> |
| |
| <A NAME="field_summary"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
| <B>Field Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/SimplePropertyDescriptor.html" title="class in org.eclipse.wst.jsdt.core.dom">SimplePropertyDescriptor</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/JSdoc.html#COMMENT_PROPERTY">COMMENT_PROPERTY</A></B></CODE> |
| |
| <BR> |
| <B>Deprecated.</B> <I>Replaced by <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/JSdoc.html#TAGS_PROPERTY"><CODE>TAGS_PROPERTY</CODE></A> in the JLS3 API.</I></TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ChildListPropertyDescriptor.html" title="class in org.eclipse.wst.jsdt.core.dom">ChildListPropertyDescriptor</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/JSdoc.html#TAGS_PROPERTY">TAGS_PROPERTY</A></B></CODE> |
| |
| <BR> |
| The "tags" structural property of this node type.</TD> |
| </TR> |
| </TABLE> |
| <A NAME="fields_inherited_from_class_org.eclipse.wst.jsdt.core.dom.ASTNode"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>Fields inherited from class org.eclipse.wst.jsdt.core.dom.<A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ASTNode.html" title="class in org.eclipse.wst.jsdt.core.dom">ASTNode</A></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ASTNode.html#ANONYMOUS_CLASS_DECLARATION">ANONYMOUS_CLASS_DECLARATION</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ASTNode.html#ARRAY_ACCESS">ARRAY_ACCESS</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ASTNode.html#ARRAY_CREATION">ARRAY_CREATION</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ASTNode.html#ARRAY_INITIALIZER">ARRAY_INITIALIZER</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ASTNode.html#ARRAY_TYPE">ARRAY_TYPE</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ASTNode.html#ASSERT_STATEMENT">ASSERT_STATEMENT</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ASTNode.html#ASSIGNMENT">ASSIGNMENT</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ASTNode.html#BLOCK">BLOCK</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ASTNode.html#BLOCK_COMMENT">BLOCK_COMMENT</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ASTNode.html#BOOLEAN_LITERAL">BOOLEAN_LITERAL</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ASTNode.html#BREAK_STATEMENT">BREAK_STATEMENT</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ASTNode.html#CAST_EXPRESSION">CAST_EXPRESSION</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ASTNode.html#CATCH_CLAUSE">CATCH_CLAUSE</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ASTNode.html#CHARACTER_LITERAL">CHARACTER_LITERAL</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ASTNode.html#CLASS_INSTANCE_CREATION">CLASS_INSTANCE_CREATION</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ASTNode.html#CONDITIONAL_EXPRESSION">CONDITIONAL_EXPRESSION</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ASTNode.html#CONSTRUCTOR_INVOCATION">CONSTRUCTOR_INVOCATION</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ASTNode.html#CONTINUE_STATEMENT">CONTINUE_STATEMENT</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ASTNode.html#DO_STATEMENT">DO_STATEMENT</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ASTNode.html#EMPTY_EXPRESSION">EMPTY_EXPRESSION</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ASTNode.html#EMPTY_STATEMENT">EMPTY_STATEMENT</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ASTNode.html#ENHANCED_FOR_STATEMENT">ENHANCED_FOR_STATEMENT</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ASTNode.html#EXPRESSION_STATEMENT">EXPRESSION_STATEMENT</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ASTNode.html#FIELD_ACCESS">FIELD_ACCESS</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ASTNode.html#FIELD_DECLARATION">FIELD_DECLARATION</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ASTNode.html#FOR_IN_STATEMENT">FOR_IN_STATEMENT</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ASTNode.html#FOR_STATEMENT">FOR_STATEMENT</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ASTNode.html#FUNCTION_DECLARATION">FUNCTION_DECLARATION</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ASTNode.html#FUNCTION_EXPRESSION">FUNCTION_EXPRESSION</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ASTNode.html#FUNCTION_INVOCATION">FUNCTION_INVOCATION</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ASTNode.html#FUNCTION_REF">FUNCTION_REF</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ASTNode.html#FUNCTION_REF_PARAMETER">FUNCTION_REF_PARAMETER</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ASTNode.html#IF_STATEMENT">IF_STATEMENT</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ASTNode.html#IMPORT_DECLARATION">IMPORT_DECLARATION</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ASTNode.html#INFERRED_TYPE">INFERRED_TYPE</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ASTNode.html#INFIX_EXPRESSION">INFIX_EXPRESSION</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ASTNode.html#INITIALIZER">INITIALIZER</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ASTNode.html#INSTANCEOF_EXPRESSION">INSTANCEOF_EXPRESSION</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ASTNode.html#JAVASCRIPT_UNIT">JAVASCRIPT_UNIT</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ASTNode.html#JSDOC">JSDOC</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ASTNode.html#LABELED_STATEMENT">LABELED_STATEMENT</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ASTNode.html#LINE_COMMENT">LINE_COMMENT</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ASTNode.html#LIST_EXPRESSION">LIST_EXPRESSION</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ASTNode.html#MALFORMED">MALFORMED</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ASTNode.html#MEMBER_REF">MEMBER_REF</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ASTNode.html#MODIFIER">MODIFIER</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ASTNode.html#NULL_LITERAL">NULL_LITERAL</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ASTNode.html#NUMBER_LITERAL">NUMBER_LITERAL</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ASTNode.html#OBJECT_LITERAL">OBJECT_LITERAL</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ASTNode.html#OBJECT_LITERAL_FIELD">OBJECT_LITERAL_FIELD</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ASTNode.html#ORIGINAL">ORIGINAL</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ASTNode.html#PACKAGE_DECLARATION">PACKAGE_DECLARATION</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ASTNode.html#PARAMETERIZED_TYPE">PARAMETERIZED_TYPE</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ASTNode.html#PARENTHESIZED_EXPRESSION">PARENTHESIZED_EXPRESSION</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ASTNode.html#POSTFIX_EXPRESSION">POSTFIX_EXPRESSION</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ASTNode.html#PREFIX_EXPRESSION">PREFIX_EXPRESSION</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ASTNode.html#PRIMITIVE_TYPE">PRIMITIVE_TYPE</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ASTNode.html#PROTECT">PROTECT</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ASTNode.html#QUALIFIED_NAME">QUALIFIED_NAME</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ASTNode.html#QUALIFIED_TYPE">QUALIFIED_TYPE</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ASTNode.html#RECOVERED">RECOVERED</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ASTNode.html#REGULAR_EXPRESSION_LITERAL">REGULAR_EXPRESSION_LITERAL</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ASTNode.html#RETURN_STATEMENT">RETURN_STATEMENT</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ASTNode.html#SIMPLE_NAME">SIMPLE_NAME</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ASTNode.html#SIMPLE_TYPE">SIMPLE_TYPE</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ASTNode.html#SINGLE_VARIABLE_DECLARATION">SINGLE_VARIABLE_DECLARATION</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ASTNode.html#STRING_LITERAL">STRING_LITERAL</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ASTNode.html#SUPER_CONSTRUCTOR_INVOCATION">SUPER_CONSTRUCTOR_INVOCATION</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ASTNode.html#SUPER_FIELD_ACCESS">SUPER_FIELD_ACCESS</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ASTNode.html#SUPER_METHOD_INVOCATION">SUPER_METHOD_INVOCATION</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ASTNode.html#SWITCH_CASE">SWITCH_CASE</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ASTNode.html#SWITCH_STATEMENT">SWITCH_STATEMENT</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ASTNode.html#TAG_ELEMENT">TAG_ELEMENT</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ASTNode.html#TEXT_ELEMENT">TEXT_ELEMENT</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ASTNode.html#THIS_EXPRESSION">THIS_EXPRESSION</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ASTNode.html#THROW_STATEMENT">THROW_STATEMENT</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ASTNode.html#TRY_STATEMENT">TRY_STATEMENT</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ASTNode.html#TYPE_DECLARATION">TYPE_DECLARATION</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ASTNode.html#TYPE_DECLARATION_STATEMENT">TYPE_DECLARATION_STATEMENT</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ASTNode.html#TYPE_LITERAL">TYPE_LITERAL</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ASTNode.html#TYPE_PARAMETER">TYPE_PARAMETER</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ASTNode.html#UNDEFINED_LITERAL">UNDEFINED_LITERAL</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ASTNode.html#VARIABLE_DECLARATION_EXPRESSION">VARIABLE_DECLARATION_EXPRESSION</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ASTNode.html#VARIABLE_DECLARATION_FRAGMENT">VARIABLE_DECLARATION_FRAGMENT</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ASTNode.html#VARIABLE_DECLARATION_STATEMENT">VARIABLE_DECLARATION_STATEMENT</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ASTNode.html#WHILE_STATEMENT">WHILE_STATEMENT</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ASTNode.html#WILDCARD_TYPE">WILDCARD_TYPE</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ASTNode.html#WITH_STATEMENT">WITH_STATEMENT</A></CODE></TD> |
| </TR> |
| </TABLE> |
| |
| <!-- ========== METHOD SUMMARY =========== --> |
| |
| <A NAME="method_summary"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
| <B>Method Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/JSdoc.html#getComment()">getComment</A></B>()</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> <I>The comment string was replaced in the 3.0 release |
| by a representation of the structure of the doc comment. |
| See <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/JSdoc.html#tags()"><CODE>tags</CODE></A>.</I></TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static java.util.List</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/JSdoc.html#propertyDescriptors(int)">propertyDescriptors</A></B>(int apiLevel)</CODE> |
| |
| <BR> |
| Returns a list of structural property descriptors for this node type.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/JSdoc.html#setComment(java.lang.String)">setComment</A></B>(java.lang.String docComment)</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> <I>The comment string was replaced in the 3.0 release |
| by a representation of the structure of the doc comment. |
| See <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/JSdoc.html#tags()"><CODE>tags</CODE></A>.</I></TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.util.List</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/JSdoc.html#tags()">tags</A></B>()</CODE> |
| |
| <BR> |
| Returns the live list of tag elements that make up this doc |
| comment.</TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_org.eclipse.wst.jsdt.core.dom.Comment"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>Methods inherited from class org.eclipse.wst.jsdt.core.dom.<A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/Comment.html" title="class in org.eclipse.wst.jsdt.core.dom">Comment</A></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/Comment.html#getAlternateRoot()">getAlternateRoot</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/Comment.html#isBlockComment()">isBlockComment</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/Comment.html#isDocComment()">isDocComment</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/Comment.html#isLineComment()">isLineComment</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/Comment.html#setAlternateRoot(org.eclipse.wst.jsdt.core.dom.ASTNode)">setAlternateRoot</A></CODE></TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_org.eclipse.wst.jsdt.core.dom.ASTNode"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>Methods inherited from class org.eclipse.wst.jsdt.core.dom.<A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ASTNode.html" title="class in org.eclipse.wst.jsdt.core.dom">ASTNode</A></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ASTNode.html#accept(org.eclipse.wst.jsdt.core.dom.ASTVisitor)">accept</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ASTNode.html#copySubtree(org.eclipse.wst.jsdt.core.dom.AST, org.eclipse.wst.jsdt.core.dom.ASTNode)">copySubtree</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ASTNode.html#copySubtrees(org.eclipse.wst.jsdt.core.dom.AST, java.util.List)">copySubtrees</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ASTNode.html#delete()">delete</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ASTNode.html#equals(java.lang.Object)">equals</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ASTNode.html#getAST()">getAST</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ASTNode.html#getFlags()">getFlags</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ASTNode.html#getLength()">getLength</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ASTNode.html#getLocationInParent()">getLocationInParent</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ASTNode.html#getNodeType()">getNodeType</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ASTNode.html#getParent()">getParent</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ASTNode.html#getProperty(java.lang.String)">getProperty</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ASTNode.html#getRoot()">getRoot</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ASTNode.html#getStartPosition()">getStartPosition</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ASTNode.html#getStructuralProperty(org.eclipse.wst.jsdt.core.dom.StructuralPropertyDescriptor)">getStructuralProperty</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ASTNode.html#hashCode()">hashCode</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ASTNode.html#nodeClassForType(int)">nodeClassForType</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ASTNode.html#properties()">properties</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ASTNode.html#setFlags(int)">setFlags</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ASTNode.html#setProperty(java.lang.String, java.lang.Object)">setProperty</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ASTNode.html#setSourceRange(int, int)">setSourceRange</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ASTNode.html#setStructuralProperty(org.eclipse.wst.jsdt.core.dom.StructuralPropertyDescriptor, java.lang.Object)">setStructuralProperty</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ASTNode.html#structuralPropertiesForType()">structuralPropertiesForType</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ASTNode.html#subtreeBytes()">subtreeBytes</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ASTNode.html#subtreeMatch(org.eclipse.wst.jsdt.core.dom.ASTMatcher, java.lang.Object)">subtreeMatch</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ASTNode.html#toString()">toString</A></CODE></TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE>getClass, notify, notifyAll, wait, wait, wait</CODE></TD> |
| </TR> |
| </TABLE> |
| |
| <P> |
| |
| <!-- ============ FIELD DETAIL =========== --> |
| |
| <A NAME="field_detail"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
| <B>Field Detail</B></FONT></TH> |
| </TR> |
| </TABLE> |
| |
| <A NAME="COMMENT_PROPERTY"><!-- --></A><H3> |
| COMMENT_PROPERTY</H3> |
| <PRE> |
| public static final <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/SimplePropertyDescriptor.html" title="class in org.eclipse.wst.jsdt.core.dom">SimplePropertyDescriptor</A> <B>COMMENT_PROPERTY</B></PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <I>Replaced by <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/JSdoc.html#TAGS_PROPERTY"><CODE>TAGS_PROPERTY</CODE></A> in the JLS3 API.</I><DD>The "comment" structural property of this node type (JLS2 API only). |
| <P> |
| <DL> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="TAGS_PROPERTY"><!-- --></A><H3> |
| TAGS_PROPERTY</H3> |
| <PRE> |
| public static final <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ChildListPropertyDescriptor.html" title="class in org.eclipse.wst.jsdt.core.dom">ChildListPropertyDescriptor</A> <B>TAGS_PROPERTY</B></PRE> |
| <DL> |
| <DD>The "tags" structural property of this node type. |
| <P> |
| <DL> |
| </DL> |
| </DL> |
| |
| <!-- ============ METHOD DETAIL ========== --> |
| |
| <A NAME="method_detail"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
| <B>Method Detail</B></FONT></TH> |
| </TR> |
| </TABLE> |
| |
| <A NAME="propertyDescriptors(int)"><!-- --></A><H3> |
| propertyDescriptors</H3> |
| <PRE> |
| public static java.util.List <B>propertyDescriptors</B>(int apiLevel)</PRE> |
| <DL> |
| <DD>Returns a list of structural property descriptors for this node type. |
| Clients must not modify the result. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>apiLevel</CODE> - the API level; one of the |
| <code>AST.JLS*</code> constants |
| <DT><B>Returns:</B><DD>a list of property descriptors (element type: |
| <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/StructuralPropertyDescriptor.html" title="class in org.eclipse.wst.jsdt.core.dom"><CODE>StructuralPropertyDescriptor</CODE></A>)</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getComment()"><!-- --></A><H3> |
| getComment</H3> |
| <PRE> |
| public java.lang.String <B>getComment</B>()</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <I>The comment string was replaced in the 3.0 release |
| by a representation of the structure of the doc comment. |
| See <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/JSdoc.html#tags()"><CODE>tags</CODE></A>.</I> |
| <P> |
| <DD>Returns the doc comment string, including the starting |
| and ending comment delimiters, and any embedded line breaks. |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the doc comment string |
| <DT><B>Throws:</B> |
| <DD><CODE>java.lang.UnsupportedOperationException</CODE> - if this operation is used in |
| an AST later than JLS2</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setComment(java.lang.String)"><!-- --></A><H3> |
| setComment</H3> |
| <PRE> |
| public void <B>setComment</B>(java.lang.String docComment)</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <I>The comment string was replaced in the 3.0 release |
| by a representation of the structure of the doc comment. |
| See <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/JSdoc.html#tags()"><CODE>tags</CODE></A>.</I> |
| <P> |
| <DD>Sets or clears the doc comment string. The documentation |
| string must include the starting and ending comment delimiters, |
| and any embedded line breaks. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>docComment</CODE> - the doc comment string |
| <DT><B>Throws:</B> |
| <DD><CODE>java.lang.IllegalArgumentException</CODE> - if the JavaScript comment string is invalid |
| <DD><CODE>java.lang.UnsupportedOperationException</CODE> - if this operation is used in |
| an AST later than JLS2</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="tags()"><!-- --></A><H3> |
| tags</H3> |
| <PRE> |
| public java.util.List <B>tags</B>()</PRE> |
| <DL> |
| <DD>Returns the live list of tag elements that make up this doc |
| comment. |
| <p> |
| 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 <code>null</code> tag name and |
| generally contains 1 or more <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/TextElement.html" title="class in org.eclipse.wst.jsdt.core.dom"><CODE>TextElement</CODE></A>s, |
| and possibly interspersed with tag elements for nested tags |
| like "<CODE>String</CODE>". |
| Subsequent tag elements represent successive top-level doc |
| tag (e.g., "@param", "@return", "@see"). |
| </p> |
| <p> |
| Adding and removing nodes from this list affects this node |
| dynamically. |
| </p> |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the live list of tag elements in this doc comment |
| (element type: <code>TagElement</code>)</DL> |
| </DD> |
| </DL> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <HR> |
| |
| |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <A NAME="navbar_bottom"><!-- --></A> |
| <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
| <TR> |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_bottom_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
| <TR ALIGN="center" VALIGN="top"> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/JSdoc.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/JavaScriptUnit.html" title="class in org.eclipse.wst.jsdt.core.dom"><B>PREV CLASS</B></A> |
| <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/LabeledStatement.html" title="class in org.eclipse.wst.jsdt.core.dom"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../../index.html?org/eclipse/wst/jsdt/core/dom/JSdoc.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="JSdoc.html" target="_top"><B>NO FRAMES</B></A> |
| <SCRIPT type="text/javascript"> |
| <!-- |
| if(window==top) { |
| document.writeln('<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); |
| } |
| //--> |
| </SCRIPT> |
| <NOSCRIPT> |
| <A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A> |
| </NOSCRIPT> |
| |
| |
| </FONT></TD> |
| </TR> |
| <TR> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: <A HREF="#field_detail">FIELD</A> | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_bottom"></A> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| |
| <HR> |
| |
| </BODY> |
| </HTML> |
