Add Javadoc support to the DackkaPlugin #4082
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
vkryachko
reviewed
Sep 13, 2022
buildSrc/src/main/java/com/google/firebase/gradle/plugins/DackkaPlugin.kt
Show resolved
Hide resolved
buildSrc/src/main/java/com/google/firebase/gradle/plugins/GradleUtils.kt
Outdated
Show resolved
Hide resolved
Size Report 1Affected Products
Test Logs |
Coverage Report 1Affected Products
Test Logs |
vkryachko
approved these changes
Sep 13, 2022
rlazo
approved these changes
Sep 13, 2022
kaibolay
added a commit
that referenced
this pull request
Sep 15, 2022
* Deflake firebase_common HeartBeat tests. (#4083) The tests relied on `TestOnCompleteListener` that was not safe to call more than once since it was based on a count down latch. So reusing it multiple times would cause await() to return immediately. This change makes it so that a new latch is created for every await() call, making all await() calls work. Fixes: http://b/245956774 * Add Javadoc support to the DackkaPlugin (#4082) * Add util method for copying directories * Add javadoc support to our dackka plugin * Remove the extension check on fromDirectory * Add a note about cache compliance and the javadoc task * Add reference to kotlin stdlib package list (#4093) Co-authored-by: Vladimir Kryachko <[email protected]> Co-authored-by: Daymon <[email protected]>
kaibolay
added a commit
that referenced
this pull request
Sep 15, 2022
* Minor updates to the App Distribution test app. (#4088) * Update various versions (#4090) * Updated various versions (dependencies and SDK to fix Android resource linking failure (AAPT: error: resource android:attr/lStar not found.) * Update compileSdk/targetSdkVersion from 31 to 33 * Update with latest changes from master (#4091) * Deflake firebase_common HeartBeat tests. (#4083) The tests relied on `TestOnCompleteListener` that was not safe to call more than once since it was based on a count down latch. So reusing it multiple times would cause await() to return immediately. This change makes it so that a new latch is created for every await() call, making all await() calls work. Fixes: http://b/245956774 * Add Javadoc support to the DackkaPlugin (#4082) * Add util method for copying directories * Add javadoc support to our dackka plugin * Remove the extension check on fromDirectory * Add a note about cache compliance and the javadoc task * Add reference to kotlin stdlib package list (#4093) Co-authored-by: Vladimir Kryachko <[email protected]> Co-authored-by: Daymon <[email protected]> Co-authored-by: Lee Kellogg <[email protected]> Co-authored-by: Vladimir Kryachko <[email protected]> Co-authored-by: Daymon <[email protected]>
kaibolay
added a commit
that referenced
this pull request
Sep 15, 2022
* Deflake firebase_common HeartBeat tests. (#4083) The tests relied on `TestOnCompleteListener` that was not safe to call more than once since it was based on a count down latch. So reusing it multiple times would cause await() to return immediately. This change makes it so that a new latch is created for every await() call, making all await() calls work. Fixes: http://b/245956774 * Add Javadoc support to the DackkaPlugin (#4082) * Add util method for copying directories * Add javadoc support to our dackka plugin * Remove the extension check on fromDirectory * Add a note about cache compliance and the javadoc task * Add reference to kotlin stdlib package list (#4093) Co-authored-by: Vladimir Kryachko <[email protected]> Co-authored-by: Daymon <[email protected]>
kaibolay
added a commit
that referenced
this pull request
Sep 15, 2022
* Minor updates to the App Distribution test app. (#4088) * Update various versions (#4090) * Updated various versions (dependencies and SDK to fix Android resource linking failure (AAPT: error: resource android:attr/lStar not found.) * Update compileSdk/targetSdkVersion from 31 to 33 * Update with latest changes from master (#4091) * Deflake firebase_common HeartBeat tests. (#4083) The tests relied on `TestOnCompleteListener` that was not safe to call more than once since it was based on a count down latch. So reusing it multiple times would cause await() to return immediately. This change makes it so that a new latch is created for every await() call, making all await() calls work. Fixes: http://b/245956774 * Add Javadoc support to the DackkaPlugin (#4082) * Add util method for copying directories * Add javadoc support to our dackka plugin * Remove the extension check on fromDirectory * Add a note about cache compliance and the javadoc task * Add reference to kotlin stdlib package list (#4093) Co-authored-by: Vladimir Kryachko <[email protected]> Co-authored-by: Daymon <[email protected]> * Resolve strict mode violations in firebase-appdistribution (#4092) * merge master into fad/next (#4102) * Deflake firebase_common HeartBeat tests. (#4083) The tests relied on `TestOnCompleteListener` that was not safe to call more than once since it was based on a count down latch. So reusing it multiple times would cause await() to return immediately. This change makes it so that a new latch is created for every await() call, making all await() calls work. Fixes: http://b/245956774 * Add Javadoc support to the DackkaPlugin (#4082) * Add util method for copying directories * Add javadoc support to our dackka plugin * Remove the extension check on fromDirectory * Add a note about cache compliance and the javadoc task * Add reference to kotlin stdlib package list (#4093) Co-authored-by: Vladimir Kryachko <[email protected]> Co-authored-by: Daymon <[email protected]> Co-authored-by: Lee Kellogg <[email protected]> Co-authored-by: Vladimir Kryachko <[email protected]> Co-authored-by: Daymon <[email protected]> Co-authored-by: emilypgoogle <[email protected]>
qdpham13
pushed a commit
that referenced
this pull request
Sep 20, 2022
* Add util method for copying directories * Add javadoc support to our dackka plugin * Remove the extension check on fromDirectory * Add a note about cache compliance and the javadoc task
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.
In accordance with b/245753889, this adds support to the DackkaPlugin to generate Javadoc variants.
More specifically this:
deleteDackkaGeneratedJavaReferencestaskcopyOutputToCommonDirectoryto two separate taskcopyJavaDocToCommonDirectorycopyKotlinDocToCommonDirectoryCopytask in gradle for copying individual directoriesDackkaPlugindocumentation to reflect the new changesKeep in mind that the current implementation in this pr requires the project setting
dackkaJavadocto be equal totrue, otherwise Dackka won't copy the Javadoc output to the root directory.For example, running
./gradlew :firebase-common:kotlindocwill yield this at the root build directoryWheres running this
./gradlew -PdackkaJavadoc=true :firebase-common:kotlindocwill yield this at the root build directoryAndroid contains the Firesite ready Javadoc files for staging.