| <!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:55 CDT 2008 --> |
| <TITLE> |
| Comment |
| </TITLE> |
| |
| <META NAME="keywords" CONTENT="org.eclipse.wst.jsdt.core.dom.Comment class"> |
| |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../../stylesheet.css" TITLE="Style"> |
| |
| <SCRIPT type="text/javascript"> |
| function windowTitle() |
| { |
| parent.document.title="Comment"; |
| } |
| </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/Comment.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/ClassInstanceCreation.html" title="class in org.eclipse.wst.jsdt.core.dom"><B>PREV CLASS</B></A> |
| <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ConditionalExpression.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/Comment.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="Comment.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="#fields_inherited_from_class_org.eclipse.wst.jsdt.core.dom.ASTNode">FIELD</A> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: FIELD | 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 Comment</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 "><B>org.eclipse.wst.jsdt.core.dom.Comment</B> |
| </PRE> |
| <DL> |
| <DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/BlockComment.html" title="class in org.eclipse.wst.jsdt.core.dom">BlockComment</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/JSdoc.html" title="class in org.eclipse.wst.jsdt.core.dom">JSdoc</A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/LineComment.html" title="class in org.eclipse.wst.jsdt.core.dom">LineComment</A></DD> |
| </DL> |
| <HR> |
| <DL> |
| <DT><PRE>public abstract class <B>Comment</B><DT>extends <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ASTNode.html" title="class in org.eclipse.wst.jsdt.core.dom">ASTNode</A></DL> |
| </PRE> |
| |
| <P> |
| Abstract base class for all AST nodes that represent comments. |
| There are exactly three kinds of comment: |
| line comments (<A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/LineComment.html" title="class in org.eclipse.wst.jsdt.core.dom"><CODE>LineComment</CODE></A>), |
| block comments (<A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/BlockComment.html" title="class in org.eclipse.wst.jsdt.core.dom"><CODE>BlockComment</CODE></A>), and |
| doc comments (<A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/JSdoc.html" title="class in org.eclipse.wst.jsdt.core.dom"><CODE>JSdoc</CODE></A>). |
| <p> |
| <pre> |
| Comment: |
| LineComment |
| BlockComment |
| Javadoc |
| </pre> |
| </p> |
| |
| 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> |
| </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> <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ASTNode.html" title="class in org.eclipse.wst.jsdt.core.dom">ASTNode</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/Comment.html#getAlternateRoot()">getAlternateRoot</A></B>()</CODE> |
| |
| <BR> |
| Returns the root AST node that this comment occurs |
| within, or <code>null</code> if none (or not recorded).</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/Comment.html#isBlockComment()">isBlockComment</A></B>()</CODE> |
| |
| <BR> |
| Returns whether this comment is a block comment |
| (<code>BlockComment</code>).</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/Comment.html#isDocComment()">isDocComment</A></B>()</CODE> |
| |
| <BR> |
| Returns whether this comment is a doc comment |
| (<code>JSdoc</code>).</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/Comment.html#isLineComment()">isLineComment</A></B>()</CODE> |
| |
| <BR> |
| Returns whether this comment is a line comment |
| (<code>LineComment</code>).</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/Comment.html#setAlternateRoot(org.eclipse.wst.jsdt.core.dom.ASTNode)">setAlternateRoot</A></B>(<A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ASTNode.html" title="class in org.eclipse.wst.jsdt.core.dom">ASTNode</A> root)</CODE> |
| |
| <BR> |
| Returns the root AST node that this comment occurs |
| within, or <code>null</code> if none (or not recorded).</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> |
| |
| <!-- ============ 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="isBlockComment()"><!-- --></A><H3> |
| isBlockComment</H3> |
| <PRE> |
| public final boolean <B>isBlockComment</B>()</PRE> |
| <DL> |
| <DD>Returns whether this comment is a block comment |
| (<code>BlockComment</code>). |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD><code>true</code> if this is a block comment, and |
| <code>false</code> otherwise</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="isLineComment()"><!-- --></A><H3> |
| isLineComment</H3> |
| <PRE> |
| public final boolean <B>isLineComment</B>()</PRE> |
| <DL> |
| <DD>Returns whether this comment is a line comment |
| (<code>LineComment</code>). |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD><code>true</code> if this is a line comment, and |
| <code>false</code> otherwise</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="isDocComment()"><!-- --></A><H3> |
| isDocComment</H3> |
| <PRE> |
| public final boolean <B>isDocComment</B>()</PRE> |
| <DL> |
| <DD>Returns whether this comment is a doc comment |
| (<code>JSdoc</code>). |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD><code>true</code> if this is a doc comment, and |
| <code>false</code> otherwise</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getAlternateRoot()"><!-- --></A><H3> |
| getAlternateRoot</H3> |
| <PRE> |
| public final <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ASTNode.html" title="class in org.eclipse.wst.jsdt.core.dom">ASTNode</A> <B>getAlternateRoot</B>()</PRE> |
| <DL> |
| <DD>Returns the root AST node that this comment occurs |
| within, or <code>null</code> if none (or not recorded). |
| <p> |
| Typically, the comment nodes created while parsing a compilation |
| unit are not considered descendents of the normal AST |
| root, namely an <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/JavaScriptUnit.html" title="class in org.eclipse.wst.jsdt.core.dom"><CODE>JavaScriptUnit</CODE></A>. Instead, these |
| comment nodes exist outside the normal AST and each is |
| a root in its own right. This optional property provides |
| a well-known way to navigate from the comment to the |
| javaScript unit in such cases. Note that the alternate root |
| property is not one of the comment node's children. It is simply a |
| reference to a node. |
| </p> |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the alternate root node, or <code>null</code> |
| if none<DT><B>See Also:</B><DD><A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/Comment.html#setAlternateRoot(org.eclipse.wst.jsdt.core.dom.ASTNode)"><CODE>setAlternateRoot(ASTNode)</CODE></A></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setAlternateRoot(org.eclipse.wst.jsdt.core.dom.ASTNode)"><!-- --></A><H3> |
| setAlternateRoot</H3> |
| <PRE> |
| public final void <B>setAlternateRoot</B>(<A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ASTNode.html" title="class in org.eclipse.wst.jsdt.core.dom">ASTNode</A> root)</PRE> |
| <DL> |
| <DD>Returns the root AST node that this comment occurs |
| within, or <code>null</code> if none (or not recorded). |
| <p> |
| </p> |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>root</CODE> - the alternate root node, or <code>null</code> |
| if none<DT><B>See Also:</B><DD><A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/Comment.html#getAlternateRoot()"><CODE>getAlternateRoot()</CODE></A></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/Comment.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/ClassInstanceCreation.html" title="class in org.eclipse.wst.jsdt.core.dom"><B>PREV CLASS</B></A> |
| <A HREF="../../../../../../org/eclipse/wst/jsdt/core/dom/ConditionalExpression.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/Comment.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="Comment.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="#fields_inherited_from_class_org.eclipse.wst.jsdt.core.dom.ASTNode">FIELD</A> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_bottom"></A> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| |
| <HR> |
| |
| </BODY> |
| </HTML> |
