raboof/pekko
1
0
Fork 0
Code Issues Pull requests Projects Releases 6 Packages Wiki Activity Actions 10

Docs: add some API links to stream operator docs (#28180)

Browse source 
* Docs: add some API links to stream operator docs

* Complement CONTRIBUTION.md

* Switch to frameless Javadoc
This commit is contained in:
Enno 2019-12-03 09:16:05 +01:00 • committed by Arnout Engelen
parent d53d3701fa
commit 4d04bb968b
6 changed files with 21 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

10
CONTRIBUTING.md
View file

@ -312,6 +312,16 @@ akka-docs/paradox
The generated html documentation is in `akka-docs/target/paradox/site/main/index.html`.
Alternatively, use `akka-docs/paradoxBrowse` to open the generated docs in your default web browser.
### Links to API documentation
Akka Paradox supports directives to link to the Scaladoc- and Javadoc-generated API documentation:
* `@apidoc[Flow]` searches for the class name and creates links to Scaladoc and Javadoc (see variants in [sbt-paradox-apidoc](https://github.com/lightbend/sbt-paradox-apidoc#examples))
* `@scaladoc[Flow](akka.stream.scaladsl.Flow)` (see [Paradox docs](https://developer.lightbend.com/docs/paradox/current/directives/linking.html#scaladoc-directive))
* `@javadoc[Flow](akka.stream.javadsl.Flow)` (see [Paradox docs](https://developer.lightbend.com/docs/paradox/current/directives/linking.html#javadoc-directive))
### Scaladoc
Akka generates class diagrams for the API documentation using ScalaDoc.