Skip to content

Commit

Permalink
Merge pull request #2 from coursier/fix-javadoc
Browse files Browse the repository at this point in the history
Fix javadoc
  • Loading branch information
alexarchambault authored May 28, 2024
2 parents 968eb94 + 04ef0d9 commit c4ddd07
Show file tree
Hide file tree
Showing 6 changed files with 37 additions and 35 deletions.
9 changes: 5 additions & 4 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,28 +15,29 @@ jobs:
with:
fetch-depth: 0
- uses: coursier/[email protected]
- uses: VirtusLab/scala-cli-setup@v1.0
- uses: VirtusLab/scala-cli-setup@v1
with:
power: true
- name: Compile
run: scala-cli compile . # Just in case, ensuring the project compiles fine as a pure Java project (--scala option required to run tests, see below)
- name: Test
run: scala-cli test . --scala 3.3.3 # Specifying a Scala version as a workaround for VirtusLab/scala-cli#2940
- name: Publish locally
run: rm -f project.ci.java && scala-cli publish local . # This ensures that javadoc generation succeeds in particular

publish:
needs: test
if: github.event_name == 'push'
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
with:
fetch-depth: 0
- uses: coursier/[email protected]
- uses: VirtusLab/scala-cli-setup@v1.0
- uses: VirtusLab/scala-cli-setup@v1
with:
power: true
- name: Publish
run: scala-cli publish . --doc=false # disabling javadoc because of VirtusLab/scala-cli#2939
run: scala-cli publish .
env:
PUBLISH_USER: ${{ secrets.PUBLISH_USER }}
PUBLISH_PASSWORD: ${{ secrets.PUBLISH_PASSWORD }}
Expand Down
6 changes: 6 additions & 0 deletions project.ci.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
//> using publish.ci.repository "central"
//> using publish.ci.user "env:PUBLISH_USER"
//> using publish.ci.password "env:PUBLISH_PASSWORD"
//> using publish.ci.secretKey "env:PUBLISH_SECRET_KEY"
//> using publish.ci.secretKeyPassword "env:PUBLISH_SECRET_KEY_PASSWORD"
//> using publish.ci.publicKey "env:PUBLISH_PUBLIC_KEY"
9 changes: 2 additions & 7 deletions project.java
Original file line number Diff line number Diff line change
@@ -1,16 +1,11 @@
//> using jvm "8"
//> using test.dependencies "junit:junit:4.13"
//> using test.dependencies "com.novocode:junit-interface:0.11"
//> using javacOpt -Xdoclint:none

//> using publish.organization "io.get-coursier.util"
//> using publish.name "directories-jvm"
//> using publish.ci.computeVersion "git:tag"
//> using publish.ci.repository "central"
//> using publish.ci.user "env:PUBLISH_USER"
//> using publish.ci.password "env:PUBLISH_PASSWORD"
//> using publish.ci.secretKey "env:PUBLISH_SECRET_KEY"
//> using publish.ci.secretKeyPassword "env:PUBLISH_SECRET_KEY_PASSWORD"
//> using publish.ci.publicKey "env:PUBLISH_PUBLIC_KEY"
//> using publish.computeVersion "git:tag"
//> using publish.license "MPL-2.0"
//> using publish.url "https://github.com/coursier/directories-jvm"
//> using publish.versionControl "github:coursier/directories-jvm"
Expand Down
16 changes: 8 additions & 8 deletions src/main/java/dev/dirs/BaseDirectories.java
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ public final class BaseDirectories {

/** Returns the path to the user's home directory.
* <br><br>
* <table border="1" cellpadding="1" cellspacing="0">
* <table summary="" border="1" cellpadding="1" cellspacing="0">
* <tr>
* <th align="left">Platform</th>
* <th align="left">Value</th>
Expand All @@ -48,7 +48,7 @@ public final class BaseDirectories {

/** Returns the path to the user's cache directory.
* <br><br>
* <table border="1" cellpadding="1" cellspacing="0">
* <table summary="" border="1" cellpadding="1" cellspacing="0">
* <tr>
* <th align="left">Platform</th>
* <th align="left">Value</th>
Expand All @@ -75,7 +75,7 @@ public final class BaseDirectories {

/** Returns the path to the user's configuration directory.
* <br><br>
* <table border="1" cellpadding="1" cellspacing="0">
* <table summary="" border="1" cellpadding="1" cellspacing="0">
* <tr>
* <th align="left">Platform</th>
* <th align="left">Value</th>
Expand All @@ -102,7 +102,7 @@ public final class BaseDirectories {

/** Returns the path to the user's data directory.
* <br><br>
* <table border="1" cellpadding="1" cellspacing="0">
* <table summary="" border="1" cellpadding="1" cellspacing="0">
* <tr>
* <th align="left">Platform</th>
* <th align="left">Value</th>
Expand All @@ -129,7 +129,7 @@ public final class BaseDirectories {

/** Returns the path to the user's local data directory.
* <br><br>
* <table border="1" cellpadding="1" cellspacing="0">
* <table summary="" border="1" cellpadding="1" cellspacing="0">
* <tr>
* <th align="left">Platform</th>
* <th align="left">Value</th>
Expand All @@ -156,7 +156,7 @@ public final class BaseDirectories {

/** Returns the path to the user's executable directory.
* <br><br>
* <table border="1" cellpadding="1" cellspacing="0">
* <table summary="" border="1" cellpadding="1" cellspacing="0">
* <tr>
* <th align="left">Platform</th>
* <th align="left">Value</th>
Expand All @@ -183,7 +183,7 @@ public final class BaseDirectories {

/** Returns the path to the user's preference directory.
* <br><br>
* <table border="1" cellpadding="1" cellspacing="0">
* <table summary="" border="1" cellpadding="1" cellspacing="0">
* <tr>
* <th align="left">Platform</th>
* <th align="left">Value</th>
Expand All @@ -210,7 +210,7 @@ public final class BaseDirectories {

/** Returns the path to the user's runtime directory.
* <br><br>
* <table border="1" cellpadding="1" cellspacing="0">
* <table summary="" border="1" cellpadding="1" cellspacing="0">
* <tr>
* <th align="left">Platform</th>
* <th align="left">Value</th>
Expand Down
12 changes: 6 additions & 6 deletions src/main/java/dev/dirs/ProjectDirectories.java
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ private ProjectDirectories(
/** Returns the path to the project's cache directory,
* in which {@code <project_path>} is the value of {@link ProjectDirectories#projectPath}.
* <br><br>
* <table border="1" cellpadding="1" cellspacing="0">
* <table summary="" border="1" cellpadding="1" cellspacing="0">
* <tr>
* <th align="left">Platform</th>
* <th align="left">Value</th>
Expand Down Expand Up @@ -76,7 +76,7 @@ private ProjectDirectories(
/** Returns the path to the project's configuration directory,
* in which {@code <project_path>} is the value of {@link ProjectDirectories#projectPath}.
* <br><br>
* <table border="1" cellpadding="1" cellspacing="0">
* <table summary="" border="1" cellpadding="1" cellspacing="0">
* <tr>
* <th align="left">Platform</th>
* <th align="left">Value</th>
Expand Down Expand Up @@ -104,7 +104,7 @@ private ProjectDirectories(
/** Returns the path to the project's data directory,
* in which {@code <project_path>} is the value of {@link ProjectDirectories#projectPath}.
* <br><br>
* <table border="1" cellpadding="1" cellspacing="0">
* <table summary="" border="1" cellpadding="1" cellspacing="0">
* <tr>
* <th align="left">Platform</th>
* <th align="left">Value</th>
Expand Down Expand Up @@ -132,7 +132,7 @@ private ProjectDirectories(
/** Returns the path to the project's local data directory,
* in which {@code <project_path>} is the value of {@link ProjectDirectories#projectPath}.
* <br><br>
* <table border="1" cellpadding="1" cellspacing="0">
* <table summary="" border="1" cellpadding="1" cellspacing="0">
* <tr>
* <th align="left">Platform</th>
* <th align="left">Value</th>
Expand Down Expand Up @@ -160,7 +160,7 @@ private ProjectDirectories(
/** Returns the path to the project's preference directory,
* in which {@code <project_path>} is the value of {@link ProjectDirectories#projectPath}.
* <br><br>
* <table border="1" cellpadding="1" cellspacing="0">
* <table summary="" border="1" cellpadding="1" cellspacing="0">
* <tr>
* <th align="left">Platform</th>
* <th align="left">Value</th>
Expand All @@ -187,7 +187,7 @@ private ProjectDirectories(

/** Returns the path to the project's runtime directory.
* <br><br>
* <table border="1" cellpadding="1" cellspacing="0">
* <table summary="" border="1" cellpadding="1" cellspacing="0">
* <tr>
* <th align="left">Platform</th>
* <th align="left">Value</th>
Expand Down
20 changes: 10 additions & 10 deletions src/main/java/dev/dirs/UserDirectories.java
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ public final class UserDirectories {

/** Returns the path to the user's home directory.
* <br><br>
* <table border="1" cellpadding="1" cellspacing="0">
* <table summary="" border="1" cellpadding="1" cellspacing="0">
* <tr>
* <th align="left">Platform</th>
* <th align="left">Value</th>
Expand All @@ -46,7 +46,7 @@ public final class UserDirectories {

/** Returns the path to the user's audio directory.
* <br><br>
* <table border="1" cellpadding="1" cellspacing="0">
* <table summary="" border="1" cellpadding="1" cellspacing="0">
* <tr>
* <th align="left">Platform</th>
* <th align="left">Value</th>
Expand All @@ -73,7 +73,7 @@ public final class UserDirectories {

/** Returns the path to the user's desktop directory.
* <br><br>
* <table border="1" cellpadding="1" cellspacing="0">
* <table summary="" border="1" cellpadding="1" cellspacing="0">
* <tr>
* <th align="left">Platform</th>
* <th align="left">Value</th>
Expand All @@ -100,7 +100,7 @@ public final class UserDirectories {

/** Returns the path to the user's document directory.
* <br><br>
* <table border="1" cellpadding="1" cellspacing="0">
* <table summary="" border="1" cellpadding="1" cellspacing="0">
* <tr>
* <th align="left">Platform</th>
* <th align="left">Value</th>
Expand All @@ -127,7 +127,7 @@ public final class UserDirectories {

/** Returns the path to the user's download directory.
* <br><br>
* <table border="1" cellpadding="1" cellspacing="0">
* <table summary="" border="1" cellpadding="1" cellspacing="0">
* <tr>
* <th align="left">Platform</th>
* <th align="left">Value</th>
Expand All @@ -154,7 +154,7 @@ public final class UserDirectories {

/** Returns the path to the user's font directory.
* <br><br>
* <table border="1" cellpadding="1" cellspacing="0">
* <table summary="" border="1" cellpadding="1" cellspacing="0">
* <tr>
* <th align="left">Platform</th>
* <th align="left">Value</th>
Expand All @@ -181,7 +181,7 @@ public final class UserDirectories {

/** Returns the path to the user's picture directory.
* <br><br>
* <table border="1" cellpadding="1" cellspacing="0">
* <table summary="" border="1" cellpadding="1" cellspacing="0">
* <tr>
* <th align="left">Platform</th>
* <th align="left">Value</th>
Expand All @@ -208,7 +208,7 @@ public final class UserDirectories {

/** Returns the path to the user's public directory.
* <br><br>
* <table border="1" cellpadding="1" cellspacing="0">
* <table summary="" border="1" cellpadding="1" cellspacing="0">
* <tr>
* <th align="left">Platform</th>
* <th align="left">Value</th>
Expand All @@ -235,7 +235,7 @@ public final class UserDirectories {

/** Returns the path to the user's template directory.
* <br><br>
* <table border="1" cellpadding="1" cellspacing="0">
* <table summary="" border="1" cellpadding="1" cellspacing="0">
* <tr>
* <th align="left">Platform</th>
* <th align="left">Value</th>
Expand All @@ -262,7 +262,7 @@ public final class UserDirectories {

/** Returns the path to the user's video directory.
* <br><br>
* <table border="1" cellpadding="1" cellspacing="0">
* <table summary="" border="1" cellpadding="1" cellspacing="0">
* <tr>
* <th align="left">Platform</th>
* <th align="left">Value</th>
Expand Down

0 comments on commit c4ddd07

Please sign in to comment.