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 DiagnosticType	MISSING_PARAM_JSDOC
static DiagnosticType	MUST_BE_PRIVATE
static DiagnosticType	OPTIONAL_PARAM_NOT_MARKED_OPTIONAL
static DiagnosticType	OPTIONAL_TYPE_NOT_USING_OPTIONAL_NAME

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 parent) Visits a node in postorder (after its children have been visited).

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

MISSING_PARAM_JSDOC

public static final DiagnosticType MISSING_PARAM_JSDOC

MUST_BE_PRIVATE

public static final DiagnosticType MUST_BE_PRIVATE

OPTIONAL_PARAM_NOT_MARKED_OPTIONAL

public static final DiagnosticType OPTIONAL_PARAM_NOT_MARKED_OPTIONAL

OPTIONAL_TYPE_NOT_USING_OPTIONAL_NAME

public static final DiagnosticType OPTIONAL_TYPE_NOT_USING_OPTIONAL_NAME

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 parent)

Description copied from interface: NodeTraversal.Callback

Visits a node in postorder (after its children have been visited). A node is visited only if all its parents should be traversed (NodeTraversal.Callback.shouldTraverse(NodeTraversal, Node, Node)).

Implementations can have side effects (e.g. modifying the parse tree).

Specified by:

visit in interface NodeTraversal.Callback