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
1
vote
0 answers
Custom graph in scaladoc
Is there any easy way how to add graph to my scaladoc documentation?
I have found only the possibility to generate class hierarchy graphs but I want to include my own graph.
The only way I have found is to create external image and include it into…
eNca
- 1,043
- 11
- 21
1
vote
1 answer
Disable ScalaDoc / Javadoc in Play 2.5.x from command line using build.sbt
What is the best way to disable scaladoc / javadoc during Activator dist task.
I tried the following but it did not work
val genDocs: java.lang.Boolean = java.lang.Boolean.getBoolean(Option(System.getProperty("genDocs")).getOrElse("true"))
import…
Reg Mem
- 611
- 1
- 7
- 19
1
vote
1 answer
Setting scaladoc header/footer in Gradle
I'm not sure how to set ScalaDoc options in Gradle, but it appears possible because I see that Gradle has ScalaDoc and ScalaDocOptions. ScalaDocOptions has a setFooter, which I am interested in calling.
How do I use these methods?
Ben McCann
- 18,548
- 25
- 83
- 101
1
vote
0 answers
Scaladoc tag for HTTP request body?
I am using Play2 with Scala and I would like to write information about the body of the request in the endpoint Scaladoc.
/**
* Replaces images for a given user.
*
* @param id The user id
* @body a multipart HTTP body with the image files …
ticofab
- 7,551
- 13
- 49
- 90
1
vote
0 answers
Scaladoc: Is it possible to insert a link into every page?
Is it possible to insert a link to my home page into every Scaladoc page? Is there a way to add content, modify the layout, or even change the style of every page?
Rich Oliver
- 6,001
- 4
- 34
- 57
1
vote
0 answers
Not able find method probablePrime() in scala doc for BigInt class
I am quite new in Scala, I was searching probablePrime() method in scala doc of BIgInt class . But i could not see the method . While i checked the github coce for the BigInt.scala , there i found it is present.
Can any body make me understand why…
Priyaranjan Swain
- 361
- 4
- 17
1
vote
0 answers
Inherit Scala standard classes documentation in Scaladoc
This should be a easy question but I just can't find a clear answer.
I'm trying to create a Scaladoc for my project. Let's say I have a class such as:
/**
* This is an example
*/
object foo extends Enumeration {
...
}
Then I generate a Scaladoc…
Rors
- 159
- 2
- 10
1
vote
2 answers
How do you modify block comment alignment in Intellij IDEA with Scala?
Currently when Intellij IDEA autocompletes block comments, e.g. typing /**+, IDEA will create a block comment like so:
/**
* Comment goes here
*/
However, scaladoc recommends that block comment bodies are aligned differently:
/**
*…
Mycleung
- 76
- 6
1
vote
1 answer
scaladoc Ant task writing for multiple source directories?
I wish to compile scaladoc and javadoc in a project with both scala and java in it. The project has more than one source directory (each of which may have scala or javadoc). I tried:
dfrankow
- 20,191
- 41
- 152
- 214
1
vote
0 answers
Scaladoc, SBT and case classes and scala version 2.11.x
I have a problem when generating scaladoc for scala 2.11.7 in a Intellij IDEA SBT project with case classes. For example, with this code:
package main
/**
*
* @param a
*/
case class SomeClass(a: Int) {
}
when I try to generate the scaladoc,…
vicaba
- 2,836
- 1
- 27
- 45
1
vote
1 answer
Automatically include javascript in Scaladoc using SBT
I am working on a library of mathematical functions. As part of the Scaladoc, I would like to include the formula of each function. E.g.
/**
* Sum squared function:
* \(f(x) = \sum_i^n x_i^2\)
*/
def sumSquared[T](x: Seq[T]) = x.map(xi => xi *…
robgarden
- 11
- 2
1
vote
0 answers
How to link to JDK?
I want to have links like
Javadoc {@link Object#toString()}
Scaladoc [[Object#toString()]]
How can I do this with scaladoc?
I assume I'll have to provide the external URL to link to.
Paul Draper
- 78,542
- 46
- 206
- 285
1
vote
1 answer
How to specify additional source directory for scaladoc?
I have a bit of a nonstandard sbt build setup due to the need to use both Eclipse and sbt.
My sources are in src/main/scala and src/com/companyname/[folder1, folder2, etc] directories.
How can I set up sbt so it also generates documentation for…
Steve H.
- 253
- 1
- 3
- 12
1
vote
1 answer
Scaladoc from IDEA or Maven
I'm using Maven for builds and IntelliJ IDEA with the Scala plugin. The project runs and debugs fine using the Scala 2.10.3 dependencies in my pom.
But when I try to use IDEA to generate Scaladocs from my whole project It literally does nothing, no…
pferrel
- 5,673
- 5
- 30
- 41
1
vote
1 answer
How to generate hierarchy/UML diagram with Play 2.2.x?
I know you can use scaladoc itself to generate hierarchy diagrams but how do I use play doc to do that?
pathikrit
- 32,469
- 37
- 142
- 221