Skip to content

Commit 3454f3e

Browse files
committed
javadocs improved.
1 parent eeee558 commit 3454f3e

43 files changed

Lines changed: 436 additions & 93 deletions

Some content is hidden

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

build.gradle.kts

Lines changed: 20 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// :buildSrc
1+
// :build-logic
22
plugins {
33
alias(buildSrc.plugins.maven.publish)
44
alias(buildSrc.plugins.gradle.plugin)
@@ -58,15 +58,29 @@ val implCls: Configuration by configurations.creating {
5858
}
5959

6060
val javadocs by tasks.registering(Javadoc::class) {
61+
group = "documentation"
62+
destinationDir = project.file("build/outputs/javadoc")
6163
title = "$pluginName $pluginVersion API"
62-
classpath += implCls.asFileTree.filter {it.extension == "jar"}
63-
destinationDir = rootProject.file("build/javadoc")
64+
classpath += implCls.asFileTree.filter {it.extension == "jar" }
6465
source = sourceSets.main.get().allJava
65-
// options.links = "https://docs.oracle.com/en/java/javase/17/docs/api/"
66-
// options.linkSource = true
67-
// options.author = true
6866
isFailOnError = false
67+
options {
68+
this as StandardJavadocDocletOptions
69+
links = mutableListOf("https://docs.oracle.com/en/java/javase/17/docs/api/")
70+
isLinkSource = true
71+
isAuthor = true
72+
}
73+
}
74+
75+
/*
76+
tasks.withType<Javadoc> {
77+
options {
78+
this as StandardJavadocDocletOptions
79+
addBooleanOption("Xdoclint:all").value = true
80+
addBooleanOption("Xdoclint:-missing").value = true
81+
}
6982
}
83+
*/
7084

7185
val javadocJar by tasks.registering(Jar::class) {
7286
archiveClassifier.set("javadoc")
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
#This file is generated by updateDaemonJvm
2+
toolchainUrl.FREE_BSD.AARCH64=https\://api.foojay.io/disco/v3.0/ids/29ee363f71d060405f729a8f1b7f7aef/redirect
3+
toolchainUrl.FREE_BSD.X86_64=https\://api.foojay.io/disco/v3.0/ids/ecd23fd7707c683afbcd6052998cb6a9/redirect
4+
toolchainUrl.LINUX.AARCH64=https\://api.foojay.io/disco/v3.0/ids/29ee363f71d060405f729a8f1b7f7aef/redirect
5+
toolchainUrl.LINUX.X86_64=https\://api.foojay.io/disco/v3.0/ids/ecd23fd7707c683afbcd6052998cb6a9/redirect
6+
toolchainUrl.MAC_OS.AARCH64=https\://api.foojay.io/disco/v3.0/ids/10fc3bf1ee0001078a473afe6e43cfdb/redirect
7+
toolchainUrl.MAC_OS.X86_64=https\://api.foojay.io/disco/v3.0/ids/9c55677aff3966382f3d853c0959bfb2/redirect
8+
toolchainUrl.UNIX.AARCH64=https\://api.foojay.io/disco/v3.0/ids/29ee363f71d060405f729a8f1b7f7aef/redirect
9+
toolchainUrl.UNIX.X86_64=https\://api.foojay.io/disco/v3.0/ids/ecd23fd7707c683afbcd6052998cb6a9/redirect
10+
toolchainUrl.WINDOWS.AARCH64=https\://api.foojay.io/disco/v3.0/ids/39846e8427e64a3824c13e399d7d813c/redirect
11+
toolchainUrl.WINDOWS.X86_64=https\://api.foojay.io/disco/v3.0/ids/ac151d55def6b6a9a159dc4cb4642851/redirect
12+
toolchainVendor=JETBRAINS
13+
toolchainVersion=21

gradle/libs.versions.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@ github_email = "syslogic@users.noreply.github.com"
99
github_dev = "Martin Zeitler"
1010
github_handle = "syslogic"
1111

12-
plugin_version = "1.4.3"
13-
android_gradle = "9.0.1"
12+
plugin_version = "1.4.4"
13+
android_gradle = "9.1.0"
1414
gradle_publish = "2.0.0"
1515
annotations = "26.1.0"
1616
httpcore = "4.4.16"

settings.gradle.kts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,10 @@ pluginManagement {
1717
}
1818
}
1919

20+
plugins {
21+
// id("org.gradle.toolchains.foojay-resolver-convention") version "1.0.0"
22+
}
23+
2024
@Suppress("UnstableApiUsage")
2125
dependencyResolutionManagement {
2226
repositoriesMode.set(RepositoriesMode.PREFER_SETTINGS)

src/main/java/io/syslogic/agconnect/PublishingExtensionImpl.java

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,9 @@ public class PublishingExtensionImpl implements PublishingExtension {
1414

1515
private Boolean verbose = false;
1616

17+
/** Constructor */
18+
public PublishingExtensionImpl() {}
19+
1720
/**
1821
* Define the path to the API client configuration file.
1922
* <code>agcPublishing {configFile = ""}</code>

src/main/java/io/syslogic/agconnect/constants/ArtifactType.java

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,10 @@
55
* @author Martin Zeitler
66
*/
77
public class ArtifactType {
8+
9+
/** Constructor */
10+
public ArtifactType() {}
11+
812
/** AAB - Android App Bundle (default). */
913
public static final String AAB = "aab";
1014
/** APK - Android Package Kit (legacy). */

src/main/java/io/syslogic/agconnect/constants/ConsoleUrl.java

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,9 @@
66
*/
77
public class ConsoleUrl {
88

9+
/** Constructor */
10+
public ConsoleUrl() {}
11+
912
/** Link to AppGallery Connect Console */
1013
public static final String PACKAGE_INFO = "https://developer.huawei.com/consumer/en/service/josp/agc/index.html#/myApp/{appId}/v{packageId}";
1114

src/main/java/io/syslogic/agconnect/constants/EndpointUrl.java

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,9 @@
66
*/
77
public class EndpointUrl {
88

9+
/** Constructor */
10+
public EndpointUrl() {}
11+
912
/** Endpoint URL */
1013
public static final String OAUTH2_TOKEN = "https://connect-api.cloud.huawei.com/api/oauth2/v1/token";
1114
/** Endpoint URL */

src/main/java/io/syslogic/agconnect/constants/ErrorMessage.java

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,9 @@
66
*/
77
public class ErrorMessage {
88

9+
/** Constructor */
10+
public ErrorMessage() {}
11+
912
/** Error Message Payload. */
1013
public static final String APP_SIGNING_NOT_ENABLED = "[cds]add apk failed, additional msg is [app bundle must do app signature.]";
1114

src/main/java/io/syslogic/agconnect/constants/ResultCode.java

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,9 @@
88
@SuppressWarnings("unused")
99
public class ResultCode {
1010

11+
/** Constructor */
12+
public ResultCode() {}
13+
1114
/** API result code. */
1215
public static final int SUCCESS = 0;
1316

0 commit comments

Comments
 (0)