Package com.google.javascript.jscomp

Class ConformanceRules.RequireFileoverviewVisibility

java.lang.Object

com.google.javascript.jscomp.ConformanceRules.AbstractRule

com.google.javascript.jscomp.ConformanceRules.RequireFileoverviewVisibility

All Implemented Interfaces:

CheckConformance.Rule

Enclosing class:

ConformanceRules

public static final class ConformanceRules.RequireFileoverviewVisibility
extends ConformanceRules.AbstractRule

Requires source files to contain a top-level @fileoverview block with an explicit visibility annotation.

Constructor Summary

Constructors

Constructor	Description
RequireFileoverviewVisibility(AbstractCompiler compiler, com.google.javascript.jscomp.Requirement requirement)

Method Summary

Modifier and Type	Method	Description
protected ConformanceRules.ConformanceResult	checkConformance(NodeTraversal t, Node n)

Methods inherited from class com.google.javascript.jscomp.ConformanceRules.AbstractRule

check, report, tsIsAllowlisted

Methods inherited from class java.lang.Object

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

Constructor Detail

RequireFileoverviewVisibility

public RequireFileoverviewVisibility(AbstractCompiler compiler,
                                     com.google.javascript.jscomp.Requirement requirement)
                              throws CheckConformance.InvalidRequirementSpec

Throws:

CheckConformance.InvalidRequirementSpec

Method Detail

checkConformance

protected ConformanceRules.ConformanceResult checkConformance(NodeTraversal t,
                                                              Node n)

Specified by:

checkConformance in class ConformanceRules.AbstractRule

Returns:

Whether the code represented by the Node conforms to the rule.