Reputation: 2692
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 ?
Upvotes: 22
Views: 5303
Reputation: 1515
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.
Upvotes: 38