Skip to content

Commit bb62df1

Browse files
authored
Update DackkaPlugin to use 1.2.0 (#4714)
* Add package-list for androidx * Fix broken multi-line links * Remove link to hidden package * Add imports for redundant groupid packages * Hide executors from docs * Hide misc internal classes and variables * Fix duplicate or broken function references in docs * Fix typo in Javadocs * Remove redundant toString * Remove old firesite transform file * Added extra util methods * Left TODO on FirebaseLibraryExtension * Migrate DackkaPlugin to latest Dackka version
1 parent df07a40 commit bb62df1

File tree

43 files changed

+779
-423
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

43 files changed

+779
-423
lines changed

.github/workflows/diff-javadoc.yml

+13-19
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,15 @@ on:
55

66
jobs:
77
build:
8-
runs-on: ubuntu-latest
8+
runs-on: macos-latest
99
permissions:
1010
pull-requests: write
1111
steps:
12-
- name: Make Dir
12+
- name: Make diff directory
1313
run: mkdir ~/diff
1414

15-
- uses: actions/checkout@v3
15+
- name: Checkout PR branch
16+
uses: actions/checkout@v3
1617
with:
1718
fetch-depth: 2
1819
submodules: true
@@ -24,31 +25,24 @@ jobs:
2425
distribution: temurin
2526
cache: gradle
2627

27-
- name: Changed Modules
28-
id: changed-modules
29-
run: |
30-
git diff --name-only HEAD~1 | xargs printf -- '--changed-git-paths %s\n' | xargs ./gradlew writeChangedProjects --output-file-path=modules.json --only-firebase-sdks
31-
echo "run=$(cat modules.json | sed "s/[]\"[]//g" | sed "s/,/\n/g" | xargs printf -- "%s:kotlinDoc ")" >> $GITHUB_OUTPUT
28+
- name: Generate docs for PR branch
29+
run: ./gradlew kotlindoc
3230

33-
- name: Build
34-
# Certain SDKs won't export docs, make a blank folder to diff if that's the case
35-
run: mkdir build && ./gradlew ${{ steps.changed-modules.outputs.run }}
36-
37-
- name: Move original docs
31+
- name: Move branch docs to diff directory
3832
run: mv build ~/diff/modified
3933

40-
- uses: actions/checkout@v3
34+
- name: Checkout master
35+
uses: actions/checkout@v3
4136
with:
4237
ref: ${{ github.base_ref }}
4338

44-
- name: Build
45-
# Certain SDKs won't export docs, make a blank folder to diff if that's the case
46-
run: mkdir build && ./gradlew ${{ steps.changed-modules.outputs.run }}
39+
- name: Generate docs for Master
40+
run: ./gradlew kotlindoc
4741

48-
- name: Move modified docs
42+
- name: Move master docs to diff directory
4943
run: mv build ~/diff/original
5044

51-
- name: Diff docs
45+
- name: Get diff between Master and Branch docs
5246
run: >
5347
`# Recursively diff directories, including new files, git style, with 3 lines of context`
5448
diff -wEburN ~/diff/original ~/diff/modified

appcheck/firebase-appcheck-debug-testing/src/main/java/com/google/firebase/appcheck/debug/testing/DebugAppCheckTestHelper.java

+3-2
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515
package com.google.firebase.appcheck.debug.testing;
1616

1717
import androidx.annotation.NonNull;
18+
import androidx.test.platform.app.InstrumentationRegistry;
1819
import com.google.firebase.FirebaseApp;
1920
import com.google.firebase.appcheck.AppCheckProviderFactory;
2021
import com.google.firebase.appcheck.FirebaseAppCheck;
@@ -64,8 +65,8 @@
6465
*/
6566
public final class DebugAppCheckTestHelper {
6667
/**
67-
* Creates a {@link DebugAppCheckTestHelper} instance with a debug secret obtained from {@link
68-
* androidx.test.platform.app.InstrumentationRegistry} arguments.
68+
* Creates a {@link DebugAppCheckTestHelper} instance with a debug secret obtained from <br>
69+
* {@link InstrumentationRegistry} arguments.
6970
*/
7071
@NonNull
7172
public static DebugAppCheckTestHelper fromInstrumentationArgs() {

appcheck/firebase-appcheck-debug/src/main/java/com/google/firebase/appcheck/debug/DebugAppCheckProviderFactory.java

+6-5
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,11 @@
1818
import com.google.firebase.FirebaseApp;
1919
import com.google.firebase.appcheck.AppCheckProvider;
2020
import com.google.firebase.appcheck.AppCheckProviderFactory;
21+
import com.google.firebase.appcheck.FirebaseAppCheck;
2122
import com.google.firebase.appcheck.debug.internal.DebugAppCheckProvider;
2223

2324
/**
24-
* Implementation of an {@link AppCheckProviderFactory} that builds {@link DebugAppCheckProvider}s.
25+
* Implementation of an {@link AppCheckProviderFactory} that builds {@code DebugAppCheckProvider}s.
2526
*/
2627
public class DebugAppCheckProviderFactory implements AppCheckProviderFactory {
2728

@@ -30,10 +31,10 @@ public class DebugAppCheckProviderFactory implements AppCheckProviderFactory {
3031
private DebugAppCheckProviderFactory() {}
3132

3233
/**
33-
* Gets an instance of this class for installation into a {@link
34-
* com.google.firebase.appcheck.FirebaseAppCheck} instance. If no debug secret is found in {@link
35-
* android.content.SharedPreferences}, a new debug secret will be generated and printed to the
36-
* logcat. The debug secret should then be added to the allow list in the Firebase Console.
34+
* Gets an instance of this class for installation into a {@link FirebaseAppCheck} instance. If no
35+
* debug secret is found in {@link android.content.SharedPreferences}, a new debug secret will be
36+
* generated and printed to the logcat. The debug secret should then be added to the allow list in
37+
* the Firebase Console.
3738
*/
3839
@NonNull
3940
public static DebugAppCheckProviderFactory getInstance() {

appcheck/firebase-appcheck-interop/api.txt

-6
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,5 @@ package com.google.firebase.appcheck.interop {
1515
method public void onAppCheckTokenChanged(@NonNull com.google.firebase.appcheck.AppCheckTokenResult);
1616
}
1717

18-
public interface InternalAppCheckTokenProvider {
19-
method public void addAppCheckTokenListener(@NonNull com.google.firebase.appcheck.interop.AppCheckTokenListener);
20-
method @NonNull public com.google.android.gms.tasks.Task<com.google.firebase.appcheck.AppCheckTokenResult> getToken(boolean);
21-
method public void removeAppCheckTokenListener(@NonNull com.google.firebase.appcheck.interop.AppCheckTokenListener);
22-
}
23-
2418
}
2519

appcheck/firebase-appcheck-interop/src/main/java/com/google/firebase/appcheck/interop/InternalAppCheckTokenProvider.java

+1
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@
1818
import com.google.android.gms.tasks.Task;
1919
import com.google.firebase.appcheck.AppCheckTokenResult;
2020

21+
/** @hide */
2122
public interface InternalAppCheckTokenProvider {
2223

2324
/**

appcheck/firebase-appcheck-playintegrity/src/main/java/com/google/firebase/appcheck/playintegrity/PlayIntegrityAppCheckProviderFactory.java

+4-6
Original file line numberDiff line numberDiff line change
@@ -18,21 +18,19 @@
1818
import com.google.firebase.FirebaseApp;
1919
import com.google.firebase.appcheck.AppCheckProvider;
2020
import com.google.firebase.appcheck.AppCheckProviderFactory;
21+
import com.google.firebase.appcheck.FirebaseAppCheck;
2122
import com.google.firebase.appcheck.playintegrity.internal.PlayIntegrityAppCheckProvider;
2223

2324
/**
24-
* Implementation of an {@link AppCheckProviderFactory} that builds {@link
25-
* PlayIntegrityAppCheckProvider}s. This is the default implementation.
25+
* Implementation of an {@link AppCheckProviderFactory} that builds <br>
26+
* {@link PlayIntegrityAppCheckProvider}s. This is the default implementation.
2627
*/
2728
public class PlayIntegrityAppCheckProviderFactory implements AppCheckProviderFactory {
2829

2930
private static final PlayIntegrityAppCheckProviderFactory instance =
3031
new PlayIntegrityAppCheckProviderFactory();
3132

32-
/**
33-
* Gets an instance of this class for installation into a {@link
34-
* com.google.firebase.appcheck.FirebaseAppCheck} instance.
35-
*/
33+
/** Gets an instance of this class for installation into a {@link FirebaseAppCheck} instance. */
3634
@NonNull
3735
public static PlayIntegrityAppCheckProviderFactory getInstance() {
3836
return instance;

appcheck/firebase-appcheck-safetynet/src/main/java/com/google/firebase/appcheck/safetynet/SafetyNetAppCheckProviderFactory.java

+4-4
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,12 @@
1818
import com.google.firebase.FirebaseApp;
1919
import com.google.firebase.appcheck.AppCheckProvider;
2020
import com.google.firebase.appcheck.AppCheckProviderFactory;
21+
import com.google.firebase.appcheck.FirebaseAppCheck;
2122
import com.google.firebase.appcheck.safetynet.internal.SafetyNetAppCheckProvider;
2223

2324
/**
24-
* Implementation of an {@link AppCheckProviderFactory} that builds {@link
25-
* SafetyNetAppCheckProvider}s. This is the default implementation.
25+
* Implementation of an {@link AppCheckProviderFactory} that builds <br>
26+
* {@link SafetyNetAppCheckProvider}s. This is the default implementation.
2627
*
2728
* @deprecated Use {@code PlayIntegrityAppCheckProviderFactory} instead.
2829
*/
@@ -35,8 +36,7 @@ public class SafetyNetAppCheckProviderFactory implements AppCheckProviderFactory
3536
private SafetyNetAppCheckProviderFactory() {}
3637

3738
/**
38-
* Gets an instance of this class for installation into a {@link
39-
* com.google.firebase.appcheck.FirebaseAppCheck} instance.
39+
* Gets an instance of this class for installation into a {@link FirebaseAppCheck} instance.
4040
*
4141
* @deprecated Use {@code PlayIntegrityAppCheckProviderFactory#getInstance} instead.
4242
*/

appcheck/firebase-appcheck/src/main/java/com/google/firebase/appcheck/AppCheckProvider.java

+3-3
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,9 @@
1919

2020
/**
2121
* Interface for a provider that generates {@link AppCheckToken}s. This provider can be called at
22-
* any time by any Firebase library that depends (optionally or otherwise) on {@link
23-
* AppCheckToken}s. This provider is responsible for determining if it can create a new token at the
24-
* time of the call and returning that new token if it can.
22+
* any time by any Firebase library that depends (optionally or otherwise) on <br>
23+
* {@link AppCheckToken}s. This provider is responsible for determining if it can create a new token
24+
* at the time of the call and returning that new token if it can.
2525
*/
2626
public interface AppCheckProvider {
2727

buildSrc/firesite_transform.sh

-46
This file was deleted.

0 commit comments

Comments
 (0)