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

Merge pull request #26620 from akka/scaladocLinkingDoc

Browse source 
Link to SO answer on scaladoc link disambiguation
This commit is contained in:
Patrik Nordwall 2019-04-02 07:13:42 +02:00 • committed by GitHub
commit 1cf7ef39ea
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

3
CONTRIBUTING.md
View file

@ -288,6 +288,9 @@ 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),
though note that this syntax may not correctly render as Javadoc.
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).