Skip to content

Commit caf0641

Browse files
Build script: exclude new internal APIs from docs to avoid errors #259
1 parent 517e942 commit caf0641

File tree

1 file changed

+23
-4
lines changed

1 file changed

+23
-4
lines changed

objectbox-java/build.gradle

Lines changed: 23 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -35,18 +35,28 @@ tasks.spotbugsMain {
3535
}
3636
}
3737

38+
// Note: used for the Maven javadoc artifact, a separate task is used to build API docs to publish online
3839
javadoc {
39-
// Hide internal API from javadoc artifact.
40+
// Internal Java APIs
4041
exclude("**/io/objectbox/Cursor.java")
4142
exclude("**/io/objectbox/KeyValueCursor.java")
4243
exclude("**/io/objectbox/ModelBuilder.java")
4344
exclude("**/io/objectbox/Properties.java")
4445
exclude("**/io/objectbox/Transaction.java")
45-
exclude("**/io/objectbox/model/**")
4646
exclude("**/io/objectbox/ideasonly/**")
4747
exclude("**/io/objectbox/internal/**")
4848
exclude("**/io/objectbox/reactive/DataPublisherUtils.java")
4949
exclude("**/io/objectbox/reactive/WeakDataObserver.java")
50+
exclude("**/io/objectbox/sync/server/ClusterPeerInfo.java")
51+
// Repackaged FlatBuffers distribution
52+
exclude("**/io/objectbox/flatbuffers/**")
53+
// FlatBuffers generated files only used internally (note: some are part of the public API)
54+
exclude("**/io/objectbox/model/**")
55+
exclude("**/io/objectbox/sync/Credentials.java")
56+
exclude("**/io/objectbox/sync/CredentialsType.java")
57+
exclude("**/io/objectbox/sync/server/ClusterPeerConfig.java")
58+
exclude("**/io/objectbox/sync/server/JwtConfig.java")
59+
exclude("**/io/objectbox/sync/server/SyncServerOptions.java")
5060
}
5161

5262
// Note: use packageJavadocForWeb to get as ZIP.
@@ -63,17 +73,26 @@ tasks.register('javadocForWeb', Javadoc) {
6373
if (!srcApi.directory) throw new GradleScriptException("Not a directory: ${srcApi}", null)
6474
// Hide internal API from javadoc artifact.
6575
def filteredSources = sourceSets.main.allJava.matching {
76+
// Internal Java APIs
6677
exclude("**/io/objectbox/Cursor.java")
6778
exclude("**/io/objectbox/KeyValueCursor.java")
6879
exclude("**/io/objectbox/ModelBuilder.java")
6980
exclude("**/io/objectbox/Properties.java")
7081
exclude("**/io/objectbox/Transaction.java")
71-
exclude("**/io/objectbox/flatbuffers/**")
7282
exclude("**/io/objectbox/ideasonly/**")
7383
exclude("**/io/objectbox/internal/**")
74-
exclude("**/io/objectbox/model/**")
7584
exclude("**/io/objectbox/reactive/DataPublisherUtils.java")
7685
exclude("**/io/objectbox/reactive/WeakDataObserver.java")
86+
exclude("**/io/objectbox/sync/server/ClusterPeerInfo.java")
87+
// Repackaged FlatBuffers distribution
88+
exclude("**/io/objectbox/flatbuffers/**")
89+
// FlatBuffers generated files only used internally (note: some are part of the public API)
90+
exclude("**/io/objectbox/model/**")
91+
exclude("**/io/objectbox/sync/Credentials.java")
92+
exclude("**/io/objectbox/sync/CredentialsType.java")
93+
exclude("**/io/objectbox/sync/server/ClusterPeerConfig.java")
94+
exclude("**/io/objectbox/sync/server/JwtConfig.java")
95+
exclude("**/io/objectbox/sync/server/SyncServerOptions.java")
7796
}
7897
source = filteredSources + srcApi
7998

0 commit comments

Comments
 (0)