Skip to content

Remove Dokka Plugin #4031

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Sep 8, 2022
Merged

Remove Dokka Plugin #4031

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
335135c
Remove DackkaPlugin from register block
daymxn Aug 25, 2022
0b6920e
Remove Dokka Pugin
daymxn Aug 25, 2022
5bf9b2a
Added empty kotlindoc to JavaPlugin for tests
daymxn Sep 7, 2022
ca62bdc
Removed Dokka from JavadocPlugin
daymxn Sep 7, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 0 additions & 7 deletions buildSrc/build.gradle.kts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,6 @@ dependencies {
implementation("org.apache.maven:maven-aether-provider:3.1.0")

implementation("com.google.code.gson:gson:2.8.9")
implementation("org.jetbrains.dokka:dokka-android-gradle-plugin:0.9.17-g013-9b8280a")
implementation("com.android.tools.build:gradle:3.4.3")
implementation("gradle.plugin.com.github.sherter.google-java-format:google-java-format-gradle-plugin:0.9")

Expand All @@ -72,10 +71,6 @@ gradlePlugin {
id = "LicenseResolverPlugin"
implementationClass = "com.google.firebase.gradle.plugins.license.LicenseResolverPlugin"
}
register("dackkaPlugin") {
id = "DackkaPlugin"
implementationClass = "com.google.firebase.gradle.plugins.DackkaPlugin"
}
register("multiProjectReleasePlugin") {
id = "MultiProjectReleasePlugin"
implementationClass = "com.google.firebase.gradle.MultiProjectReleasePlugin"
Expand All @@ -88,12 +83,10 @@ gradlePlugin {
id = "firebase-library"
implementationClass = "com.google.firebase.gradle.plugins.FirebaseLibraryPlugin"
}

register("firebaseJavaLibraryPlugin") {
id = "firebase-java-library"
implementationClass = "com.google.firebase.gradle.plugins.FirebaseJavaLibraryPlugin"
}

register("firebaseVendorPlugin") {
id = "firebase-vendor"
implementationClass = "com.google.firebase.gradle.plugins.VendorPlugin"
Expand Down
218 changes: 0 additions & 218 deletions buildSrc/src/main/java/com/google/firebase/gradle/plugins/Dokka.java
View file
Open in desktop

This file was deleted.

2 changes: 1 addition & 1 deletion buildSrc/src/main/java/com/google/firebase/gradle/plugins/FirebaseJavaLibraryPlugin.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ public void apply(Project project) {
ImmutableList.of("-module-name", kotlinModuleName(project))));

setupStaticAnalysis(project, firebaseLibrary);
project.afterEvaluate(p -> Dokka.configure(project, null, firebaseLibrary));
project.getTasks().register("kotlindoc");
}

private static void setupStaticAnalysis(Project project, FirebaseLibraryExtension library) {
Expand Down
16 changes: 3 additions & 13 deletions buildSrc/src/main/java/com/google/firebase/gradle/plugins/JavadocPlugin.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@

import com.android.build.gradle.LibraryExtension;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
import java.io.File;
import java.io.IOException;
import java.util.List;
Expand All @@ -34,8 +33,6 @@
import org.gradle.api.tasks.javadoc.Javadoc;
import org.gradle.external.javadoc.CoreJavadocOptions;
import org.gradle.external.javadoc.StandardJavadocDocletOptions;
import org.jetbrains.dokka.gradle.DokkaAndroidPlugin;
import org.jetbrains.dokka.gradle.DokkaTask;

/**
* This plugin modifies the java plugin's javadoc task to be firebase friendly. It does the
Expand Down Expand Up @@ -73,10 +70,10 @@ public void apply(Project project) {
toBoolean(
((Map<String, Object>) project.getProperties())
.getOrDefault("includeFireEscapeArtifacts", "false"));
if (!ext.publishJavadoc || !includeFireEscapeArtifacts) {
boolean isKotlinAndroid = project.getPlugins().hasPlugin("kotlin-android");

if (!ext.publishJavadoc || !includeFireEscapeArtifacts || isKotlinAndroid) {
applyDummyJavadoc(project);
} else if (project.getPlugins().hasPlugin("kotlin-android")) {
applyDokka(project);
} else {
applyDoclava(project);
}
Expand Down Expand Up @@ -276,13 +273,6 @@ private static void applyDoclava(Project project) {
});
}

private static void applyDokka(Project project) {
project.apply(ImmutableMap.of("plugin", DokkaAndroidPlugin.class));
DokkaTask dokka = (DokkaTask) project.getTasks().getByName("dokka");
dokka.setOutputDirectory(project.getBuildDir() + "/docs/javadoc/reference");
applyDummyJavadoc(project).dependsOn(dokka);
}

private static Task applyDummyJavadoc(Project project) {
return project
.getTasks()
Expand Down