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

Document how to refer to methods from scaladoc (#24482)

Browse source 
* Document how to refer to methods from scaladoc
This commit is contained in:
Arnout Engelen 2018-02-02 15:11:55 +01:00 • committed by Christopher Batey
parent 070645767d
commit 8957a6728f
1 changed files with 7 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

8
CONTRIBUTING.md
View file

@ -245,7 +245,13 @@ The generated html documentation is in `akka-docs/target/paradox/site/main/index
### Scaladoc ### Scaladoc
Akka generates class diagrams for the API documentation using ScalaDoc. This needs the `dot` command from the Graphviz software package to be installed to avoid errors. You can disable the diagram generation by adding the flag `-Dakka.scaladoc.diagrams=false`. After installing Graphviz, make sure you add the toolset to the PATH (definitely on Windows). Akka generates class diagrams for the API documentation using ScalaDoc.
Links to methods in ScalaDoc comments should be formatted
`[[Like#this]]`, because `[[this]]` does not work with genjavadoc, and
IntelliJ warns about `[[#this]]`.
The Scaladoc tool needs the `dot` command from the Graphviz software package to be installed to avoid errors. You can disable the diagram generation by adding the flag `-Dakka.scaladoc.diagrams=false`. After installing Graphviz, make sure you add the toolset to the PATH (definitely on Windows).
### JavaDoc ### JavaDoc