Skip to content

Commit 7da14c2

Browse files
committed
Document new Scaladoc-only feature
1 parent 076e7f4 commit 7da14c2

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,15 @@ import com.lightbend.paradox.apidoc.ApidocPlugin.autoImport.apidocRootPackage
3535
(...)
3636
```
3737

38+
### When only Scaladoc is generated
39+
40+
If the project does not publish Javadoc, the corresponding Javadoc base URL can be cleared and the Java links will point to the `javadsl` package in the Scaladocs.
41+
42+
Example:
43+
```scala
44+
"javadoc.akka.stream.alpakka.base_url" -> ""
45+
```
46+
3847
## License
3948

4049
The license is Apache 2.0, see LICENSE.

0 commit comments

Comments
 (0)