Fix Javadoc in FirebaseCrashlytics #6252
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Javadoc Changes:--- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/crashlytics/FirebaseCrashlytics.html 2024-09-11 17:09:24.638640045 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/crashlytics/FirebaseCrashlytics.html 2024-09-11 17:06:34.941843067 +0000
@@ -59,7 +59,7 @@
<td><code>boolean</code></td>
<td>
<div><code><a href="/docs/reference/android/com/google/firebase/crashlytics/FirebaseCrashlytics.html#isCrashlyticsCollectionEnabled()">isCrashlyticsCollectionEnabled</a>()</code></div>
- <p>Indicates whether or not automatic data collection is enabled</p>
+ <p>Indicates whether or not automatic data collection is enabled.</p>
</td>
</tr>
<tr>
@@ -253,7 +253,7 @@
<div class="api-item"><a name="isCrashlyticsCollectionEnabled--"></a><a name="iscrashlyticscollectionenabled"></a>
<h3 class="api-name" id="isCrashlyticsCollectionEnabled()">isCrashlyticsCollectionEnabled</h3>
<pre class="api-signature no-pretty-print">public boolean <a href="/docs/reference/android/com/google/firebase/crashlytics/FirebaseCrashlytics.html#isCrashlyticsCollectionEnabled()">isCrashlyticsCollectionEnabled</a>()</pre>
- <p>Indicates whether or not automatic data collection is enabled</p>
+ <p>Indicates whether or not automatic data collection is enabled.</p>
<div class="devsite-table-wrapper">
<table class="responsive">
<colgroup>
@@ -270,9 +270,11 @@
<td><code>boolean</code></td>
<td>
<p>In order of priority: </p>
- <p>If <code><a href="/docs/reference/android/com/google/firebase/crashlytics/FirebaseCrashlytics.html#setCrashlyticsCollectionEnabled(boolean)">setCrashlyticsCollectionEnabled</a></code> is called with a value, use it</p>
- <p>If the <b>firebase_crashlytics_collection_enabled</b> key is in your app’s AndroidManifest.xml, use it</p>
- <p>Otherwise, use the default <code><a href="/docs/reference/android/com/google/firebase/FirebaseApp.html#isDataCollectionDefaultEnabled()">isDataCollectionDefaultEnabled</a></code> in FirebaseApp</p>
+ <ul>
+ <li>If <code><a href="/docs/reference/android/com/google/firebase/crashlytics/FirebaseCrashlytics.html#setCrashlyticsCollectionEnabled(boolean)">setCrashlyticsCollectionEnabled</a></code> is called with a value, use it. </li>
+ <li>If the <b>firebase_crashlytics_collection_enabled</b> key is in your app’s AndroidManifest.xml, use it. </li>
+ <li>Otherwise, use the default <code><a href="/docs/reference/android/com/google/firebase/FirebaseApp.html#isDataCollectionDefaultEnabled()">isDataCollectionDefaultEnabled</a></code> in FirebaseApp. </li>
+ </ul>
</td>
</tr>
</tbody>--- /home/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/crashlytics/FirebaseCrashlytics.html 2024-09-11 17:09:24.614639930 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/crashlytics/FirebaseCrashlytics.html 2024-09-11 17:06:34.937843049 +0000
@@ -59,7 +59,7 @@
<td><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a></code></td>
<td>
<div><code><a href="/docs/reference/kotlin/com/google/firebase/crashlytics/FirebaseCrashlytics.html#isCrashlyticsCollectionEnabled()">isCrashlyticsCollectionEnabled</a>()</code></div>
- <p>Indicates whether or not automatic data collection is enabled</p>
+ <p>Indicates whether or not automatic data collection is enabled.</p>
</td>
</tr>
<tr>
@@ -253,7 +253,7 @@
<div class="api-item"><a name="isCrashlyticsCollectionEnabled--"></a><a name="iscrashlyticscollectionenabled"></a>
<h3 class="api-name" id="isCrashlyticsCollectionEnabled()">isCrashlyticsCollectionEnabled</h3>
<pre class="api-signature no-pretty-print">fun <a href="/docs/reference/kotlin/com/google/firebase/crashlytics/FirebaseCrashlytics.html#isCrashlyticsCollectionEnabled()">isCrashlyticsCollectionEnabled</a>(): <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a></pre>
- <p>Indicates whether or not automatic data collection is enabled</p>
+ <p>Indicates whether or not automatic data collection is enabled.</p>
<div class="devsite-table-wrapper">
<table class="responsive">
<colgroup>
@@ -270,9 +270,11 @@
<td><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a></code></td>
<td>
<p>In order of priority: </p>
- <p>If <code><a href="/docs/reference/kotlin/com/google/firebase/crashlytics/FirebaseCrashlytics.html#setCrashlyticsCollectionEnabled(boolean)">setCrashlyticsCollectionEnabled</a></code> is called with a value, use it</p>
- <p>If the <b>firebase_crashlytics_collection_enabled</b> key is in your app’s AndroidManifest.xml, use it</p>
- <p>Otherwise, use the default <code><a href="/docs/reference/kotlin/com/google/firebase/FirebaseApp.html#isDataCollectionDefaultEnabled()">isDataCollectionDefaultEnabled</a></code> in FirebaseApp</p>
+ <ul>
+ <li>If <code><a href="/docs/reference/kotlin/com/google/firebase/crashlytics/FirebaseCrashlytics.html#setCrashlyticsCollectionEnabled(boolean)">setCrashlyticsCollectionEnabled</a></code> is called with a value, use it. </li>
+ <li>If the <b>firebase_crashlytics_collection_enabled</b> key is in your app’s AndroidManifest.xml, use it. </li>
+ <li>Otherwise, use the default <code><a href="/docs/reference/kotlin/com/google/firebase/FirebaseApp.html#isDataCollectionDefaultEnabled()">isDataCollectionDefaultEnabled</a></code> in FirebaseApp. </li>
+ </ul>
</td>
</tr>
</tbody> |
Coverage Report 1Affected Products
Test Logs |
Size Report 1Affected ProductsTest Logs |
Startup Time Report 1Note: Layout is sometimes suboptimal due to limited formatting support on GitHub. Please check this report on GCS. Notes
Startup Times
|
Unit Test Results 8 files - 6 8 suites - 6 26s ⏱️ +11s Results for commit 3daed0d. ± Comparison against base commit 994542e. This pull request removes 104 and adds 22 tests. Note that renamed tests count towards both. |
rlazo
approved these changes
Sep 11, 2024
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fix Javadoc for
isCrashlyticsCollectionEnabled()in FirebaseCrashlytics