com.google.javascript.jscomp.lint

Class CheckJSDocStyle

java.lang.Object

com.google.javascript.jscomp.NodeTraversal.AbstractPostOrderCallback

com.google.javascript.jscomp.lint.CheckJSDocStyle

All Implemented Interfaces:

CompilerPass, NodeTraversal.Callback

public final class CheckJSDocStyle
extends NodeTraversal.AbstractPostOrderCallback
implements CompilerPass

Checks for various JSDoc-related style issues, such as function definitions without JsDoc, params with no corresponding @param annotation, coding conventions not being respected, etc.

Field Summary

Fields

Modifier and Type	Field and Description
static DiagnosticGroup	ALL_DIAGNOSTICS
static DiagnosticType	CLASS_DISALLOWED_JSDOC
static DiagnosticType	EXTERNS_FILES_SHOULD_BE_ANNOTATED
static DiagnosticType	INCORRECT_ANNOTATION_ON_GETTER_SETTER
static DiagnosticType	INCORRECT_PARAM_NAME
static DiagnosticGroup	LINT_DIAGNOSTICS
static DiagnosticType	MISSING_JSDOC
static DiagnosticType	MISSING_PARAMETER_JSDOC
static DiagnosticType	MISSING_RETURN_JSDOC
static DiagnosticType	MIXED_PARAM_JSDOC_STYLES
static DiagnosticType	MUST_BE_PRIVATE
static DiagnosticType	MUST_HAVE_TRAILING_UNDERSCORE
static DiagnosticType	OPTIONAL_PARAM_NOT_MARKED_OPTIONAL
static DiagnosticType	PREFER_BACKTICKS_TO_AT_SIGN_CODE
static DiagnosticGroup	UNDERSCORE_DIAGNOSTICS
static DiagnosticType	WRONG_NUMBER_OF_PARAMS

Constructor Summary

Constructors

Constructor and Description
CheckJSDocStyle(AbstractCompiler compiler)

Method Summary

Modifier and Type	Method and Description
void	process(Node externs, Node root) Process the JS with root node root.
void	visit(NodeTraversal t, Node n, Node unused) Visits a node in postorder (after its children).

Methods inherited from class com.google.javascript.jscomp.NodeTraversal.AbstractPostOrderCallback

shouldTraverse

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CLASS_DISALLOWED_JSDOC

public static final DiagnosticType CLASS_DISALLOWED_JSDOC

MISSING_JSDOC

public static final DiagnosticType MISSING_JSDOC

INCORRECT_ANNOTATION_ON_GETTER_SETTER

public static final DiagnosticType INCORRECT_ANNOTATION_ON_GETTER_SETTER

MISSING_PARAMETER_JSDOC

public static final DiagnosticType MISSING_PARAMETER_JSDOC

MIXED_PARAM_JSDOC_STYLES

public static final DiagnosticType MIXED_PARAM_JSDOC_STYLES

MISSING_RETURN_JSDOC

public static final DiagnosticType MISSING_RETURN_JSDOC

MUST_BE_PRIVATE

public static final DiagnosticType MUST_BE_PRIVATE

MUST_HAVE_TRAILING_UNDERSCORE

public static final DiagnosticType MUST_HAVE_TRAILING_UNDERSCORE

OPTIONAL_PARAM_NOT_MARKED_OPTIONAL

public static final DiagnosticType OPTIONAL_PARAM_NOT_MARKED_OPTIONAL

WRONG_NUMBER_OF_PARAMS

public static final DiagnosticType WRONG_NUMBER_OF_PARAMS

INCORRECT_PARAM_NAME

public static final DiagnosticType INCORRECT_PARAM_NAME

EXTERNS_FILES_SHOULD_BE_ANNOTATED

public static final DiagnosticType EXTERNS_FILES_SHOULD_BE_ANNOTATED

PREFER_BACKTICKS_TO_AT_SIGN_CODE

public static final DiagnosticType PREFER_BACKTICKS_TO_AT_SIGN_CODE

LINT_DIAGNOSTICS

public static final DiagnosticGroup LINT_DIAGNOSTICS

UNDERSCORE_DIAGNOSTICS

public static final DiagnosticGroup UNDERSCORE_DIAGNOSTICS

ALL_DIAGNOSTICS

public static final DiagnosticGroup ALL_DIAGNOSTICS

Constructor Detail

CheckJSDocStyle

public CheckJSDocStyle(AbstractCompiler compiler)

Method Detail

process

public void process(Node externs,
                    Node root)

Description copied from interface: CompilerPass

Process the JS with root node root. Can modify the contents of each Node tree

Specified by:

process in interface CompilerPass

Parameters:

externs - Top of external JS tree

root - Top of JS tree

visit

public void visit(NodeTraversal t,
                  Node n,
                  Node unused)

Description copied from interface: NodeTraversal.Callback

Visits a node in postorder (after its children). A node is visited in postorder iff NodeTraversal.Callback.shouldTraverse(NodeTraversal, Node, Node) returned true for its parent. In particular, the root node is never visited in postorder.

Siblings are always visited left-to-right.

Implementations can have side-effects (e.g. modify the parse tree). Removing the current node is legal, but removing or reordering nodes above the current node may cause nodes to be visited twice or not at all.

Specified by:

visit in interface NodeTraversal.Callback

Parameters:

t - The current traversal.

n - The current node.

unused - The parent of the current node.