Skip to content

Commit 3372103

Browse files
authored
Promote configuration of apidocRootPackage (#129)
... to be a mandatory step.
1 parent 2faf538 commit 3372103

File tree

1 file changed

+13
-11
lines changed

1 file changed

+13
-11
lines changed

README.md

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,23 @@ A [paradox](https://github.com/lightbend/paradox/) directive that automatically
99

1010
## Usage
1111

12+
Add the plugin:
13+
1214
```scala
1315
addSbtPlugin("com.lightbend.paradox" % "sbt-paradox-apidoc" % "<latest>")
1416
```
1517

18+
Configure the `apidocRootPackage` within your paradox settings:
19+
20+
```
21+
import com.lightbend.paradox.apidoc.ApidocPlugin.autoImport.apidocRootPackage
22+
23+
(...)
24+
apidocRootPackage := "akka",
25+
(...)
26+
```
27+
28+
1629
You can now create 'grouped' javadoc/scaladoc references in paradox like:
1730

1831
```
@@ -79,17 +92,6 @@ produce an unambigious result, you will have to use the FQCN.
7992
* Java: method - `akka/stream/javadsl/Flow.html#method()`
8093

8194

82-
To limit the packages that are searched for classes, configure the
83-
`apidocRootPackage` setting:
84-
85-
```
86-
import com.lightbend.paradox.apidoc.ApidocPlugin.autoImport.apidocRootPackage
87-
88-
(...)
89-
apidocRootPackage := "akka",
90-
(...)
91-
```
92-
9395
### When only Scaladoc is generated
9496

9597
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.

0 commit comments

Comments
 (0)