Package com.google.javascript.rhino
Class JSDocInfo.Marker
- java.lang.Object
-
- com.google.javascript.rhino.JSDocInfo.Marker
-
- Enclosing class:
- JSDocInfo
public static final class JSDocInfo.Marker extends java.lang.ObjectDefines 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
Constructors Constructor Description Marker()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description JSDocInfo.StringPositiongetAnnotation()Gets the position information for the annotation name.JSDocInfo.StringPositiongetDescription()Gets the position information for the description found in a block tag.JSDocInfo.NamePositiongetNameNode()Gets the position information for the name found in an @param tag.JSDocInfo.TypePositiongetType()Gets the position information for the type expression found in some block tags, like "@param" and "@return".
-
-
-
Method Detail
-
getAnnotation
public JSDocInfo.StringPosition getAnnotation()
Gets the position information for the annotation name. (e.g., "param")
-
getNameNode
public JSDocInfo.NamePosition getNameNode()
Gets the position information for the name found in an @param tag.
-
getDescription
public JSDocInfo.StringPosition getDescription()
Gets the position information for the description found in a block tag.
-
getType
public JSDocInfo.TypePosition getType()
Gets the position information for the type expression found in some block tags, like "@param" and "@return".
-
-