From 8957a6728fda6cd1be2dd96f7248463c0bd77e5b Mon Sep 17 00:00:00 2001 From: Arnout Engelen Date: Fri, 2 Feb 2018 15:11:55 +0100 Subject: [PATCH] Document how to refer to methods from scaladoc (#24482) * Document how to refer to methods from scaladoc --- CONTRIBUTING.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 625e42dc2d..366e42724c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -245,7 +245,13 @@ The generated html documentation is in `akka-docs/target/paradox/site/main/index ### 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