Skip to content

Commit 2e3771e

Browse files
committed
javadoc task fixed.
1 parent 33cde40 commit 2e3771e

File tree

7 files changed

+48
-19
lines changed

7 files changed

+48
-19
lines changed

.idea/runConfigurations/androidx_github_library__javadoc_.xml

Lines changed: 23 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

library/build.gradle

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ android {
88
buildToolsVersion = '34.0.0'
99
compileSdk 34
1010
defaultConfig {
11+
versionName rootProject.ext.get('versionName')
12+
versionCode rootProject.ext.get('versionCode')
1113
minSdk 22
1214
targetSdk 34
1315
setProperty("archivesBaseName", "androidx_github_" + versionName)
@@ -96,30 +98,33 @@ tasks.register('javadoc', Javadoc) {
9698
source = android.sourceSets.main.java.srcDirs
9799
destinationDir = file("${project.buildDir}/outputs/javadoc/")
98100
configurations.implementation.setCanBeResolved(true)
101+
99102
classpath = files(new File("${android.sdkDirectory}/platforms/${android.compileSdkVersion}/android.jar"))
100-
classpath += project.files(android.getBootClasspath().join(File.pathSeparator))
103+
android.getBootClasspath().forEach{classpath += fileTree(it) }
101104
classpath += fileTree(dir: "$buildDir/tmp/aarsToJars/")
102105
classpath += configurations.implementation
103106
exclude "**/BuildConfig.java", "**/R.java"
104107
failOnError false
105108

106-
// options.verbose()
109+
options.verbose()
107110
// javadoc: warning - The code being documented uses modules but the packages
108111
// defined in https://developer.android.com/reference/ are in the unnamed module.
109112
options.links "https://docs.oracle.com/en/java/javase/17/docs/api/"
110-
// options.linksOffline "https://developer.android.com/reference", "${android.sdkDirectory}/docs/reference"
113+
options.linksOffline "https://developer.android.com/reference", "${android.sdkDirectory}/docs/reference"
111114
options.linkSource true
112115
options.author true
113116

114117
doFirst {
115118

116119
// extract AAR files
117-
configurations.named("implementation").filter { it.name.endsWith('.aar') }.each { aar ->
118-
copy {
119-
from zipTree(aar)
120-
include "**/classes.jar"
121-
into "$buildDir/tmp/aarsToJars/${aar.name.replace('.aar', '')}/"
122-
}
120+
configurations.implementation
121+
.filter { it.name.endsWith('.aar') }
122+
.each { aar ->
123+
copy {
124+
from zipTree(aar)
125+
include "**/classes.jar"
126+
into "$buildDir/tmp/aarsToJars/${aar.name.replace('.aar', '')}/"
127+
}
123128
}
124129

125130
// provide JAR, which contains the generated data-binding classes

library/src/main/java/io/syslogic/github/api/GithubClient.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ private static GithubService getService() {
6868
return getService().searchRepositories("token " + token, queryString, sortField, sortOrder, pageNumber);
6969
}
7070

71-
/** @noinspection unused*/
71+
@SuppressWarnings("unused")
7272
public static @NonNull Call<ArrayList<Repository>> getOrgRepositories(@Nullable String token, @NonNull String org, @NonNull String type, @NonNull String sortField, @NonNull String sortOrder, @NonNull Integer pageSize, @NonNull Integer pageNumber) {
7373
return getService().getOrgRepositories("token " + token, org, type, sortField, sortOrder, pageSize, pageNumber);
7474
}

library/src/main/java/io/syslogic/github/api/GithubService.java

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -25,10 +25,10 @@
2525
/**
2626
* GitHub API Service
2727
*
28-
* @see <a href="https://developer.github.com/v3/">api v3</>
29-
* @see <a href="https://developer.github.com/v3/rate_limit/">rate limit</>
30-
* @see <a href="https://developer.github.com/v3/search/#search-repositories">search</>
31-
* @see <a href="https://developer.github.com/v3/repos/branches/">branches</>
28+
* @see <a href="https://developer.github.com/v3/">api v3</a>
29+
* @see <a href="https://developer.github.com/v3/rate_limit/">rate limit</a>
30+
* @see <a href="https://developer.github.com/v3/search/#search-repositories">search</a>
31+
* @see <a href="https://developer.github.com/v3/repos/branches/">branches</a>
3232
* @author Martin Zeitler
3333
*/
3434
public interface GithubService {
@@ -48,11 +48,9 @@ Call<RepositorySearch> searchRepositories(
4848
@NonNull @Query(value = "page") Integer pageNumber
4949
);
5050

51-
/**
52-
* Organization repositories
53-
* @noinspection unused
54-
*/
51+
/** Organization repositories */
5552
@NonNull
53+
@SuppressWarnings("unused")
5654
@GET("orgs/{org}/repos")
5755
Call<ArrayList<Repository>> getOrgRepositories(
5856
@NonNull @Header("Authorization") String token,

library/src/main/java/io/syslogic/github/api/model/Owner.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
/**
1212
* Model: Owner
1313
*
14-
* @see <a href="https://developer.github.com/v3/repos/#get">repos/#get</>
14+
* @see <a href="https://developer.github.com/v3/repos/#get">repos/#get</a>
1515
* @author Martin Zeitler
1616
*/
1717
@Entity(tableName = Constants.TABLE_OWNERS)

library/src/main/java/io/syslogic/github/api/room/Abstraction.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,7 @@ public abstract class Abstraction extends RoomDatabase {
4444
/**
4545
* Asset `src/main/assets/room.db` must match the current schema version,
4646
* else this will also result in: "Room cannot verify the data integrity".
47+
* @param context any Content class.
4748
*/
4849
@NonNull
4950
public static Abstraction getInstance(@NonNull Context context) {

mobile/build.gradle

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -118,6 +118,8 @@ dependencies {
118118
implementation "androidx.fragment:fragment:$fragment_version"
119119

120120
// Room Runtime
121+
annotationProcessor "androidx.room:room-compiler:$room_version"
122+
testImplementation "androidx.room:room-testing:$room_version"
121123
implementation "androidx.room:room-runtime:$room_version"
122124

123125
// Retrofit2

0 commit comments

Comments
 (0)