Skip to content

Commit

Permalink
Latest docs on successful build 5894 auto-pushed to gh-pages
Browse files Browse the repository at this point in the history
  • Loading branch information
copybara-service[bot] committed Jan 4, 2024
1 parent 791d5b2 commit 4acf1b9
Show file tree
Hide file tree
Showing 4 changed files with 33 additions and 20 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -135,8 +135,10 @@ <h2>Method Summary</h2>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3 method-summary-table-tab6"><code><a href="MethodMatchers.MethodSignatureMatcher.html" title="interface in com.google.errorprone.matchers.method">MethodMatchers.MethodSignatureMatcher</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3 method-summary-table-tab6"><code><a href="#withSignature(java.lang.String)" class="member-name-link">withSignature</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;signature)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3 method-summary-table-tab6">
<div class="block"><span class="deprecated-label">Deprecated.</span></div>
<div class="block">Match methods with the given signature.</div>
<div class="block"><span class="deprecated-label">Deprecated.</span>
<div class="deprecation-comment">The implementation uses javac internals to pretty-print the signatures, and the
signature format is not well-specified.</div>
</div>
</div>
</div>
</div>
Expand Down Expand Up @@ -198,11 +200,13 @@ <h3>withNameMatching</h3>
<li>
<section class="detail" id="withSignature(java.lang.String)">
<h3>withSignature</h3>
<div class="member-signature"><span class="return-type"><a href="MethodMatchers.MethodSignatureMatcher.html" title="interface in com.google.errorprone.matchers.method">MethodMatchers.MethodSignatureMatcher</a></span>&nbsp;<span class="element-name">withSignature</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;signature)</span></div>
<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div>
<div class="block">Match methods with the given signature. The implementation uses javac internals to
pretty-print the signatures, and the signature format is not well-specified. This matcher
should be used with caution.
<div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a>
</span><span class="return-type"><a href="MethodMatchers.MethodSignatureMatcher.html" title="interface in com.google.errorprone.matchers.method">MethodMatchers.MethodSignatureMatcher</a></span>&nbsp;<span class="element-name">withSignature</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;signature)</span></div>
<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span>
<div class="deprecation-comment">The implementation uses javac internals to pretty-print the signatures, and the
signature format is not well-specified.</div>
</div>
<div class="block">Match methods with the given signature.

<p>Example: <code>format(java.lang.String,java.lang.Object...)</code></div>
</section>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -71,8 +71,10 @@ <h2>Uses of <a href="../MethodMatchers.MethodSignatureMatcher.html" title="inter
<div class="col-first even-row-color"><code><a href="../MethodMatchers.MethodSignatureMatcher.html" title="interface in com.google.errorprone.matchers.method">MethodMatchers.MethodSignatureMatcher</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">MethodMatchers.MethodClassMatcher.</span><code><a href="../MethodMatchers.MethodClassMatcher.html#withSignature(java.lang.String)" class="member-name-link">withSignature</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;signature)</code></div>
<div class="col-last even-row-color">
<div class="block"><span class="deprecated-label">Deprecated.</span></div>
<div class="block">Match methods with the given signature.</div>
<div class="block"><span class="deprecated-label">Deprecated.</span>
<div class="deprecation-comment">The implementation uses javac internals to pretty-print the signatures, and the
signature format is not well-specified.</div>
</div>
</div>
</div>
</section>
Expand Down
23 changes: 14 additions & 9 deletions api/latest/deprecated-list.html
Original file line number Diff line number Diff line change
Expand Up @@ -194,8 +194,13 @@ <h2 title="Contents">Contents</h2>
<div class="col-last even-row-color">
<div class="deprecation-comment">use <a href="com/google/errorprone/matchers/Matchers.html#isNullUsingDataflow()"><code>Matchers.isNullUsingDataflow()</code></a> instead.</div>
</div>
<div class="col-summary-item-name odd-row-color"><a href="com/google/errorprone/util/ASTHelpers.html#getAnnotation(com.sun.source.tree.Tree,java.lang.Class)">com.google.errorprone.util.ASTHelpers.getAnnotation<wbr>(Tree, Class&lt;T&gt;)</a></div>
<div class="col-summary-item-name odd-row-color"><a href="com/google/errorprone/matchers/method/MethodMatchers.MethodClassMatcher.html#withSignature(java.lang.String)">com.google.errorprone.matchers.method.MethodMatchers.MethodClassMatcher.withSignature<wbr>(String)</a></div>
<div class="col-last odd-row-color">
<div class="deprecation-comment">The implementation uses javac internals to pretty-print the signatures, and the
signature format is not well-specified.</div>
</div>
<div class="col-summary-item-name even-row-color"><a href="com/google/errorprone/util/ASTHelpers.html#getAnnotation(com.sun.source.tree.Tree,java.lang.Class)">com.google.errorprone.util.ASTHelpers.getAnnotation<wbr>(Tree, Class&lt;T&gt;)</a></div>
<div class="col-last even-row-color">
<div class="deprecation-comment">If <code>annotationClass</code> contains a member that is a <code>Class</code> or an array of
them, attempting to access that member from the Error Prone checker code will result in a
runtime exception. Instead, operate on <code>getSymbol(tree).getAnnotationMirrors()</code> to
Expand All @@ -206,27 +211,27 @@ <h2 title="Contents">Contents</h2>
<a href="com/google/errorprone/util/ASTHelpers.html#getAnnotations(com.sun.source.tree.Tree)"><code>ASTHelpers.getAnnotations(com.sun.source.tree.Tree)</code></a> (or a direct call to a <code>getAnnotations</code> method declared on a
specific <code>Tree</code> subclass) instead.</div>
</div>
<div class="col-summary-item-name even-row-color"><a href="com/google/errorprone/util/ASTHelpers.html#getAnnotation(com.sun.tools.javac.code.Symbol,java.lang.Class)">com.google.errorprone.util.ASTHelpers.getAnnotation<wbr>(Symbol, Class&lt;T&gt;)</a></div>
<div class="col-last even-row-color">
<div class="col-summary-item-name odd-row-color"><a href="com/google/errorprone/util/ASTHelpers.html#getAnnotation(com.sun.tools.javac.code.Symbol,java.lang.Class)">com.google.errorprone.util.ASTHelpers.getAnnotation<wbr>(Symbol, Class&lt;T&gt;)</a></div>
<div class="col-last odd-row-color">
<div class="deprecation-comment">If <code>annotationClass</code> contains a member that is a <code>Class</code> or an array of
them, attempting to access that member from the Error Prone checker code will result in a
runtime exception. Instead, operate on <code>sym.getAnnotationMirrors()</code> to
meta-syntactically inspect the annotation.</div>
</div>
<div class="col-summary-item-name odd-row-color"><a href="com/google/errorprone/util/ASTHelpers.html#hasAnnotation(com.sun.source.tree.Tree,java.lang.Class,com.google.errorprone.VisitorState)">com.google.errorprone.util.ASTHelpers.hasAnnotation<wbr>(Tree, Class&lt;? extends Annotation&gt;, VisitorState)</a></div>
<div class="col-last odd-row-color">
<div class="col-summary-item-name even-row-color"><a href="com/google/errorprone/util/ASTHelpers.html#hasAnnotation(com.sun.source.tree.Tree,java.lang.Class,com.google.errorprone.VisitorState)">com.google.errorprone.util.ASTHelpers.hasAnnotation<wbr>(Tree, Class&lt;? extends Annotation&gt;, VisitorState)</a></div>
<div class="col-last even-row-color">
<div class="deprecation-comment">prefer <a href="com/google/errorprone/util/ASTHelpers.html#hasAnnotation(com.sun.tools.javac.code.Symbol,java.lang.String,com.google.errorprone.VisitorState)"><code>ASTHelpers.hasAnnotation(Symbol, String, VisitorState)</code></a> to avoid needing a
runtime dependency on the annotation class, and to prevent issues if there is skew between
the definition of the annotation on the runtime and compile-time classpaths</div>
</div>
<div class="col-summary-item-name even-row-color"><a href="com/google/errorprone/util/ASTHelpers.html#hasAnnotation(com.sun.tools.javac.code.Symbol,java.lang.Class,com.google.errorprone.VisitorState)">com.google.errorprone.util.ASTHelpers.hasAnnotation<wbr>(Symbol, Class&lt;? extends Annotation&gt;, VisitorState)</a></div>
<div class="col-last even-row-color">
<div class="col-summary-item-name odd-row-color"><a href="com/google/errorprone/util/ASTHelpers.html#hasAnnotation(com.sun.tools.javac.code.Symbol,java.lang.Class,com.google.errorprone.VisitorState)">com.google.errorprone.util.ASTHelpers.hasAnnotation<wbr>(Symbol, Class&lt;? extends Annotation&gt;, VisitorState)</a></div>
<div class="col-last odd-row-color">
<div class="deprecation-comment">prefer <a href="com/google/errorprone/util/ASTHelpers.html#hasAnnotation(com.sun.tools.javac.code.Symbol,java.lang.String,com.google.errorprone.VisitorState)"><code>ASTHelpers.hasAnnotation(Symbol, String, VisitorState)</code></a> to avoid needing a
runtime dependency on the annotation class, and to prevent issues if there is skew between
the definition of the annotation on the runtime and compile-time classpaths</div>
</div>
<div class="col-summary-item-name odd-row-color"><a href="com/google/errorprone/util/ASTHelpers.html#hasNoExplicitType(com.sun.source.tree.VariableTree,com.google.errorprone.VisitorState)">com.google.errorprone.util.ASTHelpers.hasNoExplicitType<wbr>(VariableTree, VisitorState)</a></div>
<div class="col-last odd-row-color">
<div class="col-summary-item-name even-row-color"><a href="com/google/errorprone/util/ASTHelpers.html#hasNoExplicitType(com.sun.source.tree.VariableTree,com.google.errorprone.VisitorState)">com.google.errorprone.util.ASTHelpers.hasNoExplicitType<wbr>(VariableTree, VisitorState)</a></div>
<div class="col-last even-row-color">
<div class="deprecation-comment">use <a href="com/google/errorprone/util/ASTHelpers.html#hasImplicitType(com.sun.source.tree.VariableTree,com.google.errorprone.VisitorState)"><code>ASTHelpers.hasImplicitType(VariableTree, VisitorState)</code></a> instead</div>
</div>
</div>
Expand Down
6 changes: 4 additions & 2 deletions api/latest/index-all.html
Original file line number Diff line number Diff line change
Expand Up @@ -14734,8 +14734,10 @@ <h2 class="title" id="I:W">W</h2>
<dd>&nbsp;</dd>
<dt><a href="com/google/errorprone/matchers/method/MethodMatchers.MethodClassMatcher.html#withSignature(java.lang.String)" class="member-name-link">withSignature(String)</a> - Method in interface com.google.errorprone.matchers.method.<a href="com/google/errorprone/matchers/method/MethodMatchers.MethodClassMatcher.html" title="interface in com.google.errorprone.matchers.method">MethodMatchers.MethodClassMatcher</a></dt>
<dd>
<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div>
<div class="block">Match methods with the given signature.</div>
<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span>
<div class="deprecation-comment">The implementation uses javac internals to pretty-print the signatures, and the
signature format is not well-specified.</div>
</div>
</dd>
<dt><a href="com/google/errorprone/bugpatterns/WithSignatureDiscouraged.html" class="type-name-link" title="class in com.google.errorprone.bugpatterns">WithSignatureDiscouraged</a> - Class in <a href="com/google/errorprone/bugpatterns/package-summary.html">com.google.errorprone.bugpatterns</a></dt>
<dd>
Expand Down

0 comments on commit 4acf1b9

Please sign in to comment.