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

Link to SO answer on scaladoc link disambiguation

Browse source
This commit is contained in:
Arnout Engelen 2019-03-27 13:47:35 +01:00
parent 076b16485b
commit cbafc18d2e
No known key found for this signature in database
GPG key ID: BB8C0F854A1E2105
1 changed files with 2 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

2
CONTRIBUTING.md
View file

@ -272,6 +272,8 @@ 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]]`.
For further hints on how to disambiguate links in scaladoc comments see
[this StackOverflow answer](https://stackoverflow.com/a/31569861/354132).
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).