Package com.google.javascript.rhino
Class JSDocInfo.Marker
java.lang.Object
com.google.javascript.rhino.JSDocInfo.Marker
- Enclosing class:
- JSDocInfo
Defines a class for containing the parsing information
for this JSDocInfo. For each annotation found in the
JsDoc, a marker will be created indicating the annotation
itself, the name of the annotation (if any; for example,
a @param has a name, but a @return does not), the
textual description found on that annotation and, if applicable,
the type declaration. All this information is only collected
if documentation collection is turned on.
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionGets the position information for the annotation name.Gets the position information for the description found in a block tag.getName()
Deprecated.Use #getNameNodeGets the position information for the name found in an @param tag.getType()
Gets the position information for the type expression found in some block tags, like "@param" and "@return".
-
Constructor Details
-
Marker
public Marker()
-
-
Method Details
-
getAnnotation
Gets the position information for the annotation name. (e.g., "param") -
getName
Deprecated.Use #getNameNodeGets the position information for the name found in a @param tag. -
getNameNode
Gets the position information for the name found in an @param tag. -
getDescription
Gets the position information for the description found in a block tag. -
getType
Gets the position information for the type expression found in some block tags, like "@param" and "@return".
-