2152 lines
84 KiB
HTML
2152 lines
84 KiB
HTML
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
||
|
|
<!--NewPage-->
|
||
|
|
<HTML>
|
||
|
|
<HEAD>
|
||
|
|
<TITLE>
|
||
|
|
JSDocInfo (Compiler)
|
||
|
|
</TITLE>
|
||
|
|
|
||
|
|
|
||
|
|
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../dev_javadoc.css" TITLE="Style">
|
||
|
|
|
||
|
|
<SCRIPT type="text/javascript">
|
||
|
|
function windowTitle()
|
||
|
|
{
|
||
|
|
if (location.href.indexOf('is-external=true') == -1) {
|
||
|
|
parent.document.title="JSDocInfo (Compiler)";
|
||
|
|
}
|
||
|
|
}
|
||
|
|
</SCRIPT>
|
||
|
|
<NOSCRIPT>
|
||
|
|
</NOSCRIPT>
|
||
|
|
|
||
|
|
</HEAD>
|
||
|
|
|
||
|
|
<BODY BGCOLOR="white" onload="windowTitle();">
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
|
||
|
|
<!-- ========= 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="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-all.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="../../../../com/google/javascript/rhino/IR.html" title="class in com.google.javascript.rhino"><B>PREV CLASS</B></A>
|
||
|
|
<A HREF="../../../../com/google/javascript/rhino/JSDocInfo.Marker.html" title="class in com.google.javascript.rhino"><B>NEXT CLASS</B></A></FONT></TD>
|
||
|
|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||
|
|
<A HREF="../../../../index.html?com/google/javascript/rhino/JSDocInfo.html" target="_top"><B>FRAMES</B></A>
|
||
|
|
<A HREF="JSDocInfo.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: <A HREF="#nested_class_summary">NESTED</A> | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
||
|
|
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||
|
|
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <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">
|
||
|
|
com.google.javascript.rhino</FONT>
|
||
|
|
<BR>
|
||
|
|
Class JSDocInfo</H2>
|
||
|
|
<PRE>
|
||
|
|
<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A>
|
||
|
|
<IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>com.google.javascript.rhino.JSDocInfo</B>
|
||
|
|
</PRE>
|
||
|
|
<DL>
|
||
|
|
<DT><B>All Implemented Interfaces:</B> <DD><A HREF="http://java.sun.com/javase/6/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</A></DD>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
<DL>
|
||
|
|
<DT><PRE>public class <B>JSDocInfo</B><DT>extends <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A><DT>implements <A HREF="http://java.sun.com/javase/6/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</A></DL>
|
||
|
|
</PRE>
|
||
|
|
|
||
|
|
<P>
|
||
|
|
<p>JSDoc information describing JavaScript code. JSDoc is represented as a
|
||
|
|
unified object with fields for each JSDoc annotation, even though some
|
||
|
|
combinations are incorrect. For instance, if a JSDoc describes an enum,
|
||
|
|
it cannot have information about a return type. This implementation
|
||
|
|
takes advantage of such incompatibilities to reuse fields for multiple
|
||
|
|
purposes, reducing memory consumption.</p>
|
||
|
|
|
||
|
|
<p>Constructing <A HREF="../../../../com/google/javascript/rhino/JSDocInfo.html" title="class in com.google.javascript.rhino"><CODE>JSDocInfo</CODE></A> objects is simplified by
|
||
|
|
<A HREF="../../../../com/google/javascript/rhino/JSDocInfoBuilder.html" title="class in com.google.javascript.rhino"><CODE>JSDocInfoBuilder</CODE></A> which provides early incompatibility detection.</p>
|
||
|
|
<P>
|
||
|
|
|
||
|
|
<P>
|
||
|
|
<DL>
|
||
|
|
<DT><B>See Also:</B><DD><A HREF="../../../../serialized-form.html#com.google.javascript.rhino.JSDocInfo">Serialized Form</A></DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<P>
|
||
|
|
<!-- ======== NESTED CLASS SUMMARY ======== -->
|
||
|
|
|
||
|
|
<A NAME="nested_class_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>Nested Class Summary</B></FONT></TH>
|
||
|
|
</TR>
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||
|
|
<CODE>static class</CODE></FONT></TD>
|
||
|
|
<TD><CODE><B><A HREF="../../../../com/google/javascript/rhino/JSDocInfo.Marker.html" title="class in com.google.javascript.rhino">JSDocInfo.Marker</A></B></CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
Defines a class for containing the parsing information
|
||
|
|
for this JSDocInfo.</TD>
|
||
|
|
</TR>
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||
|
|
<CODE>static class</CODE></FONT></TD>
|
||
|
|
<TD><CODE><B><A HREF="../../../../com/google/javascript/rhino/JSDocInfo.NamePosition.html" title="class in com.google.javascript.rhino">JSDocInfo.NamePosition</A></B></CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
A piece of information (found in a marker) which contains a position
|
||
|
|
with a name node.</TD>
|
||
|
|
</TR>
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||
|
|
<CODE>static class</CODE></FONT></TD>
|
||
|
|
<TD><CODE><B><A HREF="../../../../com/google/javascript/rhino/JSDocInfo.StringPosition.html" title="class in com.google.javascript.rhino">JSDocInfo.StringPosition</A></B></CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
A piece of information (found in a marker) which contains a position
|
||
|
|
with a string.</TD>
|
||
|
|
</TR>
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||
|
|
<CODE>static class</CODE></FONT></TD>
|
||
|
|
<TD><CODE><B><A HREF="../../../../com/google/javascript/rhino/JSDocInfo.TypePosition.html" title="class in com.google.javascript.rhino">JSDocInfo.TypePosition</A></B></CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
A piece of information (found in a marker) which contains a position
|
||
|
|
with a type expression syntax tree.</TD>
|
||
|
|
</TR>
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||
|
|
<CODE>static class</CODE></FONT></TD>
|
||
|
|
<TD><CODE><B><A HREF="../../../../com/google/javascript/rhino/JSDocInfo.Visibility.html" title="enum in com.google.javascript.rhino">JSDocInfo.Visibility</A></B></CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
Visibility categories.</TD>
|
||
|
|
</TR>
|
||
|
|
</TABLE>
|
||
|
|
|
||
|
|
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
||
|
|
|
||
|
|
<A NAME="constructor_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>Constructor Summary</B></FONT></TH>
|
||
|
|
</TR>
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD><CODE><B><A HREF="../../../../com/google/javascript/rhino/JSDocInfo.html#JSDocInfo()">JSDocInfo</A></B>()</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
</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> void</CODE></FONT></TD>
|
||
|
|
<TD><CODE><B><A HREF="../../../../com/google/javascript/rhino/JSDocInfo.html#addSuppression(java.lang.String)">addSuppression</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> suppression)</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
Add a suppressed warning.</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="../../../../com/google/javascript/rhino/JSDocInfo.html#containsDeclaration()">containsDeclaration</A></B>()</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
</TD>
|
||
|
|
</TR>
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||
|
|
<CODE> <A HREF="../../../../com/google/javascript/rhino/Node.html" title="class in com.google.javascript.rhino">Node</A></CODE></FONT></TD>
|
||
|
|
<TD><CODE><B><A HREF="../../../../com/google/javascript/rhino/JSDocInfo.html#getAssociatedNode()">getAssociatedNode</A></B>()</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
</TD>
|
||
|
|
</TR>
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||
|
|
<CODE> <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A><<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>></CODE></FONT></TD>
|
||
|
|
<TD><CODE><B><A HREF="../../../../com/google/javascript/rhino/JSDocInfo.html#getAuthors()">getAuthors</A></B>()</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
Returns the list of authors or null if none.</TD>
|
||
|
|
</TR>
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||
|
|
<CODE> <A HREF="../../../../com/google/javascript/rhino/JSTypeExpression.html" title="class in com.google.javascript.rhino">JSTypeExpression</A></CODE></FONT></TD>
|
||
|
|
<TD><CODE><B><A HREF="../../../../com/google/javascript/rhino/JSDocInfo.html#getBaseType()">getBaseType</A></B>()</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
Gets the base type specified by the <code>@extends</code> annotation.</TD>
|
||
|
|
</TR>
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||
|
|
<CODE> <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
|
||
|
|
<TD><CODE><B><A HREF="../../../../com/google/javascript/rhino/JSDocInfo.html#getBlockDescription()">getBlockDescription</A></B>()</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
Returns the block-level description or null if none specified.</TD>
|
||
|
|
</TR>
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||
|
|
<CODE> <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
|
||
|
|
<TD><CODE><B><A HREF="../../../../com/google/javascript/rhino/JSDocInfo.html#getDeprecationReason()">getDeprecationReason</A></B>()</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
Returns the deprecation reason or null if none specified.</TD>
|
||
|
|
</TR>
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||
|
|
<CODE> <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
|
||
|
|
<TD><CODE><B><A HREF="../../../../com/google/javascript/rhino/JSDocInfo.html#getDescription()">getDescription</A></B>()</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
Gets the description specified by the <code>@desc</code> annotation.</TD>
|
||
|
|
</TR>
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||
|
|
<CODE> <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
|
||
|
|
<TD><CODE><B><A HREF="../../../../com/google/javascript/rhino/JSDocInfo.html#getDescriptionForParameter(java.lang.String)">getDescriptionForParameter</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name)</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
Returns the description for the parameter with the given name, if its
|
||
|
|
exists.</TD>
|
||
|
|
</TR>
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||
|
|
<CODE> <A HREF="../../../../com/google/javascript/rhino/JSTypeExpression.html" title="class in com.google.javascript.rhino">JSTypeExpression</A></CODE></FONT></TD>
|
||
|
|
<TD><CODE><B><A HREF="../../../../com/google/javascript/rhino/JSDocInfo.html#getEnumParameterType()">getEnumParameterType</A></B>()</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
Gets the enum parameter type specified by the <code>@enum</code> annotation.</TD>
|
||
|
|
</TR>
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||
|
|
<CODE> <A HREF="http://java.sun.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="../../../../com/google/javascript/rhino/JSTypeExpression.html" title="class in com.google.javascript.rhino">JSTypeExpression</A>></CODE></FONT></TD>
|
||
|
|
<TD><CODE><B><A HREF="../../../../com/google/javascript/rhino/JSDocInfo.html#getExtendedInterfaces()">getExtendedInterfaces</A></B>()</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
Returns the interfaces extended by an interface</TD>
|
||
|
|
</TR>
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||
|
|
<CODE> int</CODE></FONT></TD>
|
||
|
|
<TD><CODE><B><A HREF="../../../../com/google/javascript/rhino/JSDocInfo.html#getExtendedInterfacesCount()">getExtendedInterfacesCount</A></B>()</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
Gets the number of extended interfaces specified</TD>
|
||
|
|
</TR>
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||
|
|
<CODE> <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
|
||
|
|
<TD><CODE><B><A HREF="../../../../com/google/javascript/rhino/JSDocInfo.html#getFileOverview()">getFileOverview</A></B>()</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
Returns the file overview or null if none specified.</TD>
|
||
|
|
</TR>
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||
|
|
<CODE> int</CODE></FONT></TD>
|
||
|
|
<TD><CODE><B><A HREF="../../../../com/google/javascript/rhino/JSDocInfo.html#getImplementedInterfaceCount()">getImplementedInterfaceCount</A></B>()</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
Gets the number of interfaces specified by the <code>@implements</code>
|
||
|
|
annotation.</TD>
|
||
|
|
</TR>
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||
|
|
<CODE> <A HREF="http://java.sun.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="../../../../com/google/javascript/rhino/JSTypeExpression.html" title="class in com.google.javascript.rhino">JSTypeExpression</A>></CODE></FONT></TD>
|
||
|
|
<TD><CODE><B><A HREF="../../../../com/google/javascript/rhino/JSDocInfo.html#getImplementedInterfaces()">getImplementedInterfaces</A></B>()</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
Returns the types specified by the <code>@implements</code> annotation.</TD>
|
||
|
|
</TR>
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||
|
|
<CODE> <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
|
||
|
|
<TD><CODE><B><A HREF="../../../../com/google/javascript/rhino/JSDocInfo.html#getLendsName()">getLendsName</A></B>()</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
Gets the name we're lending to in a <code>@lends</code> annotation.</TD>
|
||
|
|
</TR>
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||
|
|
<CODE> <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
|
||
|
|
<TD><CODE><B><A HREF="../../../../com/google/javascript/rhino/JSDocInfo.html#getLicense()">getLicense</A></B>()</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
Gets the description specified by the <code>@license</code> annotation.</TD>
|
||
|
|
</TR>
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||
|
|
<CODE> <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A><<A HREF="../../../../com/google/javascript/rhino/JSDocInfo.Marker.html" title="class in com.google.javascript.rhino">JSDocInfo.Marker</A>></CODE></FONT></TD>
|
||
|
|
<TD><CODE><B><A HREF="../../../../com/google/javascript/rhino/JSDocInfo.html#getMarkers()">getMarkers</A></B>()</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
Gets the list of all markers for the documentation in this JSDoc.</TD>
|
||
|
|
</TR>
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||
|
|
<CODE> <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
|
||
|
|
<TD><CODE><B><A HREF="../../../../com/google/javascript/rhino/JSDocInfo.html#getMeaning()">getMeaning</A></B>()</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
Gets the meaning specified by the <code>@meaning</code> annotation.</TD>
|
||
|
|
</TR>
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||
|
|
<CODE> <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</A><<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>></CODE></FONT></TD>
|
||
|
|
<TD><CODE><B><A HREF="../../../../com/google/javascript/rhino/JSDocInfo.html#getModifies()">getModifies</A></B>()</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
Returns the set of sideeffect notations.</TD>
|
||
|
|
</TR>
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||
|
|
<CODE> <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
|
||
|
|
<TD><CODE><B><A HREF="../../../../com/google/javascript/rhino/JSDocInfo.html#getOriginalCommentString()">getOriginalCommentString</A></B>()</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
Returns the original JSDoc comment string.</TD>
|
||
|
|
</TR>
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||
|
|
<CODE> int</CODE></FONT></TD>
|
||
|
|
<TD><CODE><B><A HREF="../../../../com/google/javascript/rhino/JSDocInfo.html#getParameterCount()">getParameterCount</A></B>()</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
Gets the number of parameters defined.</TD>
|
||
|
|
</TR>
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||
|
|
<CODE> <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</A><<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>></CODE></FONT></TD>
|
||
|
|
<TD><CODE><B><A HREF="../../../../com/google/javascript/rhino/JSDocInfo.html#getParameterNames()">getParameterNames</A></B>()</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
Returns the set of names of the defined parameters.</TD>
|
||
|
|
</TR>
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||
|
|
<CODE> <A HREF="../../../../com/google/javascript/rhino/JSTypeExpression.html" title="class in com.google.javascript.rhino">JSTypeExpression</A></CODE></FONT></TD>
|
||
|
|
<TD><CODE><B><A HREF="../../../../com/google/javascript/rhino/JSDocInfo.html#getParameterType(java.lang.String)">getParameterType</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> parameter)</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
Gets the parameter type.</TD>
|
||
|
|
</TR>
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||
|
|
<CODE> <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A><<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>></CODE></FONT></TD>
|
||
|
|
<TD><CODE><B><A HREF="../../../../com/google/javascript/rhino/JSDocInfo.html#getReferences()">getReferences</A></B>()</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
Returns the list of references or null if none.</TD>
|
||
|
|
</TR>
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||
|
|
<CODE> <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
|
||
|
|
<TD><CODE><B><A HREF="../../../../com/google/javascript/rhino/JSDocInfo.html#getReturnDescription()">getReturnDescription</A></B>()</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
Returns the description of the returned object or null if none specified.</TD>
|
||
|
|
</TR>
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||
|
|
<CODE> <A HREF="../../../../com/google/javascript/rhino/JSTypeExpression.html" title="class in com.google.javascript.rhino">JSTypeExpression</A></CODE></FONT></TD>
|
||
|
|
<TD><CODE><B><A HREF="../../../../com/google/javascript/rhino/JSDocInfo.html#getReturnType()">getReturnType</A></B>()</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
Gets the return type specified by the <code>@return</code> annotation.</TD>
|
||
|
|
</TR>
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||
|
|
<CODE> <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
|
||
|
|
<TD><CODE><B><A HREF="../../../../com/google/javascript/rhino/JSDocInfo.html#getSourceName()">getSourceName</A></B>()</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
Gets the name of the source file that contains this JSDoc.</TD>
|
||
|
|
</TR>
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||
|
|
<CODE> <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</A><<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>></CODE></FONT></TD>
|
||
|
|
<TD><CODE><B><A HREF="../../../../com/google/javascript/rhino/JSDocInfo.html#getSuppressions()">getSuppressions</A></B>()</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
Returns the set of suppressed warnings.</TD>
|
||
|
|
</TR>
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||
|
|
<CODE> <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
|
||
|
|
<TD><CODE><B><A HREF="../../../../com/google/javascript/rhino/JSDocInfo.html#getTemplateTypeName()">getTemplateTypeName</A></B>()</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
Gets the template type name.</TD>
|
||
|
|
</TR>
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||
|
|
<CODE> <A HREF="../../../../com/google/javascript/rhino/JSTypeExpression.html" title="class in com.google.javascript.rhino">JSTypeExpression</A></CODE></FONT></TD>
|
||
|
|
<TD><CODE><B><A HREF="../../../../com/google/javascript/rhino/JSDocInfo.html#getThisType()">getThisType</A></B>()</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
Gets the type specified by the <code>@this</code> annotation.</TD>
|
||
|
|
</TR>
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||
|
|
<CODE> <A HREF="http://java.sun.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="../../../../com/google/javascript/rhino/JSTypeExpression.html" title="class in com.google.javascript.rhino">JSTypeExpression</A>></CODE></FONT></TD>
|
||
|
|
<TD><CODE><B><A HREF="../../../../com/google/javascript/rhino/JSDocInfo.html#getThrownTypes()">getThrownTypes</A></B>()</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
Returns the list of thrown types.</TD>
|
||
|
|
</TR>
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||
|
|
<CODE> <A HREF="../../../../com/google/javascript/rhino/JSTypeExpression.html" title="class in com.google.javascript.rhino">JSTypeExpression</A></CODE></FONT></TD>
|
||
|
|
<TD><CODE><B><A HREF="../../../../com/google/javascript/rhino/JSDocInfo.html#getType()">getType</A></B>()</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
Gets the type specified by the <code>@type</code> annotation.</TD>
|
||
|
|
</TR>
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||
|
|
<CODE> <A HREF="../../../../com/google/javascript/rhino/JSTypeExpression.html" title="class in com.google.javascript.rhino">JSTypeExpression</A></CODE></FONT></TD>
|
||
|
|
<TD><CODE><B><A HREF="../../../../com/google/javascript/rhino/JSDocInfo.html#getTypedefType()">getTypedefType</A></B>()</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
Gets the typedef type specified by the <code>@type</code> annotation.</TD>
|
||
|
|
</TR>
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||
|
|
<CODE> <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A><<A HREF="../../../../com/google/javascript/rhino/Node.html" title="class in com.google.javascript.rhino">Node</A>></CODE></FONT></TD>
|
||
|
|
<TD><CODE><B><A HREF="../../../../com/google/javascript/rhino/JSDocInfo.html#getTypeNodes()">getTypeNodes</A></B>()</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
Returns a collection of all type nodes that are a part of this JSDocInfo.</TD>
|
||
|
|
</TR>
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||
|
|
<CODE> <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
|
||
|
|
<TD><CODE><B><A HREF="../../../../com/google/javascript/rhino/JSDocInfo.html#getVersion()">getVersion</A></B>()</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
Returns the version or null if none.</TD>
|
||
|
|
</TR>
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||
|
|
<CODE> <A HREF="../../../../com/google/javascript/rhino/JSDocInfo.Visibility.html" title="enum in com.google.javascript.rhino">JSDocInfo.Visibility</A></CODE></FONT></TD>
|
||
|
|
<TD><CODE><B><A HREF="../../../../com/google/javascript/rhino/JSDocInfo.html#getVisibility()">getVisibility</A></B>()</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
Gets the visibility specified by <code>@private</code>, <code>@protected</code> or
|
||
|
|
<code>@public</code> annotation.</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="../../../../com/google/javascript/rhino/JSDocInfo.html#hasBaseType()">hasBaseType</A></B>()</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
Returns whether this <A HREF="../../../../com/google/javascript/rhino/JSDocInfo.html" title="class in com.google.javascript.rhino"><CODE>JSDocInfo</CODE></A> contains a type for <code>@extends</code>
|
||
|
|
annotation.</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="../../../../com/google/javascript/rhino/JSDocInfo.html#hasDescriptionForParameter(java.lang.String)">hasDescriptionForParameter</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name)</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
Returns whether a description exists for the parameter with the specified
|
||
|
|
name.</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="../../../../com/google/javascript/rhino/JSDocInfo.html#hasEnumParameterType()">hasEnumParameterType</A></B>()</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
Returns whether an enum parameter type, specified using the <code>@enum</code>
|
||
|
|
annotation, is present on this JSDoc.</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="../../../../com/google/javascript/rhino/JSDocInfo.html#hasFileOverview()">hasFileOverview</A></B>()</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
Returns whether this has a fileoverview flag.</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="../../../../com/google/javascript/rhino/JSDocInfo.html#hasModifies()">hasModifies</A></B>()</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
</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="../../../../com/google/javascript/rhino/JSDocInfo.html#hasParameter(java.lang.String)">hasParameter</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> parameter)</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
Returns whether the parameter is defined.</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="../../../../com/google/javascript/rhino/JSDocInfo.html#hasParameterType(java.lang.String)">hasParameterType</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> parameter)</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
Returns whether the parameter has an attached type.</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="../../../../com/google/javascript/rhino/JSDocInfo.html#hasReturnType()">hasReturnType</A></B>()</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
Returns whether this <A HREF="../../../../com/google/javascript/rhino/JSDocInfo.html" title="class in com.google.javascript.rhino"><CODE>JSDocInfo</CODE></A> contains a type for <code>@return</code>
|
||
|
|
annotation.</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="../../../../com/google/javascript/rhino/JSDocInfo.html#hasThisType()">hasThisType</A></B>()</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
Returns whether this <A HREF="../../../../com/google/javascript/rhino/JSDocInfo.html" title="class in com.google.javascript.rhino"><CODE>JSDocInfo</CODE></A> contains a type for <code>@this</code>
|
||
|
|
annotation.</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="../../../../com/google/javascript/rhino/JSDocInfo.html#hasType()">hasType</A></B>()</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
Returns whether a type, specified using the <code>@type</code> annotation, is
|
||
|
|
present on this JSDoc.</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="../../../../com/google/javascript/rhino/JSDocInfo.html#hasTypedefType()">hasTypedefType</A></B>()</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
Returns whether a typedef parameter type, specified using the
|
||
|
|
<code>@typedef</code> annotation, is present on this JSDoc.</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="../../../../com/google/javascript/rhino/JSDocInfo.html#isConsistentIdGenerator()">isConsistentIdGenerator</A></B>()</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
</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="../../../../com/google/javascript/rhino/JSDocInfo.html#isConstant()">isConstant</A></B>()</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
Returns whether the <code>@const</code> annotation is present on this
|
||
|
|
<A HREF="../../../../com/google/javascript/rhino/JSDocInfo.html" title="class in com.google.javascript.rhino"><CODE>JSDocInfo</CODE></A>.</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="../../../../com/google/javascript/rhino/JSDocInfo.html#isConstructor()">isConstructor</A></B>()</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
Returns whether the <code>@constructor</code> annotation is present on this
|
||
|
|
<A HREF="../../../../com/google/javascript/rhino/JSDocInfo.html" title="class in com.google.javascript.rhino"><CODE>JSDocInfo</CODE></A>.</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="../../../../com/google/javascript/rhino/JSDocInfo.html#isDefine()">isDefine</A></B>()</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
Returns whether the <code>@define</code> annotation is present on this
|
||
|
|
<A HREF="../../../../com/google/javascript/rhino/JSDocInfo.html" title="class in com.google.javascript.rhino"><CODE>JSDocInfo</CODE></A>.</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="../../../../com/google/javascript/rhino/JSDocInfo.html#isDeprecated()">isDeprecated</A></B>()</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
Returns whether the <code>@deprecated</code> annotation is present on this
|
||
|
|
<A HREF="../../../../com/google/javascript/rhino/JSDocInfo.html" title="class in com.google.javascript.rhino"><CODE>JSDocInfo</CODE></A>.</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="../../../../com/google/javascript/rhino/JSDocInfo.html#isExport()">isExport</A></B>()</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
Returns whether the <code>@export</code> annotation is present on this
|
||
|
|
<A HREF="../../../../com/google/javascript/rhino/JSDocInfo.html" title="class in com.google.javascript.rhino"><CODE>JSDocInfo</CODE></A>.</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="../../../../com/google/javascript/rhino/JSDocInfo.html#isExpose()">isExpose</A></B>()</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
Returns whether the <code>@expose</code> annotation is present on this
|
||
|
|
<A HREF="../../../../com/google/javascript/rhino/JSDocInfo.html" title="class in com.google.javascript.rhino"><CODE>JSDocInfo</CODE></A>.</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="../../../../com/google/javascript/rhino/JSDocInfo.html#isExterns()">isExterns</A></B>()</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
Returns whether the <code>@externs</code> annotation is present on this
|
||
|
|
<A HREF="../../../../com/google/javascript/rhino/JSDocInfo.html" title="class in com.google.javascript.rhino"><CODE>JSDocInfo</CODE></A>.</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="../../../../com/google/javascript/rhino/JSDocInfo.html#isHidden()">isHidden</A></B>()</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
Returns whether the <code>@hidden</code> annotation is present on this
|
||
|
|
<A HREF="../../../../com/google/javascript/rhino/JSDocInfo.html" title="class in com.google.javascript.rhino"><CODE>JSDocInfo</CODE></A>.</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="../../../../com/google/javascript/rhino/JSDocInfo.html#isIdGenerator()">isIdGenerator</A></B>()</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
</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="../../../../com/google/javascript/rhino/JSDocInfo.html#isImplicitCast()">isImplicitCast</A></B>()</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
Returns whether the <code>@implicitCast</code> annotation is present on this
|
||
|
|
<A HREF="../../../../com/google/javascript/rhino/JSDocInfo.html" title="class in com.google.javascript.rhino"><CODE>JSDocInfo</CODE></A>.</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="../../../../com/google/javascript/rhino/JSDocInfo.html#isInterface()">isInterface</A></B>()</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
Returns whether the <code>@interface</code> annotation is present on this
|
||
|
|
<A HREF="../../../../com/google/javascript/rhino/JSDocInfo.html" title="class in com.google.javascript.rhino"><CODE>JSDocInfo</CODE></A>.</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="../../../../com/google/javascript/rhino/JSDocInfo.html#isJavaDispatch()">isJavaDispatch</A></B>()</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
Returns whether the <code>@javadispath</code> annotation is present on this
|
||
|
|
<A HREF="../../../../com/google/javascript/rhino/JSDocInfo.html" title="class in com.google.javascript.rhino"><CODE>JSDocInfo</CODE></A>.</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="../../../../com/google/javascript/rhino/JSDocInfo.html#isNoAlias()">isNoAlias</A></B>()</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
Returns whether the <code>@noalias</code> annotation is present on this
|
||
|
|
<A HREF="../../../../com/google/javascript/rhino/JSDocInfo.html" title="class in com.google.javascript.rhino"><CODE>JSDocInfo</CODE></A>.</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="../../../../com/google/javascript/rhino/JSDocInfo.html#isNoCompile()">isNoCompile</A></B>()</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
Returns whether the <code>@nocompile</code> annotation is present on this
|
||
|
|
<A HREF="../../../../com/google/javascript/rhino/JSDocInfo.html" title="class in com.google.javascript.rhino"><CODE>JSDocInfo</CODE></A>.</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="../../../../com/google/javascript/rhino/JSDocInfo.html#isNoShadow()">isNoShadow</A></B>()</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
Returns whether the <code>@noshadow</code> annotation is present on this
|
||
|
|
<A HREF="../../../../com/google/javascript/rhino/JSDocInfo.html" title="class in com.google.javascript.rhino"><CODE>JSDocInfo</CODE></A>.</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="../../../../com/google/javascript/rhino/JSDocInfo.html#isNoSideEffects()">isNoSideEffects</A></B>()</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
Returns whether the <code>@nosideeffects</code> annotation is present on this
|
||
|
|
<A HREF="../../../../com/google/javascript/rhino/JSDocInfo.html" title="class in com.google.javascript.rhino"><CODE>JSDocInfo</CODE></A>.</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="../../../../com/google/javascript/rhino/JSDocInfo.html#isNoTypeCheck()">isNoTypeCheck</A></B>()</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
Returns whether the <code>@nocheck</code> annotation is present on this
|
||
|
|
<A HREF="../../../../com/google/javascript/rhino/JSDocInfo.html" title="class in com.google.javascript.rhino"><CODE>JSDocInfo</CODE></A>.</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="../../../../com/google/javascript/rhino/JSDocInfo.html#isOverride()">isOverride</A></B>()</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
Returns whether the <code>@override</code> annotation is present on this
|
||
|
|
<A HREF="../../../../com/google/javascript/rhino/JSDocInfo.html" title="class in com.google.javascript.rhino"><CODE>JSDocInfo</CODE></A>.</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="../../../../com/google/javascript/rhino/JSDocInfo.html#setAssociatedNode(com.google.javascript.rhino.Node)">setAssociatedNode</A></B>(<A HREF="../../../../com/google/javascript/rhino/Node.html" title="class in com.google.javascript.rhino">Node</A> node)</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
Sets the node associated with this JSDoc.</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="../../../../com/google/javascript/rhino/JSDocInfo.html#setDeprecated(boolean)">setDeprecated</A></B>(boolean value)</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
</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="../../../../com/google/javascript/rhino/JSDocInfo.html#setLicense(java.lang.String)">setLicense</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> license)</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
License directives can appear in multiple comments, and always
|
||
|
|
apply to the entire file.</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="../../../../com/google/javascript/rhino/JSDocInfo.html#setVisibility(com.google.javascript.rhino.JSDocInfo.Visibility)">setVisibility</A></B>(<A HREF="../../../../com/google/javascript/rhino/JSDocInfo.Visibility.html" title="enum in com.google.javascript.rhino">JSDocInfo.Visibility</A> visibility)</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
</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="../../../../com/google/javascript/rhino/JSDocInfo.html#shouldPreserveTry()">shouldPreserveTry</A></B>()</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
Returns whether the <code>@preserveTry</code> annotation is present on this
|
||
|
|
<A HREF="../../../../com/google/javascript/rhino/JSDocInfo.html" title="class in com.google.javascript.rhino"><CODE>JSDocInfo</CODE></A>.</TD>
|
||
|
|
</TR>
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||
|
|
<CODE> <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
|
||
|
|
<TD><CODE><B><A HREF="../../../../com/google/javascript/rhino/JSDocInfo.html#toString()">toString</A></B>()</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
</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.<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH>
|
||
|
|
</TR>
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD>
|
||
|
|
</TR>
|
||
|
|
</TABLE>
|
||
|
|
|
||
|
|
<P>
|
||
|
|
|
||
|
|
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
||
|
|
|
||
|
|
<A NAME="constructor_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>Constructor Detail</B></FONT></TH>
|
||
|
|
</TR>
|
||
|
|
</TABLE>
|
||
|
|
|
||
|
|
<A NAME="JSDocInfo()"><!-- --></A><H3>
|
||
|
|
JSDocInfo</H3>
|
||
|
|
<PRE>
|
||
|
|
public <B>JSDocInfo</B>()</PRE>
|
||
|
|
<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="setDeprecated(boolean)"><!-- --></A><H3>
|
||
|
|
setDeprecated</H3>
|
||
|
|
<PRE>
|
||
|
|
public void <B>setDeprecated</B>(boolean value)</PRE>
|
||
|
|
<DL>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="isConsistentIdGenerator()"><!-- --></A><H3>
|
||
|
|
isConsistentIdGenerator</H3>
|
||
|
|
<PRE>
|
||
|
|
public boolean <B>isConsistentIdGenerator</B>()</PRE>
|
||
|
|
<DL>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
<DD><DL>
|
||
|
|
|
||
|
|
<DT><B>Returns:</B><DD>whether the <code>@consistentIdGenerator</code> is present on
|
||
|
|
this <A HREF="../../../../com/google/javascript/rhino/JSDocInfo.html" title="class in com.google.javascript.rhino"><CODE>JSDocInfo</CODE></A></DL>
|
||
|
|
</DD>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="isConstant()"><!-- --></A><H3>
|
||
|
|
isConstant</H3>
|
||
|
|
<PRE>
|
||
|
|
public boolean <B>isConstant</B>()</PRE>
|
||
|
|
<DL>
|
||
|
|
<DD>Returns whether the <code>@const</code> annotation is present on this
|
||
|
|
<A HREF="../../../../com/google/javascript/rhino/JSDocInfo.html" title="class in com.google.javascript.rhino"><CODE>JSDocInfo</CODE></A>.
|
||
|
|
<P>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="isConstructor()"><!-- --></A><H3>
|
||
|
|
isConstructor</H3>
|
||
|
|
<PRE>
|
||
|
|
public boolean <B>isConstructor</B>()</PRE>
|
||
|
|
<DL>
|
||
|
|
<DD>Returns whether the <code>@constructor</code> annotation is present on this
|
||
|
|
<A HREF="../../../../com/google/javascript/rhino/JSDocInfo.html" title="class in com.google.javascript.rhino"><CODE>JSDocInfo</CODE></A>.
|
||
|
|
<P>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="isDefine()"><!-- --></A><H3>
|
||
|
|
isDefine</H3>
|
||
|
|
<PRE>
|
||
|
|
public boolean <B>isDefine</B>()</PRE>
|
||
|
|
<DL>
|
||
|
|
<DD>Returns whether the <code>@define</code> annotation is present on this
|
||
|
|
<A HREF="../../../../com/google/javascript/rhino/JSDocInfo.html" title="class in com.google.javascript.rhino"><CODE>JSDocInfo</CODE></A>. If this annotation is present, then the
|
||
|
|
<A HREF="../../../../com/google/javascript/rhino/JSDocInfo.html#getType()"><CODE>getType()</CODE></A> method will retrieve the define type.
|
||
|
|
<P>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="isHidden()"><!-- --></A><H3>
|
||
|
|
isHidden</H3>
|
||
|
|
<PRE>
|
||
|
|
public boolean <B>isHidden</B>()</PRE>
|
||
|
|
<DL>
|
||
|
|
<DD>Returns whether the <code>@hidden</code> annotation is present on this
|
||
|
|
<A HREF="../../../../com/google/javascript/rhino/JSDocInfo.html" title="class in com.google.javascript.rhino"><CODE>JSDocInfo</CODE></A>.
|
||
|
|
<P>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="isNoTypeCheck()"><!-- --></A><H3>
|
||
|
|
isNoTypeCheck</H3>
|
||
|
|
<PRE>
|
||
|
|
public boolean <B>isNoTypeCheck</B>()</PRE>
|
||
|
|
<DL>
|
||
|
|
<DD>Returns whether the <code>@nocheck</code> annotation is present on this
|
||
|
|
<A HREF="../../../../com/google/javascript/rhino/JSDocInfo.html" title="class in com.google.javascript.rhino"><CODE>JSDocInfo</CODE></A>.
|
||
|
|
<P>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="shouldPreserveTry()"><!-- --></A><H3>
|
||
|
|
shouldPreserveTry</H3>
|
||
|
|
<PRE>
|
||
|
|
public boolean <B>shouldPreserveTry</B>()</PRE>
|
||
|
|
<DL>
|
||
|
|
<DD>Returns whether the <code>@preserveTry</code> annotation is present on this
|
||
|
|
<A HREF="../../../../com/google/javascript/rhino/JSDocInfo.html" title="class in com.google.javascript.rhino"><CODE>JSDocInfo</CODE></A>.
|
||
|
|
<P>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="isOverride()"><!-- --></A><H3>
|
||
|
|
isOverride</H3>
|
||
|
|
<PRE>
|
||
|
|
public boolean <B>isOverride</B>()</PRE>
|
||
|
|
<DL>
|
||
|
|
<DD>Returns whether the <code>@override</code> annotation is present on this
|
||
|
|
<A HREF="../../../../com/google/javascript/rhino/JSDocInfo.html" title="class in com.google.javascript.rhino"><CODE>JSDocInfo</CODE></A>.
|
||
|
|
<P>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="isNoAlias()"><!-- --></A><H3>
|
||
|
|
isNoAlias</H3>
|
||
|
|
<PRE>
|
||
|
|
public boolean <B>isNoAlias</B>()</PRE>
|
||
|
|
<DL>
|
||
|
|
<DD>Returns whether the <code>@noalias</code> annotation is present on this
|
||
|
|
<A HREF="../../../../com/google/javascript/rhino/JSDocInfo.html" title="class in com.google.javascript.rhino"><CODE>JSDocInfo</CODE></A>.
|
||
|
|
<P>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="isDeprecated()"><!-- --></A><H3>
|
||
|
|
isDeprecated</H3>
|
||
|
|
<PRE>
|
||
|
|
public boolean <B>isDeprecated</B>()</PRE>
|
||
|
|
<DL>
|
||
|
|
<DD>Returns whether the <code>@deprecated</code> annotation is present on this
|
||
|
|
<A HREF="../../../../com/google/javascript/rhino/JSDocInfo.html" title="class in com.google.javascript.rhino"><CODE>JSDocInfo</CODE></A>.
|
||
|
|
<P>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="isInterface()"><!-- --></A><H3>
|
||
|
|
isInterface</H3>
|
||
|
|
<PRE>
|
||
|
|
public boolean <B>isInterface</B>()</PRE>
|
||
|
|
<DL>
|
||
|
|
<DD>Returns whether the <code>@interface</code> annotation is present on this
|
||
|
|
<A HREF="../../../../com/google/javascript/rhino/JSDocInfo.html" title="class in com.google.javascript.rhino"><CODE>JSDocInfo</CODE></A>.
|
||
|
|
<P>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="isExport()"><!-- --></A><H3>
|
||
|
|
isExport</H3>
|
||
|
|
<PRE>
|
||
|
|
public boolean <B>isExport</B>()</PRE>
|
||
|
|
<DL>
|
||
|
|
<DD>Returns whether the <code>@export</code> annotation is present on this
|
||
|
|
<A HREF="../../../../com/google/javascript/rhino/JSDocInfo.html" title="class in com.google.javascript.rhino"><CODE>JSDocInfo</CODE></A>.
|
||
|
|
<P>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="isExpose()"><!-- --></A><H3>
|
||
|
|
isExpose</H3>
|
||
|
|
<PRE>
|
||
|
|
public boolean <B>isExpose</B>()</PRE>
|
||
|
|
<DL>
|
||
|
|
<DD>Returns whether the <code>@expose</code> annotation is present on this
|
||
|
|
<A HREF="../../../../com/google/javascript/rhino/JSDocInfo.html" title="class in com.google.javascript.rhino"><CODE>JSDocInfo</CODE></A>.
|
||
|
|
<P>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="isNoShadow()"><!-- --></A><H3>
|
||
|
|
isNoShadow</H3>
|
||
|
|
<PRE>
|
||
|
|
public boolean <B>isNoShadow</B>()</PRE>
|
||
|
|
<DL>
|
||
|
|
<DD>Returns whether the <code>@noshadow</code> annotation is present on this
|
||
|
|
<A HREF="../../../../com/google/javascript/rhino/JSDocInfo.html" title="class in com.google.javascript.rhino"><CODE>JSDocInfo</CODE></A>.
|
||
|
|
<P>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="isIdGenerator()"><!-- --></A><H3>
|
||
|
|
isIdGenerator</H3>
|
||
|
|
<PRE>
|
||
|
|
public boolean <B>isIdGenerator</B>()</PRE>
|
||
|
|
<DL>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
<DD><DL>
|
||
|
|
|
||
|
|
<DT><B>Returns:</B><DD>whether the <code>@idGenerator</code> is present on
|
||
|
|
this <A HREF="../../../../com/google/javascript/rhino/JSDocInfo.html" title="class in com.google.javascript.rhino"><CODE>JSDocInfo</CODE></A></DL>
|
||
|
|
</DD>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="isImplicitCast()"><!-- --></A><H3>
|
||
|
|
isImplicitCast</H3>
|
||
|
|
<PRE>
|
||
|
|
public boolean <B>isImplicitCast</B>()</PRE>
|
||
|
|
<DL>
|
||
|
|
<DD>Returns whether the <code>@implicitCast</code> annotation is present on this
|
||
|
|
<A HREF="../../../../com/google/javascript/rhino/JSDocInfo.html" title="class in com.google.javascript.rhino"><CODE>JSDocInfo</CODE></A>.
|
||
|
|
<P>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="isNoSideEffects()"><!-- --></A><H3>
|
||
|
|
isNoSideEffects</H3>
|
||
|
|
<PRE>
|
||
|
|
public boolean <B>isNoSideEffects</B>()</PRE>
|
||
|
|
<DL>
|
||
|
|
<DD>Returns whether the <code>@nosideeffects</code> annotation is present on this
|
||
|
|
<A HREF="../../../../com/google/javascript/rhino/JSDocInfo.html" title="class in com.google.javascript.rhino"><CODE>JSDocInfo</CODE></A>.
|
||
|
|
<P>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="isExterns()"><!-- --></A><H3>
|
||
|
|
isExterns</H3>
|
||
|
|
<PRE>
|
||
|
|
public boolean <B>isExterns</B>()</PRE>
|
||
|
|
<DL>
|
||
|
|
<DD>Returns whether the <code>@externs</code> annotation is present on this
|
||
|
|
<A HREF="../../../../com/google/javascript/rhino/JSDocInfo.html" title="class in com.google.javascript.rhino"><CODE>JSDocInfo</CODE></A>.
|
||
|
|
<P>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="isJavaDispatch()"><!-- --></A><H3>
|
||
|
|
isJavaDispatch</H3>
|
||
|
|
<PRE>
|
||
|
|
public boolean <B>isJavaDispatch</B>()</PRE>
|
||
|
|
<DL>
|
||
|
|
<DD>Returns whether the <code>@javadispath</code> annotation is present on this
|
||
|
|
<A HREF="../../../../com/google/javascript/rhino/JSDocInfo.html" title="class in com.google.javascript.rhino"><CODE>JSDocInfo</CODE></A>.
|
||
|
|
<P>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="isNoCompile()"><!-- --></A><H3>
|
||
|
|
isNoCompile</H3>
|
||
|
|
<PRE>
|
||
|
|
public boolean <B>isNoCompile</B>()</PRE>
|
||
|
|
<DL>
|
||
|
|
<DD>Returns whether the <code>@nocompile</code> annotation is present on this
|
||
|
|
<A HREF="../../../../com/google/javascript/rhino/JSDocInfo.html" title="class in com.google.javascript.rhino"><CODE>JSDocInfo</CODE></A>.
|
||
|
|
<P>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="containsDeclaration()"><!-- --></A><H3>
|
||
|
|
containsDeclaration</H3>
|
||
|
|
<PRE>
|
||
|
|
public boolean <B>containsDeclaration</B>()</PRE>
|
||
|
|
<DL>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
<DD><DL>
|
||
|
|
|
||
|
|
<DT><B>Returns:</B><DD>Whether there is declaration present on this <A HREF="../../../../com/google/javascript/rhino/JSDocInfo.html" title="class in com.google.javascript.rhino"><CODE>JSDocInfo</CODE></A>.</DL>
|
||
|
|
</DD>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="setVisibility(com.google.javascript.rhino.JSDocInfo.Visibility)"><!-- --></A><H3>
|
||
|
|
setVisibility</H3>
|
||
|
|
<PRE>
|
||
|
|
public void <B>setVisibility</B>(<A HREF="../../../../com/google/javascript/rhino/JSDocInfo.Visibility.html" title="enum in com.google.javascript.rhino">JSDocInfo.Visibility</A> visibility)</PRE>
|
||
|
|
<DL>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="addSuppression(java.lang.String)"><!-- --></A><H3>
|
||
|
|
addSuppression</H3>
|
||
|
|
<PRE>
|
||
|
|
public void <B>addSuppression</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> suppression)</PRE>
|
||
|
|
<DL>
|
||
|
|
<DD>Add a suppressed warning.
|
||
|
|
<P>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="getVisibility()"><!-- --></A><H3>
|
||
|
|
getVisibility</H3>
|
||
|
|
<PRE>
|
||
|
|
public <A HREF="../../../../com/google/javascript/rhino/JSDocInfo.Visibility.html" title="enum in com.google.javascript.rhino">JSDocInfo.Visibility</A> <B>getVisibility</B>()</PRE>
|
||
|
|
<DL>
|
||
|
|
<DD>Gets the visibility specified by <code>@private</code>, <code>@protected</code> or
|
||
|
|
<code>@public</code> annotation. If no visibility is specified, visibility
|
||
|
|
is inherited from the base class.
|
||
|
|
<P>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="getParameterType(java.lang.String)"><!-- --></A><H3>
|
||
|
|
getParameterType</H3>
|
||
|
|
<PRE>
|
||
|
|
public <A HREF="../../../../com/google/javascript/rhino/JSTypeExpression.html" title="class in com.google.javascript.rhino">JSTypeExpression</A> <B>getParameterType</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> parameter)</PRE>
|
||
|
|
<DL>
|
||
|
|
<DD>Gets the parameter type.
|
||
|
|
<P>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
<DD><DL>
|
||
|
|
<DT><B>Parameters:</B><DD><CODE>parameter</CODE> - the parameter's name
|
||
|
|
<DT><B>Returns:</B><DD>the parameter's type or <code>null</code> if this parameter is not
|
||
|
|
defined or has a <code>null</code> type</DL>
|
||
|
|
</DD>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="hasParameter(java.lang.String)"><!-- --></A><H3>
|
||
|
|
hasParameter</H3>
|
||
|
|
<PRE>
|
||
|
|
public boolean <B>hasParameter</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> parameter)</PRE>
|
||
|
|
<DL>
|
||
|
|
<DD>Returns whether the parameter is defined.
|
||
|
|
<P>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="hasParameterType(java.lang.String)"><!-- --></A><H3>
|
||
|
|
hasParameterType</H3>
|
||
|
|
<PRE>
|
||
|
|
public boolean <B>hasParameterType</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> parameter)</PRE>
|
||
|
|
<DL>
|
||
|
|
<DD>Returns whether the parameter has an attached type.
|
||
|
|
<P>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
<DD><DL>
|
||
|
|
|
||
|
|
<DT><B>Returns:</B><DD><code>true</code> if the parameter has an attached type, <code>false</code>
|
||
|
|
if the parameter has no attached type or does not exist.</DL>
|
||
|
|
</DD>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="getParameterNames()"><!-- --></A><H3>
|
||
|
|
getParameterNames</H3>
|
||
|
|
<PRE>
|
||
|
|
public <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</A><<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>> <B>getParameterNames</B>()</PRE>
|
||
|
|
<DL>
|
||
|
|
<DD>Returns the set of names of the defined parameters. The iteration order
|
||
|
|
of the returned set is not the order in which parameters are defined.
|
||
|
|
<P>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
<DD><DL>
|
||
|
|
|
||
|
|
<DT><B>Returns:</B><DD>the set of names of the defined parameters. The returned set is
|
||
|
|
immutable.</DL>
|
||
|
|
</DD>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="getParameterCount()"><!-- --></A><H3>
|
||
|
|
getParameterCount</H3>
|
||
|
|
<PRE>
|
||
|
|
public int <B>getParameterCount</B>()</PRE>
|
||
|
|
<DL>
|
||
|
|
<DD>Gets the number of parameters defined.
|
||
|
|
<P>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="getThrownTypes()"><!-- --></A><H3>
|
||
|
|
getThrownTypes</H3>
|
||
|
|
<PRE>
|
||
|
|
public <A HREF="http://java.sun.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="../../../../com/google/javascript/rhino/JSTypeExpression.html" title="class in com.google.javascript.rhino">JSTypeExpression</A>> <B>getThrownTypes</B>()</PRE>
|
||
|
|
<DL>
|
||
|
|
<DD>Returns the list of thrown types.
|
||
|
|
<P>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="hasType()"><!-- --></A><H3>
|
||
|
|
hasType</H3>
|
||
|
|
<PRE>
|
||
|
|
public boolean <B>hasType</B>()</PRE>
|
||
|
|
<DL>
|
||
|
|
<DD>Returns whether a type, specified using the <code>@type</code> annotation, is
|
||
|
|
present on this JSDoc.
|
||
|
|
<P>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="hasEnumParameterType()"><!-- --></A><H3>
|
||
|
|
hasEnumParameterType</H3>
|
||
|
|
<PRE>
|
||
|
|
public boolean <B>hasEnumParameterType</B>()</PRE>
|
||
|
|
<DL>
|
||
|
|
<DD>Returns whether an enum parameter type, specified using the <code>@enum</code>
|
||
|
|
annotation, is present on this JSDoc.
|
||
|
|
<P>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="hasTypedefType()"><!-- --></A><H3>
|
||
|
|
hasTypedefType</H3>
|
||
|
|
<PRE>
|
||
|
|
public boolean <B>hasTypedefType</B>()</PRE>
|
||
|
|
<DL>
|
||
|
|
<DD>Returns whether a typedef parameter type, specified using the
|
||
|
|
<code>@typedef</code> annotation, is present on this JSDoc.
|
||
|
|
<P>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="hasReturnType()"><!-- --></A><H3>
|
||
|
|
hasReturnType</H3>
|
||
|
|
<PRE>
|
||
|
|
public boolean <B>hasReturnType</B>()</PRE>
|
||
|
|
<DL>
|
||
|
|
<DD>Returns whether this <A HREF="../../../../com/google/javascript/rhino/JSDocInfo.html" title="class in com.google.javascript.rhino"><CODE>JSDocInfo</CODE></A> contains a type for <code>@return</code>
|
||
|
|
annotation.
|
||
|
|
<P>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="getType()"><!-- --></A><H3>
|
||
|
|
getType</H3>
|
||
|
|
<PRE>
|
||
|
|
public <A HREF="../../../../com/google/javascript/rhino/JSTypeExpression.html" title="class in com.google.javascript.rhino">JSTypeExpression</A> <B>getType</B>()</PRE>
|
||
|
|
<DL>
|
||
|
|
<DD>Gets the type specified by the <code>@type</code> annotation.
|
||
|
|
<P>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="getReturnType()"><!-- --></A><H3>
|
||
|
|
getReturnType</H3>
|
||
|
|
<PRE>
|
||
|
|
public <A HREF="../../../../com/google/javascript/rhino/JSTypeExpression.html" title="class in com.google.javascript.rhino">JSTypeExpression</A> <B>getReturnType</B>()</PRE>
|
||
|
|
<DL>
|
||
|
|
<DD>Gets the return type specified by the <code>@return</code> annotation.
|
||
|
|
<P>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="getEnumParameterType()"><!-- --></A><H3>
|
||
|
|
getEnumParameterType</H3>
|
||
|
|
<PRE>
|
||
|
|
public <A HREF="../../../../com/google/javascript/rhino/JSTypeExpression.html" title="class in com.google.javascript.rhino">JSTypeExpression</A> <B>getEnumParameterType</B>()</PRE>
|
||
|
|
<DL>
|
||
|
|
<DD>Gets the enum parameter type specified by the <code>@enum</code> annotation.
|
||
|
|
<P>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="getTypedefType()"><!-- --></A><H3>
|
||
|
|
getTypedefType</H3>
|
||
|
|
<PRE>
|
||
|
|
public <A HREF="../../../../com/google/javascript/rhino/JSTypeExpression.html" title="class in com.google.javascript.rhino">JSTypeExpression</A> <B>getTypedefType</B>()</PRE>
|
||
|
|
<DL>
|
||
|
|
<DD>Gets the typedef type specified by the <code>@type</code> annotation.
|
||
|
|
<P>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="getThisType()"><!-- --></A><H3>
|
||
|
|
getThisType</H3>
|
||
|
|
<PRE>
|
||
|
|
public <A HREF="../../../../com/google/javascript/rhino/JSTypeExpression.html" title="class in com.google.javascript.rhino">JSTypeExpression</A> <B>getThisType</B>()</PRE>
|
||
|
|
<DL>
|
||
|
|
<DD>Gets the type specified by the <code>@this</code> annotation.
|
||
|
|
<P>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="hasThisType()"><!-- --></A><H3>
|
||
|
|
hasThisType</H3>
|
||
|
|
<PRE>
|
||
|
|
public boolean <B>hasThisType</B>()</PRE>
|
||
|
|
<DL>
|
||
|
|
<DD>Returns whether this <A HREF="../../../../com/google/javascript/rhino/JSDocInfo.html" title="class in com.google.javascript.rhino"><CODE>JSDocInfo</CODE></A> contains a type for <code>@this</code>
|
||
|
|
annotation.
|
||
|
|
<P>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="getBaseType()"><!-- --></A><H3>
|
||
|
|
getBaseType</H3>
|
||
|
|
<PRE>
|
||
|
|
public <A HREF="../../../../com/google/javascript/rhino/JSTypeExpression.html" title="class in com.google.javascript.rhino">JSTypeExpression</A> <B>getBaseType</B>()</PRE>
|
||
|
|
<DL>
|
||
|
|
<DD>Gets the base type specified by the <code>@extends</code> annotation.
|
||
|
|
<P>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="getDescription()"><!-- --></A><H3>
|
||
|
|
getDescription</H3>
|
||
|
|
<PRE>
|
||
|
|
public <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getDescription</B>()</PRE>
|
||
|
|
<DL>
|
||
|
|
<DD>Gets the description specified by the <code>@desc</code> annotation.
|
||
|
|
<P>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="getMeaning()"><!-- --></A><H3>
|
||
|
|
getMeaning</H3>
|
||
|
|
<PRE>
|
||
|
|
public <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getMeaning</B>()</PRE>
|
||
|
|
<DL>
|
||
|
|
<DD>Gets the meaning specified by the <code>@meaning</code> annotation.
|
||
|
|
|
||
|
|
In localization systems, two messages with the same content but
|
||
|
|
different "meanings" may be translated differently. By default, we
|
||
|
|
use the name of the variable that the message is initialized to as
|
||
|
|
the "meaning" of the message.
|
||
|
|
|
||
|
|
But some code generators (like Closure Templates) inject their own
|
||
|
|
meaning with the jsdoc <code>@meaning</code> annotation.
|
||
|
|
<P>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="getLendsName()"><!-- --></A><H3>
|
||
|
|
getLendsName</H3>
|
||
|
|
<PRE>
|
||
|
|
public <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getLendsName</B>()</PRE>
|
||
|
|
<DL>
|
||
|
|
<DD>Gets the name we're lending to in a <code>@lends</code> annotation.
|
||
|
|
|
||
|
|
In many reflection APIs, you pass an anonymous object to a function,
|
||
|
|
and that function mixes the anonymous object into another object.
|
||
|
|
The <code>@lends</code> annotation allows the type system to track
|
||
|
|
those property assignments.
|
||
|
|
<P>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="getLicense()"><!-- --></A><H3>
|
||
|
|
getLicense</H3>
|
||
|
|
<PRE>
|
||
|
|
public <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getLicense</B>()</PRE>
|
||
|
|
<DL>
|
||
|
|
<DD>Gets the description specified by the <code>@license</code> annotation.
|
||
|
|
<P>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="setLicense(java.lang.String)"><!-- --></A><H3>
|
||
|
|
setLicense</H3>
|
||
|
|
<PRE>
|
||
|
|
public void <B>setLicense</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> license)</PRE>
|
||
|
|
<DL>
|
||
|
|
<DD>License directives can appear in multiple comments, and always
|
||
|
|
apply to the entire file. Break protection and allow outsiders to
|
||
|
|
update the license string so that we can attach the license text even
|
||
|
|
when the JSDocInfo has been created and tagged with other information.
|
||
|
|
<P>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
<DD><DL>
|
||
|
|
<DT><B>Parameters:</B><DD><CODE>license</CODE> - String containing new license text.</DL>
|
||
|
|
</DD>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="toString()"><!-- --></A><H3>
|
||
|
|
toString</H3>
|
||
|
|
<PRE>
|
||
|
|
public <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>toString</B>()</PRE>
|
||
|
|
<DL>
|
||
|
|
<DD><DL>
|
||
|
|
<DT><B>Overrides:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</A></CODE> in class <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></CODE></DL>
|
||
|
|
</DD>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="hasBaseType()"><!-- --></A><H3>
|
||
|
|
hasBaseType</H3>
|
||
|
|
<PRE>
|
||
|
|
public boolean <B>hasBaseType</B>()</PRE>
|
||
|
|
<DL>
|
||
|
|
<DD>Returns whether this <A HREF="../../../../com/google/javascript/rhino/JSDocInfo.html" title="class in com.google.javascript.rhino"><CODE>JSDocInfo</CODE></A> contains a type for <code>@extends</code>
|
||
|
|
annotation.
|
||
|
|
<P>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="getImplementedInterfaces()"><!-- --></A><H3>
|
||
|
|
getImplementedInterfaces</H3>
|
||
|
|
<PRE>
|
||
|
|
public <A HREF="http://java.sun.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="../../../../com/google/javascript/rhino/JSTypeExpression.html" title="class in com.google.javascript.rhino">JSTypeExpression</A>> <B>getImplementedInterfaces</B>()</PRE>
|
||
|
|
<DL>
|
||
|
|
<DD>Returns the types specified by the <code>@implements</code> annotation.
|
||
|
|
<P>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
<DD><DL>
|
||
|
|
|
||
|
|
<DT><B>Returns:</B><DD>An immutable list of JSTypeExpression objects that can
|
||
|
|
be resolved to types.</DL>
|
||
|
|
</DD>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="getImplementedInterfaceCount()"><!-- --></A><H3>
|
||
|
|
getImplementedInterfaceCount</H3>
|
||
|
|
<PRE>
|
||
|
|
public int <B>getImplementedInterfaceCount</B>()</PRE>
|
||
|
|
<DL>
|
||
|
|
<DD>Gets the number of interfaces specified by the <code>@implements</code>
|
||
|
|
annotation.
|
||
|
|
<P>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="getExtendedInterfaces()"><!-- --></A><H3>
|
||
|
|
getExtendedInterfaces</H3>
|
||
|
|
<PRE>
|
||
|
|
public <A HREF="http://java.sun.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="../../../../com/google/javascript/rhino/JSTypeExpression.html" title="class in com.google.javascript.rhino">JSTypeExpression</A>> <B>getExtendedInterfaces</B>()</PRE>
|
||
|
|
<DL>
|
||
|
|
<DD>Returns the interfaces extended by an interface
|
||
|
|
<P>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
<DD><DL>
|
||
|
|
|
||
|
|
<DT><B>Returns:</B><DD>An immutable list of JSTypeExpression objects that can
|
||
|
|
be resolved to types.</DL>
|
||
|
|
</DD>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="getExtendedInterfacesCount()"><!-- --></A><H3>
|
||
|
|
getExtendedInterfacesCount</H3>
|
||
|
|
<PRE>
|
||
|
|
public int <B>getExtendedInterfacesCount</B>()</PRE>
|
||
|
|
<DL>
|
||
|
|
<DD>Gets the number of extended interfaces specified
|
||
|
|
<P>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="getDeprecationReason()"><!-- --></A><H3>
|
||
|
|
getDeprecationReason</H3>
|
||
|
|
<PRE>
|
||
|
|
public <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getDeprecationReason</B>()</PRE>
|
||
|
|
<DL>
|
||
|
|
<DD>Returns the deprecation reason or null if none specified.
|
||
|
|
<P>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="getSuppressions()"><!-- --></A><H3>
|
||
|
|
getSuppressions</H3>
|
||
|
|
<PRE>
|
||
|
|
public <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</A><<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>> <B>getSuppressions</B>()</PRE>
|
||
|
|
<DL>
|
||
|
|
<DD>Returns the set of suppressed warnings.
|
||
|
|
<P>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="getModifies()"><!-- --></A><H3>
|
||
|
|
getModifies</H3>
|
||
|
|
<PRE>
|
||
|
|
public <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</A><<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>> <B>getModifies</B>()</PRE>
|
||
|
|
<DL>
|
||
|
|
<DD>Returns the set of sideeffect notations.
|
||
|
|
<P>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="hasDescriptionForParameter(java.lang.String)"><!-- --></A><H3>
|
||
|
|
hasDescriptionForParameter</H3>
|
||
|
|
<PRE>
|
||
|
|
public boolean <B>hasDescriptionForParameter</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name)</PRE>
|
||
|
|
<DL>
|
||
|
|
<DD>Returns whether a description exists for the parameter with the specified
|
||
|
|
name.
|
||
|
|
<P>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="getDescriptionForParameter(java.lang.String)"><!-- --></A><H3>
|
||
|
|
getDescriptionForParameter</H3>
|
||
|
|
<PRE>
|
||
|
|
public <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getDescriptionForParameter</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name)</PRE>
|
||
|
|
<DL>
|
||
|
|
<DD>Returns the description for the parameter with the given name, if its
|
||
|
|
exists.
|
||
|
|
<P>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="getAuthors()"><!-- --></A><H3>
|
||
|
|
getAuthors</H3>
|
||
|
|
<PRE>
|
||
|
|
public <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A><<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>> <B>getAuthors</B>()</PRE>
|
||
|
|
<DL>
|
||
|
|
<DD>Returns the list of authors or null if none.
|
||
|
|
<P>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="getReferences()"><!-- --></A><H3>
|
||
|
|
getReferences</H3>
|
||
|
|
<PRE>
|
||
|
|
public <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A><<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>> <B>getReferences</B>()</PRE>
|
||
|
|
<DL>
|
||
|
|
<DD>Returns the list of references or null if none.
|
||
|
|
<P>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="getVersion()"><!-- --></A><H3>
|
||
|
|
getVersion</H3>
|
||
|
|
<PRE>
|
||
|
|
public <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getVersion</B>()</PRE>
|
||
|
|
<DL>
|
||
|
|
<DD>Returns the version or null if none.
|
||
|
|
<P>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="getReturnDescription()"><!-- --></A><H3>
|
||
|
|
getReturnDescription</H3>
|
||
|
|
<PRE>
|
||
|
|
public <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getReturnDescription</B>()</PRE>
|
||
|
|
<DL>
|
||
|
|
<DD>Returns the description of the returned object or null if none specified.
|
||
|
|
<P>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="getBlockDescription()"><!-- --></A><H3>
|
||
|
|
getBlockDescription</H3>
|
||
|
|
<PRE>
|
||
|
|
public <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getBlockDescription</B>()</PRE>
|
||
|
|
<DL>
|
||
|
|
<DD>Returns the block-level description or null if none specified.
|
||
|
|
<P>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="hasFileOverview()"><!-- --></A><H3>
|
||
|
|
hasFileOverview</H3>
|
||
|
|
<PRE>
|
||
|
|
public boolean <B>hasFileOverview</B>()</PRE>
|
||
|
|
<DL>
|
||
|
|
<DD>Returns whether this has a fileoverview flag.
|
||
|
|
<P>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="getFileOverview()"><!-- --></A><H3>
|
||
|
|
getFileOverview</H3>
|
||
|
|
<PRE>
|
||
|
|
public <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getFileOverview</B>()</PRE>
|
||
|
|
<DL>
|
||
|
|
<DD>Returns the file overview or null if none specified.
|
||
|
|
<P>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="getAssociatedNode()"><!-- --></A><H3>
|
||
|
|
getAssociatedNode</H3>
|
||
|
|
<PRE>
|
||
|
|
public <A HREF="../../../../com/google/javascript/rhino/Node.html" title="class in com.google.javascript.rhino">Node</A> <B>getAssociatedNode</B>()</PRE>
|
||
|
|
<DL>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="setAssociatedNode(com.google.javascript.rhino.Node)"><!-- --></A><H3>
|
||
|
|
setAssociatedNode</H3>
|
||
|
|
<PRE>
|
||
|
|
public void <B>setAssociatedNode</B>(<A HREF="../../../../com/google/javascript/rhino/Node.html" title="class in com.google.javascript.rhino">Node</A> node)</PRE>
|
||
|
|
<DL>
|
||
|
|
<DD>Sets the node associated with this JSDoc.
|
||
|
|
Notice that many nodes may have pointer to the same JSDocInfo
|
||
|
|
object (because we propagate it across the type graph). But there
|
||
|
|
is only one canonical "owner" node of the JSDocInfo, which corresponds
|
||
|
|
to its original place in the syntax tree.
|
||
|
|
<P>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="getSourceName()"><!-- --></A><H3>
|
||
|
|
getSourceName</H3>
|
||
|
|
<PRE>
|
||
|
|
public <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getSourceName</B>()</PRE>
|
||
|
|
<DL>
|
||
|
|
<DD>Gets the name of the source file that contains this JSDoc.
|
||
|
|
<P>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="getMarkers()"><!-- --></A><H3>
|
||
|
|
getMarkers</H3>
|
||
|
|
<PRE>
|
||
|
|
public <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A><<A HREF="../../../../com/google/javascript/rhino/JSDocInfo.Marker.html" title="class in com.google.javascript.rhino">JSDocInfo.Marker</A>> <B>getMarkers</B>()</PRE>
|
||
|
|
<DL>
|
||
|
|
<DD>Gets the list of all markers for the documentation in this JSDoc.
|
||
|
|
<P>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="getTemplateTypeName()"><!-- --></A><H3>
|
||
|
|
getTemplateTypeName</H3>
|
||
|
|
<PRE>
|
||
|
|
public <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getTemplateTypeName</B>()</PRE>
|
||
|
|
<DL>
|
||
|
|
<DD>Gets the template type name.
|
||
|
|
<P>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="getTypeNodes()"><!-- --></A><H3>
|
||
|
|
getTypeNodes</H3>
|
||
|
|
<PRE>
|
||
|
|
public <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A><<A HREF="../../../../com/google/javascript/rhino/Node.html" title="class in com.google.javascript.rhino">Node</A>> <B>getTypeNodes</B>()</PRE>
|
||
|
|
<DL>
|
||
|
|
<DD>Returns a collection of all type nodes that are a part of this JSDocInfo.
|
||
|
|
This includes @type, @this, @extends, @implements, @param, @throws,
|
||
|
|
and @return. Any future type specific JSDoc should make sure to add the
|
||
|
|
appropriate nodes here.
|
||
|
|
<P>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
<DD><DL>
|
||
|
|
|
||
|
|
<DT><B>Returns:</B><DD>collection of all type nodes</DL>
|
||
|
|
</DD>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="hasModifies()"><!-- --></A><H3>
|
||
|
|
hasModifies</H3>
|
||
|
|
<PRE>
|
||
|
|
public boolean <B>hasModifies</B>()</PRE>
|
||
|
|
<DL>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="getOriginalCommentString()"><!-- --></A><H3>
|
||
|
|
getOriginalCommentString</H3>
|
||
|
|
<PRE>
|
||
|
|
public <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getOriginalCommentString</B>()</PRE>
|
||
|
|
<DL>
|
||
|
|
<DD>Returns the original JSDoc comment string. Returns null unless
|
||
|
|
parseJsDocDocumentation is enabled via the ParserConfig.
|
||
|
|
<P>
|
||
|
|
<DD><DL>
|
||
|
|
</DL>
|
||
|
|
</DD>
|
||
|
|
<DD><DL>
|
||
|
|
</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="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-all.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="../../../../com/google/javascript/rhino/IR.html" title="class in com.google.javascript.rhino"><B>PREV CLASS</B></A>
|
||
|
|
<A HREF="../../../../com/google/javascript/rhino/JSDocInfo.Marker.html" title="class in com.google.javascript.rhino"><B>NEXT CLASS</B></A></FONT></TD>
|
||
|
|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||
|
|
<A HREF="../../../../index.html?com/google/javascript/rhino/JSDocInfo.html" target="_top"><B>FRAMES</B></A>
|
||
|
|
<A HREF="JSDocInfo.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: <A HREF="#nested_class_summary">NESTED</A> | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
||
|
|
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||
|
|
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
||
|
|
</TR>
|
||
|
|
</TABLE>
|
||
|
|
<A NAME="skip-navbar_bottom"></A>
|
||
|
|
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
||
|
|
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<div id="footer">
|
||
|
|
<div id="footerlogo">
|
||
|
|
<img src="http://www.google.com/images/art.gif"
|
||
|
|
alt="Google colored balls">
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div id="copyright">
|
||
|
|
<p>© 2009 Google -
|
||
|
|
<a href="http://www.google.com/privacy.html">Privacy Policy</a> -
|
||
|
|
<a href="http://www.google.com/terms_of_service.html">Terms and Conditions</a> -
|
||
|
|
<a href="http://www.google.com/about.html">About Google</a>
|
||
|
|
</p>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
</BODY>
|
||
|
|
</HTML>
|