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
2
votes
2 answers
scaladoc for Play! Framework with Scala module
I'm a bit stumped as to how to run scaladoc on a Play! framework project. It seems there are a lot of intricacies to account for, and I'm not having success.
Is there a tutorial I am missing? Do you need to add in sbt or a build tool to make it…
Kevin Bowling
- 323
- 4
- 11
2
votes
1 answer
Link Scala annotation in ScalaDoc
In ScalaDoc I want to have a link to an annotation from a library: discriminator.
My ScalaDoc:
/** Trait must be marked with [[json.schema.discriminator]] annotation. */
But ScalaDoc generation fails with the following error:
Could not find any…
Denis Kokorin
- 887
- 8
- 17
2
votes
1 answer
Scaladoc inherit with notice
Is it possible to inherit scaladoc from parent type and add custom notice?
For example:
trait Parent {
/** Add arbitrary number of key-value pairs to entity. */
def addFields(fields: (String, String)*): this.type
}
class Child extends Parent…
Andrii Abramov
- 10,019
- 9
- 74
- 96
2
votes
0 answers
Is there a way to point scaladoc index.html to my specific package?
I'm trying to build a nice scaladoc, and I found one problem though - index.html points to root package, which does not make any sense as all of my classes obviously not there, and to actually start reading about whatever I did person will need to…
Ivan Volzhev
- 63
- 1
- 5
2
votes
1 answer
Scaladoc wrap at right margin in IntelliJ
Is there any way you can make IntelliJ wrap scaladoc at the margin?
Basically, I want this:
/**
* This is a method description that is long enough to exceed right margin.
*
* Another paragraph of the description placed after blank line.
*…
Wilfred Springer
- 10,869
- 4
- 55
- 69
2
votes
0 answers
How to get rid of the "Could not find any member to link for" errors or disable it altogether from Heroku build CLI?
I'm on Scala 2.12.8 and I use the doc type links [[]] everywhere like so e.g.
import scala.concurrent.ExecutionContext
/**
* Some class documentation.
*
* @param ec the [[ExecutionContext]] instance to default to.
*/
work fine in the…
SkyWalker
- 13,729
- 18
- 91
- 187
2
votes
0 answers
How can I generate scaladocs for a bazel project in a manner that allows for external dependencies to be used as parameters/return types?
I am working with a Scala project that is being built using Bazel. I would like to generate Scaladocs for this project as part of our deployment process. I am able to generate the docs using the scaladoc command, but I receive a large amount of…
Kurtis Bass
- 21
- 1
- 3
2
votes
0 answers
ScalaDoc with Futures
So is there any correct way to annotate futures in scaladoc (specifically failures)? @throws doesn't seem appropriate since the exceptions get wrapped in a Try (Failure). Was looking for something like a @failure tag.
/**
* @failure FooException If…
Vangogh500
- 939
- 1
- 7
- 17
2
votes
0 answers
How to override a @define in the scaladocs of a subclass
I found docs for the @define scaladoc macro but they don't go into any depth.
What I'm trying to do is write documentation in a base class/trait in a generic way, with @defined variables so that the wording in the generated docs for the subclasses…
Dylan
- 13,645
- 3
- 40
- 67
2
votes
0 answers
IntelliJ space added after comment starting with /** in scala
In IntelliJ IDEA 2016.3.3 the comment code is formatted like this:
/** ***********************/
/* BACKEND CONFIGURATION */
/** ***********************/
Notice the space after /**
Is it possible to remove that space?
= UPDATE =
To be more precise,…
Reinis
- 65
- 9
2
votes
0 answers
Easy way to view/download javadoc/scaladocs referenced in a scala/sbt project
I'm a little suprised by this - I'm writing a scala play application with scalajs and while I can easily download javadocs of the dependencies by adding withJavadoc() to library dependencies in build.sbt:
Intellij provides hover tooltips displaying…
Andrew Rembrandt
- 53
- 1
- 6
2
votes
0 answers
Bibliographic citations in ScalaDoc
Several documentations tools support generating bibliographies and citation markers. For example, the Sandcastle Help File Builder allows defining s and referring to them by MAML tags. R Markdown supports many bibliography formats,…
Kristóf Marussy
- 1,202
- 8
- 18
2
votes
1 answer
Replace full types by type aliases in Scaladoc
I have a trait with 4 type parameters: Decoder[E, D, F, T] (where E describes the encoded type, D the decoded type, F the failure type and T is a phantom type used to tag decoder instances).
Each project that defines custom Decoder instances also…
Nicolas Rinaudo
- 6,068
- 28
- 41
2
votes
0 answers
Scala Constructor Inheritance of InheritDoc?
I'm writing some documentation for my exception classes and am running into the following warning from scaladoc:
The comment for class BarException contains @inheritdoc, but no parent comment is available to inherit from.
After reading this Java…
EdgeCaseBerg
- 2,761
- 1
- 23
- 39
2
votes
1 answer
Scaladoc link to another method
I have two methods on my companion object (model.Product):
def apply(p:ProductSyntax)(rs: WrappedResultSet): Product
def apply(p: ResultName[Product])(rs: WrappedResultSet): Product
The first method delegates to the second and I would like to…
user404345