Skip to content

Commit

Permalink
Latest docs on successful build 6672 auto-pushed to gh-pages
Browse files Browse the repository at this point in the history
  • Loading branch information
copybara-service[bot] committed Sep 18, 2024
1 parent a892c28 commit dc0ebd9
Show file tree
Hide file tree
Showing 9 changed files with 1,251 additions and 1,218 deletions.

Large diffs are not rendered by default.

26 changes: 22 additions & 4 deletions api/latest/com/google/errorprone/bugpatterns/MemberName.html
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,7 @@
</li>
<li><a href="#method-detail" tabindex="0">Method Details</a>
<ol class="toc-list">
<li><a href="#matchClass(com.sun.source.tree.ClassTree,com.google.errorprone.VisitorState)" tabindex="0">matchClass(ClassTree, VisitorState)</a></li>
<li><a href="#matchMethod(com.sun.source.tree.MethodTree,com.google.errorprone.VisitorState)" tabindex="0">matchMethod(MethodTree, VisitorState)</a></li>
<li><a href="#matchVariable(com.sun.source.tree.VariableTree,com.google.errorprone.VisitorState)" tabindex="0">matchVariable(VariableTree, VisitorState)</a></li>
</ol>
Expand All @@ -91,13 +92,13 @@ <h1 title="Class MemberName" class="title">Class MemberName</h1>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="BugChecker.MethodTreeMatcher.html" title="interface in com.google.errorprone.bugpatterns">BugChecker.MethodTreeMatcher</a></code>, <code><a href="BugChecker.VariableTreeMatcher.html" title="interface in com.google.errorprone.bugpatterns">BugChecker.VariableTreeMatcher</a></code>, <code><a href="../matchers/Suppressible.html" title="interface in com.google.errorprone.matchers">Suppressible</a></code>, <code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a></code></dd>
<dd><code><a href="BugChecker.ClassTreeMatcher.html" title="interface in com.google.errorprone.bugpatterns">BugChecker.ClassTreeMatcher</a></code>, <code><a href="BugChecker.MethodTreeMatcher.html" title="interface in com.google.errorprone.bugpatterns">BugChecker.MethodTreeMatcher</a></code>, <code><a href="BugChecker.VariableTreeMatcher.html" title="interface in com.google.errorprone.bugpatterns">BugChecker.VariableTreeMatcher</a></code>, <code><a href="../matchers/Suppressible.html" title="interface in com.google.errorprone.matchers">Suppressible</a></code>, <code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a></code></dd>
</dl>
<hr>
<div class="horizontal-scroll">
<div class="type-signature"><span class="modifiers">public final class </span><span class="element-name type-name-label">MemberName</span>
<span class="extends-implements">extends <a href="BugChecker.html" title="class in com.google.errorprone.bugpatterns">BugChecker</a>
implements <a href="BugChecker.MethodTreeMatcher.html" title="interface in com.google.errorprone.bugpatterns">BugChecker.MethodTreeMatcher</a>, <a href="BugChecker.VariableTreeMatcher.html" title="interface in com.google.errorprone.bugpatterns">BugChecker.VariableTreeMatcher</a></span></div>
implements <a href="BugChecker.ClassTreeMatcher.html" title="interface in com.google.errorprone.bugpatterns">BugChecker.ClassTreeMatcher</a>, <a href="BugChecker.MethodTreeMatcher.html" title="interface in com.google.errorprone.bugpatterns">BugChecker.MethodTreeMatcher</a>, <a href="BugChecker.VariableTreeMatcher.html" title="interface in com.google.errorprone.bugpatterns">BugChecker.VariableTreeMatcher</a></span></div>
<div class="block">Flags a few ways in which member names may violate the style guide.</div>
<dl class="notes">
<dt>See Also:</dt>
Expand Down Expand Up @@ -145,13 +146,17 @@ <h2>Method Summary</h2>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../matchers/Description.html" title="class in com.google.errorprone.matchers">Description</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#matchMethod(com.sun.source.tree.MethodTree,com.google.errorprone.VisitorState)" class="member-name-link">matchMethod</a><wbr>(com.sun.source.tree.MethodTree&nbsp;tree,
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#matchClass(com.sun.source.tree.ClassTree,com.google.errorprone.VisitorState)" class="member-name-link">matchClass</a><wbr>(com.sun.source.tree.ClassTree&nbsp;tree,
<a href="../VisitorState.html" title="class in com.google.errorprone">VisitorState</a>&nbsp;state)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../matchers/Description.html" title="class in com.google.errorprone.matchers">Description</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#matchVariable(com.sun.source.tree.VariableTree,com.google.errorprone.VisitorState)" class="member-name-link">matchVariable</a><wbr>(com.sun.source.tree.VariableTree&nbsp;tree,
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#matchMethod(com.sun.source.tree.MethodTree,com.google.errorprone.VisitorState)" class="member-name-link">matchMethod</a><wbr>(com.sun.source.tree.MethodTree&nbsp;tree,
<a href="../VisitorState.html" title="class in com.google.errorprone">VisitorState</a>&nbsp;state)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../matchers/Description.html" title="class in com.google.errorprone.matchers">Description</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#matchVariable(com.sun.source.tree.VariableTree,com.google.errorprone.VisitorState)" class="member-name-link">matchVariable</a><wbr>(com.sun.source.tree.VariableTree&nbsp;tree,
<a href="../VisitorState.html" title="class in com.google.errorprone">VisitorState</a>&nbsp;state)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
</div>
</div>
</div>
Expand Down Expand Up @@ -192,6 +197,19 @@ <h3>MemberName</h3>
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="matchClass(com.sun.source.tree.ClassTree,com.google.errorprone.VisitorState)">
<h3>matchClass</h3>
<div class="horizontal-scroll">
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="../matchers/Description.html" title="class in com.google.errorprone.matchers">Description</a></span>&nbsp;<span class="element-name">matchClass</span><wbr><span class="parameters">(com.sun.source.tree.ClassTree&nbsp;tree,
<a href="../VisitorState.html" title="class in com.google.errorprone">VisitorState</a>&nbsp;state)</span></div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="BugChecker.ClassTreeMatcher.html#matchClass(com.sun.source.tree.ClassTree,com.google.errorprone.VisitorState)">matchClass</a></code>&nbsp;in interface&nbsp;<code><a href="BugChecker.ClassTreeMatcher.html" title="interface in com.google.errorprone.bugpatterns">BugChecker.ClassTreeMatcher</a></code></dd>
</dl>
</div>
</section>
</li>
<li>
<section class="detail" id="matchMethod(com.sun.source.tree.MethodTree,com.google.errorprone.VisitorState)">
<h3>matchMethod</h3>
<div class="horizontal-scroll">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -245,69 +245,74 @@ <h2>Uses of <a href="../BugChecker.ClassTreeMatcher.html" title="interface in co
<div class="col-second odd-row-color"><code><a href="../JUnitAmbiguousTestClass.html" class="type-name-link" title="class in com.google.errorprone.bugpatterns">JUnitAmbiguousTestClass</a></code></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><code>final class&nbsp;</code></div>
<div class="col-second even-row-color"><code><a href="../MissingRefasterAnnotation.html" class="type-name-link" title="class in com.google.errorprone.bugpatterns">MissingRefasterAnnotation</a></code></div>
<div class="col-second even-row-color"><code><a href="../MemberName.html" class="type-name-link" title="class in com.google.errorprone.bugpatterns">MemberName</a></code></div>
<div class="col-last even-row-color">
<div class="block">A <a href="../BugChecker.html" title="class in com.google.errorprone.bugpatterns"><code>BugChecker</code></a>; see the associated <a href="../../BugPattern.html" title="annotation in com.google.errorprone"><code>BugPattern</code></a> annotation for details.</div>
<div class="block">Flags a few ways in which member names may violate the style guide.</div>
</div>
<div class="col-first odd-row-color"><code>class&nbsp;</code></div>
<div class="col-second odd-row-color"><code><a href="../MultiVariableDeclaration.html" class="type-name-link" title="class in com.google.errorprone.bugpatterns">MultiVariableDeclaration</a></code></div>
<div class="col-first odd-row-color"><code>final class&nbsp;</code></div>
<div class="col-second odd-row-color"><code><a href="../MissingRefasterAnnotation.html" class="type-name-link" title="class in com.google.errorprone.bugpatterns">MissingRefasterAnnotation</a></code></div>
<div class="col-last odd-row-color">
<div class="block">A <a href="../BugChecker.html" title="class in com.google.errorprone.bugpatterns"><code>BugChecker</code></a>; see the associated <a href="../../BugPattern.html" title="annotation in com.google.errorprone"><code>BugPattern</code></a> annotation for details.</div>
</div>
<div class="col-first even-row-color"><code>class&nbsp;</code></div>
<div class="col-second even-row-color"><code><a href="../MustBeClosedChecker.html" class="type-name-link" title="class in com.google.errorprone.bugpatterns">MustBeClosedChecker</a></code></div>
<div class="col-second even-row-color"><code><a href="../MultiVariableDeclaration.html" class="type-name-link" title="class in com.google.errorprone.bugpatterns">MultiVariableDeclaration</a></code></div>
<div class="col-last even-row-color">
<div class="block">Checks if a constructor or method annotated with <a href="../../annotations/MustBeClosed.html" title="annotation in com.google.errorprone.annotations"><code>MustBeClosed</code></a> is called within the
resource variable initializer of a try-with-resources statement.</div>
<div class="block">A <a href="../BugChecker.html" title="class in com.google.errorprone.bugpatterns"><code>BugChecker</code></a>; see the associated <a href="../../BugPattern.html" title="annotation in com.google.errorprone"><code>BugPattern</code></a> annotation for details.</div>
</div>
<div class="col-first odd-row-color"><code>final class&nbsp;</code></div>
<div class="col-second odd-row-color"><code><a href="../NamedLikeContextualKeyword.html" class="type-name-link" title="class in com.google.errorprone.bugpatterns">NamedLikeContextualKeyword</a></code></div>
<div class="col-first odd-row-color"><code>class&nbsp;</code></div>
<div class="col-second odd-row-color"><code><a href="../MustBeClosedChecker.html" class="type-name-link" title="class in com.google.errorprone.bugpatterns">MustBeClosedChecker</a></code></div>
<div class="col-last odd-row-color">
<div class="block">Warns on classes or methods being named similarly to contextual keywords, or invoking such
methods.</div>
<div class="block">Checks if a constructor or method annotated with <a href="../../annotations/MustBeClosed.html" title="annotation in com.google.errorprone.annotations"><code>MustBeClosed</code></a> is called within the
resource variable initializer of a try-with-resources statement.</div>
</div>
<div class="col-first even-row-color"><code>final class&nbsp;</code></div>
<div class="col-second even-row-color"><code><a href="../OverrideThrowableToString.html" class="type-name-link" title="class in com.google.errorprone.bugpatterns">OverrideThrowableToString</a></code></div>
<div class="col-second even-row-color"><code><a href="../NamedLikeContextualKeyword.html" class="type-name-link" title="class in com.google.errorprone.bugpatterns">NamedLikeContextualKeyword</a></code></div>
<div class="col-last even-row-color">
<div class="block">Warns against overriding toString() in a Throwable class and suggests getMessage()</div>
<div class="block">Warns on classes or methods being named similarly to contextual keywords, or invoking such
methods.</div>
</div>
<div class="col-first odd-row-color"><code>final class&nbsp;</code></div>
<div class="col-second odd-row-color"><code><a href="../ParametersButNotParameterized.html" class="type-name-link" title="class in com.google.errorprone.bugpatterns">ParametersButNotParameterized</a></code></div>
<div class="col-second odd-row-color"><code><a href="../OverrideThrowableToString.html" class="type-name-link" title="class in com.google.errorprone.bugpatterns">OverrideThrowableToString</a></code></div>
<div class="col-last odd-row-color">
<div class="block">Flags uses of parameters in non-parameterized tests.</div>
</div>
<div class="col-first even-row-color"><code>final class&nbsp;</code></div>
<div class="col-second even-row-color"><code><a href="../PrivateConstructorForUtilityClass.html" class="type-name-link" title="class in com.google.errorprone.bugpatterns">PrivateConstructorForUtilityClass</a></code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code>class&nbsp;</code></div>
<div class="col-second odd-row-color"><code><a href="../ProtectedMembersInFinalClass.html" class="type-name-link" title="class in com.google.errorprone.bugpatterns">ProtectedMembersInFinalClass</a></code></div>
<div class="col-last odd-row-color">
<div class="block">Flags protected members in final classes.</div>
<div class="block">Warns against overriding toString() in a Throwable class and suggests getMessage()</div>
</div>
<div class="col-first even-row-color"><code>final class&nbsp;</code></div>
<div class="col-second even-row-color"><code><a href="../TestParametersNotInitialized.html" class="type-name-link" title="class in com.google.errorprone.bugpatterns">TestParametersNotInitialized</a></code></div>
<div class="col-second even-row-color"><code><a href="../ParametersButNotParameterized.html" class="type-name-link" title="class in com.google.errorprone.bugpatterns">ParametersButNotParameterized</a></code></div>
<div class="col-last even-row-color">
<div class="block">Flags uses of parameters in non-parameterized tests.</div>
</div>
<div class="col-first odd-row-color"><code>final class&nbsp;</code></div>
<div class="col-second odd-row-color"><code><a href="../TheoryButNoTheories.html" class="type-name-link" title="class in com.google.errorprone.bugpatterns">TheoryButNoTheories</a></code></div>
<div class="col-second odd-row-color"><code><a href="../PrivateConstructorForUtilityClass.html" class="type-name-link" title="class in com.google.errorprone.bugpatterns">PrivateConstructorForUtilityClass</a></code></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><code>class&nbsp;</code></div>
<div class="col-second even-row-color"><code><a href="../ProtectedMembersInFinalClass.html" class="type-name-link" title="class in com.google.errorprone.bugpatterns">ProtectedMembersInFinalClass</a></code></div>
<div class="col-last even-row-color">
<div class="block">Flags protected members in final classes.</div>
</div>
<div class="col-first odd-row-color"><code>final class&nbsp;</code></div>
<div class="col-second odd-row-color"><code><a href="../TestParametersNotInitialized.html" class="type-name-link" title="class in com.google.errorprone.bugpatterns">TestParametersNotInitialized</a></code></div>
<div class="col-last odd-row-color">
<div class="block">Flags uses of <code>@Theory</code> (and others) in non-<code>Theories</code>-run tests.</div>
<div class="block">Flags uses of parameters in non-parameterized tests.</div>
</div>
<div class="col-first even-row-color"><code>class&nbsp;</code></div>
<div class="col-second even-row-color"><code><a href="../TypeNameShadowing.html" class="type-name-link" title="class in com.google.errorprone.bugpatterns">TypeNameShadowing</a></code></div>
<div class="col-first even-row-color"><code>final class&nbsp;</code></div>
<div class="col-second even-row-color"><code><a href="../TheoryButNoTheories.html" class="type-name-link" title="class in com.google.errorprone.bugpatterns">TheoryButNoTheories</a></code></div>
<div class="col-last even-row-color">
<div class="block">Warns when a type parameter shadows another type name in scope.</div>
<div class="block">Flags uses of <code>@Theory</code> (and others) in non-<code>Theories</code>-run tests.</div>
</div>
<div class="col-first odd-row-color"><code>class&nbsp;</code></div>
<div class="col-second odd-row-color"><code><a href="../TypeParameterShadowing.html" class="type-name-link" title="class in com.google.errorprone.bugpatterns">TypeParameterShadowing</a></code></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-second odd-row-color"><code><a href="../TypeNameShadowing.html" class="type-name-link" title="class in com.google.errorprone.bugpatterns">TypeNameShadowing</a></code></div>
<div class="col-last odd-row-color">
<div class="block">Warns when a type parameter shadows another type name in scope.</div>
</div>
<div class="col-first even-row-color"><code>class&nbsp;</code></div>
<div class="col-second even-row-color"><code><a href="../UngroupedOverloads.html" class="type-name-link" title="class in com.google.errorprone.bugpatterns">UngroupedOverloads</a></code></div>
<div class="col-second even-row-color"><code><a href="../TypeParameterShadowing.html" class="type-name-link" title="class in com.google.errorprone.bugpatterns">TypeParameterShadowing</a></code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code>class&nbsp;</code></div>
<div class="col-second odd-row-color"><code><a href="../VarTypeName.html" class="type-name-link" title="class in com.google.errorprone.bugpatterns">VarTypeName</a></code></div>
<div class="col-last odd-row-color">
<div class="col-second odd-row-color"><code><a href="../UngroupedOverloads.html" class="type-name-link" title="class in com.google.errorprone.bugpatterns">UngroupedOverloads</a></code></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><code>class&nbsp;</code></div>
<div class="col-second even-row-color"><code><a href="../VarTypeName.html" class="type-name-link" title="class in com.google.errorprone.bugpatterns">VarTypeName</a></code></div>
<div class="col-last even-row-color">
<div class="block">A <a href="../BugChecker.html" title="class in com.google.errorprone.bugpatterns"><code>BugChecker</code></a>; see the associated <a href="../../BugPattern.html" title="annotation in com.google.errorprone"><code>BugPattern</code></a> annotation for details.</div>
</div>
</div>
Expand Down
Loading

0 comments on commit dc0ebd9

Please sign in to comment.