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
7
votes
1 answer
Is there an easy way to integrate scaladoc into IntelliJ Idea?
How do I use/generate scaladoc from within IntelliJ Idea (running on ubuntu)? Most preferably I would like to configure Tools/generate javadoc to also generate scaladoc, though that might be hard as of the differences between both according to this…
Jasper
- 1,971
- 19
- 34
7
votes
1 answer
What's causing this Scala error message?
I seem to have found my way to a weird error message. I'm storing a password, and I have a comment that says
/** A password hash is stored as `"algorithm$iterations$salt$hash"`
* with the number of iterations optional for some algorithms
When I…
Todd O'Bryan
- 2,234
- 17
- 30
6
votes
2 answers
Scaladoc swallowed @throws and @note tags
When creating a Scala documentation I also use the @throws and @note tags like documented here (Scaladoc Wiki - Tags and Annotations).
Unfortunately I can't find these in the generated Scaladoc.
Do one have to set certain switches, consider…
binuWADa
- 616
- 2
- 7
- 15
6
votes
5 answers
Is there a command line program to lookup Scaladoc?
Ruby has a program called ri where you can type in 'ri Array' and get its manpage. Is there something like that for scaladoc?
tommy chheng
- 9,108
- 9
- 55
- 72
6
votes
0 answers
Problems with Scaladoc Linking to Classes in Comment Blocks
I may be missing something obvious, but I can't get Scaladoc to link to classes—only to companion objects. Consider these examples.
This works fine:
/** Returns a [[scala.List]] (also known as [[scala.collection.immutable.List]]). */
While this…
Michael Ahlers
- 616
- 7
- 21
6
votes
1 answer
Scaladoc fails to generate links for inner classes in method and class signatures
I have a top level trait that contains a number of classes and traits like:
trait Trees { self: Types =>
trait Tree
trait IdentifiedTree extends Tree
trait Empty extends Tree
/** The factory for [[TypeUse]] instances */
trait TypeUse…
Amanj Sherwany
- 236
- 2
- 13
6
votes
1 answer
How to escape /* in scaladoc?
I have a comment that contains an example Java servlet configuration. It looks like:
/** Blah blah blah...
*
* {{{
*
* MyAppServlet
* /app/*
* …
Rob N
- 15,024
- 17
- 92
- 165
6
votes
1 answer
Where is the man page for scaladoc?
Looking at http://www.scala-sbt.org/release/docs/Howto/scaladoc.html there are examples for giving scaladoc options such -groups and -implicits.
Where is the information regarding the scaladoc (2.10) options? Like a man page. I can't seem to find…
0__
- 66,707
- 21
- 171
- 266
6
votes
3 answers
Can I use sbt's `apiMappings` setting for managed dependencies?
I'd like the ScalaDoc I generate with sbt to link to external libraries, and in sbt 0.13 we have autoAPIMappings which is supposed to add these links for libraries that declare their apiURL. In practice though, none of the libraries I use provide…
Thomas Dufour
- 1,872
- 1
- 16
- 20
6
votes
1 answer
Finding Scaladoc help, reduceLeft
Say, i am looking to better understand what reduceLeft method does when applied on a Array[String]
The scaladoc says:
Ok, i must ask again, what does this method do? And what's more important, if i can't rely on scaladoc to tell me that, where can…
James Raitsev
- 92,517
- 154
- 335
- 470
5
votes
1 answer
Cannot add package description in ScalaDoc (Scala 3)
I cannot add a package description in ScalaDoc with Scala 3
/** package description */
package foo {
/** some scaladoc comment */
def method():A = ???
}
Then I generate the doc with sbt (1.5.3)
sbt> doc
I don't get the description of the…
lepaincestbon
- 331
- 1
- 5
5
votes
1 answer
How do I link variables inside another object in scaladocs?
To link another class, I can use [[package.Classname]].
Linking functions defined by def works as well, but trying to link variables doesn't work.
What I've tried:
object Foo {
val BAR = 0
}
object Example {
/**
* Does the thing with…
Edward
- 89
- 1
- 5
5
votes
2 answers
Is is possible to reference function's parameter in the documention text?
I woul like to reference method's parameters in the documentation text,
but have no idea how to do it.
In .NET world we use tag paramref
Just as an example:
/** Send email with the specified @paramref body to the addesses given in @paramref…
Pavel Voronin
- 13,503
- 7
- 71
- 137
5
votes
1 answer
Scaladoc generation fails when referencing methods generated by annotation macros
I have two classes, call them Foo and Fizz. Foo uses an annotation macro called expand to make aliases of some of its methods (the actual implementation does a little more than creating aliases, but the simple version still exhibits the problem that…
Michael Zajac
- 55,144
- 7
- 113
- 138
5
votes
2 answers
Scala Docs in IntelliJ
How do I access Scala docs in IntelliJ? The other answers in SO are for earlier versions. I added the scala doc jar file, but still I am unable to link scala docs with IntelliJ.
I do get the Quick Documentation as shown:
But I want the complete doc…
codingsplash
- 4,785
- 12
- 51
- 90