Skip to content

Commit

Permalink
use splitindex for javadoc
Browse files Browse the repository at this point in the history
  • Loading branch information
jenschude committed Jul 14, 2023
1 parent be73efe commit a6e9a5f
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 3 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ jobs:
- run: ./gradlew -Pversion=${{ github.event.inputs.version }} alljavadoc
working-directory: sdk

- run: rm -rf doc/javadoc && mv sdk/build/docs/javadoc doc
- run: rsync -r sdk/build/docs/javadoc/ doc/javadoc

- uses: stefanzweifel/git-auto-commit-action@v4
with:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ jobs:
- run: ./gradlew -Pversion=${{ github.ref_name }} alljavadoc
working-directory: sdk

- run: rm -rf doc/javadoc && mv sdk/build/docs/javadoc doc
- run: rsync -r sdk/build/docs/javadoc/ doc/javadoc

- uses: stefanzweifel/git-auto-commit-action@v4
with:
Expand Down
5 changes: 4 additions & 1 deletion build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -229,7 +229,7 @@ tasks.register('alljavadoc', Javadoc) {
setMemberLevel JavadocMemberLevel.PUBLIC
setAuthor false
noTimestamp = true

splitIndex = true
links 'https://docs.oracle.com/javase/8/docs/api/', "https://www.javadoc.io/doc/com.fasterxml.jackson.core/jackson-databind/${versions.jackson}/", 'https://commercetools.github.io/commercetools-jvm-sdk/apidocs/', 'https://newrelic.github.io/java-agent-api/javadoc/'
overview = "src/main/javadoc/overview.html"
bottom = """
Expand All @@ -246,6 +246,7 @@ tasks.register('alljavadoc', Javadoc) {
addBooleanOption('-allow-script-in-comments', true)
addStringOption('Xdoclint:missing,accessibility,reference', '-quiet')
addBooleanOption('linksource', true)
encoding = 'utf-8'
groups = [
"API" : ["com.commercetools.api.*"],
"History" : ["com.commercetools.history.*"],
Expand Down Expand Up @@ -285,6 +286,7 @@ tasks.register('internaldocs', Javadoc) {
setMemberLevel JavadocMemberLevel.PUBLIC
setAuthor false
noTimestamp = true
splitIndex = true

links 'https://docs.oracle.com/javase/8/docs/api/', "https://www.javadoc.io/doc/com.fasterxml.jackson.core/jackson-databind/${versions.jackson}/", 'https://commercetools.github.io/commercetools-jvm-sdk/apidocs/'
overview = "src/main/javadoc/overview.html"
Expand All @@ -299,6 +301,7 @@ tasks.register('internaldocs', Javadoc) {
taglets = ['com.commercetools.taglets.CodeTaglet','com.commercetools.taglets.ToCTaglet', 'com.commercetools.taglets.FileIncludeTaglet', 'org.jdrupes.taglets.plantUml.StartUml', 'org.jdrupes.taglets.plantUml.EndUml', 'org.jdrupes.taglets.plantUml.PlantUml']
tagletPath = configurations.taglet.files as List
maxMemory = '2g'
encoding = 'utf-8'
addBooleanOption('-allow-script-in-comments', true)
addStringOption('Xdoclint:missing,accessibility,reference', '-quiet')
addBooleanOption('linksource', true)
Expand Down

0 comments on commit a6e9a5f

Please sign in to comment.