Skip to content

Commit 86a7ccd

Browse files
notusedusernameMathieuSoysal
authored andcommitted
docs(#95): Added fix details to README
1 parent d53c2d4 commit 86a7ccd

1 file changed

Lines changed: 11 additions & 1 deletion

File tree

README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,17 @@ Automatically generate Javadoc from your Java project and publish it to GitHub P
2828
| subdirectories | Custom subdirectories to upload from | |
2929
| without-deploy | Enable or disable deploy of the javadoc to the GitHub Page | false |
3030
| without-checkout | Enable or disable the checkout | false |
31-
| javadoc-source-folder | The folder where our project generate the JavaDoc | target/reports/apidocs |
31+
| javadoc-source-folder | The folder where our project generate the JavaDoc | default location based on the build tool<sup>[1]</sup> |
32+
33+
34+
<sup>[1]</sup>: The default value of the `javadoc-source-folder` is determined dynamically based on the build tool (`project` input).
35+
For Maven the action will search for the plugin output in the possible output directories to find the correct path.
36+
37+
| project | `maven-javadoc-plugin` version (detected) | default |
38+
|-------------|----------------------------------------------------|----------------------------------|
39+
| gradle | Not affected | `build/docs/javadoc` |
40+
| maven | older than `3.10.0` | `target/site/apidocs` |
41+
| maven | newer than `3.10.0` | `target/reports/apidocs` |
3242

3343
</details>
3444

0 commit comments

Comments
 (0)