Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Is there a way to include hyperlink to some external HTTP URL in Scaladoc?

Using Scaladoc, is there a way to include hyperlink to some external HTTP URL ?

using Javadoc this was easy.. but I am having trouble figuring out the syntax for Scaladoc. I looked here: https://wiki.scala-lang.org/display/SW/Writing+Documentation, but came up dry.

Say I want to link to an external resource like this > https://en.wikipedia.org/wiki/Aardvark < in my documentation. What is the markup I should use ?

like image 606
Chris Bedford Avatar asked Jan 26 '16 22:01

Chris Bedford


1 Answers

You can try this :

External links: [[http://scala-lang.org Scala web site]] becomes Scala web site. The URL part must start with a scheme name (like http:) and must not contain white space. The name part (Scala web site) is optional.

like image 150
meucaa Avatar answered Oct 20 '22 17:10

meucaa