Stack Overflow
Stack Overflow

Questions tagged [scaladoc]

Scaladoc is a documentation generation system which reads specially formatted comments in Scala source code and generates compiled documentation. It is typically used to produce API documentation in the form of HTML web pages.

Resources

146 questions
47
votes
2 answers

Viewing Scaladoc in Eclipse

In Eclipse I have set the Javadoc Location property of my Scala project to file:/D:/EclipseWorkspace/MyProject/target/scala-2.9.1/api where D:/EclipseWorkspace/MyProject is the location of my scala project. Now, if I am in a Scala file that…
dips
  • 1,627
  • 14
  • 25
41
votes
4 answers

How to disambiguate links to methods in scaladoc?

I'm documenting a Scala class with overloaded methods. How can I distinguish them when referring to them in scaladoc comments? For example, if I have /** * The most important method is [[Doc.foo]]. */ object Doc { def foo[A]: A = throw new…
Petr
  • 62,528
  • 13
  • 153
  • 317
38
votes
1 answer

How to disable ScalaDoc generation in dist task in Play 2.2.x (using project/build.scala)?

Adding the following settings to the build.sbt file of a Play 2.2.x app does not disable Scaladoc generation. How can it be disabled? play.Project(appName, appVersion, appDependencies) .settings(scalaVersion := "2.10.3") …
Max L.
  • 9,774
  • 15
  • 56
  • 86
22
votes
5 answers

Where to find tutorials for scaladoc 2?

I binged or googled for scaladoc 2.0 tutorial or example, I could not find anything, in fact not even a link to official scaladoc 2.0 documentation. Anyone know where to find one?
rjc
  • 2,885
  • 8
  • 32
  • 40
21
votes
1 answer

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,…
Chris Bedford
  • 2,560
  • 3
  • 28
  • 60
21
votes
3 answers

Where to download the latest Scala API documentation?

Since Scala 2.10.2, I can't find the download link for its API documentation. Is this an intentional omission? Where can I download it? Alternatively, what is the exact scalac command to generate the same one with…
trustin
  • 12,231
  • 6
  • 42
  • 52
21
votes
2 answers

How to link classes from JDK into scaladoc-generated doc?

I'm trying to link classes from the JDK into the scaladoc-generated doc. I've used the -doc-external-doc option of scaladoc 2.10.1 but without success. I'm using…
Bruno Bieth
  • 2,317
  • 20
  • 31
19
votes
3 answers

How to search for methods in Scaladoc, globally?

Is there any possibility that i can search for a method in a class, trait or object via scala doc, globally? Example: I have a method name and I don't know which class it belongs to so i can type it in some scaladoc search and it will show me…
AndreasScheinert
  • 1,918
  • 12
  • 18
19
votes
5 answers

Searching the Scala documentation for #::

I am trying to find the documentation for the Scala operator method #::. I believe that it is defined in the Stream class because of an example I found that uses it. My question is not particular to this method (although I would like to know where…
Ralph
  • 31,584
  • 38
  • 145
  • 282
17
votes
3 answers

sbt test:doc Could not find any member to link

I'm attempting to run sbt test:doc and I'm seeing a number of warnings similar to below: [warn] /Users/tleese/code/my/stuff/src/test/scala/com/my/stuff/common/tests/util/NumberExtractorsSpecs.scala:9: Could not find any member to link for…
Taylor Leese
  • 51,004
  • 28
  • 112
  • 141
16
votes
2 answers

In Scaladoc, how to link to a method in the same class?

What is the correct way to create link to a method in the same class? Scaladoc documentation doesn't have examples of this. Consider a class such as: package controllers // import ... class AccountController extends Controller with Secured { …
Jonik
  • 80,077
  • 70
  • 264
  • 372
15
votes
4 answers

Is there a way to include math formulae in Scaladoc?

I would like to enter math formulae in Scaladoc documentation of mathematical Scala code. In Java, I found a library called LatexTaglet that can do exactly this for Javadoc, by writing formulae in Latex: http://latextaglet.sourceforge.net/ And it…
Choucri
  • 250
  • 1
  • 7
14
votes
3 answers

Scaladoc (2.11.6) fails on throws tag with "unable to find any member to link"

When attempting to publish the jars for my project via sbt "++2.11.6 publishLocal" or sbt +publishLocal, I encounter Scaladoc issues when publishing for Scala 2.11.6. It appears that I have invalid links caused by the @throws tag. I am not sure why…
Senkwich
  • 1,022
  • 1
  • 9
  • 17
13
votes
1 answer

Scaladoc [use case]

Why do some method descriptions in Scaladoc start with [use case]? Example: scala.collection.immutable.StringOps.++ Is it just a placeholder to be replaced in the future?
Nermin Serifovic
  • 1,327
  • 1
  • 8
  • 18
13
votes
1 answer

How to generate type hierarchy diagrams with Scaladoc?

I want that Scaladoc generates a type hierarchy diagram for the following code snippet: trait A trait B extends A But when I execute scaladoc .scala there is no type hierarchy shown - neither in A nor in B. How can I generate such diagrams?
kiritsuku
  • 52,967
  • 18
  • 114
  • 136
1
2 3
…
9 10