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
Questions tagged [scaladoc]
146 questions
12
votes
1 answer
How to exclude java source files in doc task?
I'm using sbt 0.11.2 for a mixed Java/Scala project. I've realized that when I run the doc command from within sbt, it does not only create the scaladocs for the Scala source files in src/main/scala, but also for the Java source files in…
pemistahl
- 9,304
- 8
- 45
- 75
11
votes
1 answer
How to use @See scaladoc?
What is the exact syntax of using @See scaladoc? How do I reference:
a method in the same class
another class
an "http" reference
?
VasiliNovikov
- 9,681
- 4
- 44
- 62
11
votes
1 answer
Scaladoc diagrams
Is it possible to generate diagrams with Scaladoc and SBT?
I tried to add this line in my build.sbt:
scalacOptions in (Compile,doc) := Seq("-diagrams", "-diagrams-debug")
But I receive:
Diagram generation running time breakdown:
diagrams model…
Thibaud Dauce
- 367
- 4
- 14
11
votes
1 answer
Why does Scalaz show up in my project's API docs?
Suppose my entire project configuration is this simple build.sbt:
scalaVersion := "2.11.4"
libraryDependencies += "org.scalaz" %% "scalaz-core" % "7.1.0"
And this is my code:
import scalaz.Equal
import scalaz.syntax.equal._
object Foo {
def…
Travis Brown
- 138,631
- 12
- 375
- 680
11
votes
1 answer
Which new features are (or will be) added to Scaladoc in Scala 2.10?
Among all the various incomplete lists of features going into Scala 2.10, there are various mentions of improvements to Scaladoc. But it's unclear which ones there are, and which ones are actually going in -- e.g. one of the lists of improvements…
Urban Vagabond
- 7,282
- 3
- 28
- 31
10
votes
2 answers
Scala Eclipse plugin doesn't show mouse hover documentation
I just installed the Scala IDE Eclipse plugin with a fresh install of Eclipse Indigo. I followed the getting started youtube video on the scala-ide.org main page on a fresh installation of Indigo. Instead of showing the complete documentation for…
Jeff Axelrod
- 27,676
- 31
- 147
- 246
10
votes
1 answer
How to merge documentation from SBT multi-projects?
I am generating the ScalaDoc HTML files for some SBT projects (in a Multi-Project configuration). If I execute doc in the SBT console, the documentation is generated nicely, but it is deployed in a standalone directory for each project. Since all…
neutropolis
- 1,884
- 15
- 34
10
votes
1 answer
SBT Scaladoc Configuration
I'm trying to configure the Scaladoc in SBT, specifically the title, output directory and classpath.
I managed to define the title by adding the following to build.sbt:
scalacOptions in (Compile, doc) ++= Opts.doc.title("Scala-Tools")
I can't…
user510159
- 1,379
- 14
- 26
9
votes
1 answer
How to reference the name of a val in a Object class in scaladoc?
Is there a way that I can reference the name of a val in a Object class using scaladoc, similar to
{@value #STATIC_FIELD}
in javadoc.
sma
- 877
- 2
- 9
- 24
9
votes
1 answer
How to generate links to standard library types in scaladoc?
I'm using sbt 0.13.7 and Scala 2.11.4.
In my build.sbt, I have:
autoAPIMappings := true
and in a File.scala:
/** scaladoc link to [[scala.concurrent.duration.FiniteDuration]] */
When running sbt doc, I’m getting:
[warn] ...:5: Could not find any…
Michal Rus
- 1,796
- 2
- 18
- 27
9
votes
1 answer
Generate Scala API docs without JavaScript, but static HTML or Markdown
For an in-application help browser, I would like to render API docs. Unfortunately, Scaladoc seems to produce only HTML files full of horrible JavaScript stuff, so it's impossible to render these files even with rather heavy weight components such…
0__
- 66,707
- 21
- 171
- 266
8
votes
1 answer
Overriding auto API mappings in SBT
I have a few libraries that depend on Cats. Let's say the new Cats 0.4.0 release has the wrong apiURL value in its POM. I don't want my API docs to break, so I provide the URL mapping with apiMappings:
..
autoAPIMappings := false,
apiMappings…
Travis Brown
- 138,631
- 12
- 375
- 680
8
votes
1 answer
Why are scaladoc method signatures wrong?
There are a lot of places in the Scala API, particularly in collections, where method signatures are wrong.
For example, the scaladoc signature for Map.flatMap says
def flatMap[B](f: (A) ⇒ GenTraversableOnce[B]): Map[B]
But the actual signature…
Chris Martin
- 30,334
- 10
- 78
- 137
8
votes
2 answers
Where to place resources, e.g. images, that scaladoc can use?
I am currently writing the documentation of an API written in Scala. I would like to include several diagrams to make the code more understandable.
I am wondering where to put resources (such as diagrams) in order that they can be automatically…
GDD
- 319
- 2
- 6
8
votes
2 answers
Cannot create ScalaDoc link for overloaded method
I am running into a problem with ScalaDoc not accepting a method link when using overloading.
A standalone example: File project/build.properties:
sbt.version=0.13.2
File build.sbt:
scalaVersion := "2.11.0"
File src/main/scala/Foo.scala:
package…
0__
- 66,707
- 21
- 171
- 266