From 8d96e6e8ce34206774d7cbbf07acf64f3c0087a7 Mon Sep 17 00:00:00 2001
From: Arnout Engelen <arnout@bzzt.net>
Date: Wed, 27 Mar 2019 15:12:58 +0100
Subject: [PATCH] Javadoc caveat

---
 CONTRIBUTING.md | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index af1a022f3f..bb4860c283 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -273,7 +273,8 @@ 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).
+[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).