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
4
votes
1 answer
How to set up Scala API docs for IntelliJ
Scala is installed using homebrew, and when I create a new Scala project, I use the path /usr/local/opt/scala/idea with the proper symlinks
IntelliJ detects the compiler and libraries correctly, auto-complete, compilation and running works fine.…
Hanxue
- 12,243
- 18
- 88
- 130
4
votes
1 answer
Generate scaladoc for root package
I'm curious how it's possible to document the root package, displayed as the first page in a scala-doc compilation. Can one create a package object referring to the root-package somehow, or is are there any configuration options? The descriptions on…
Jens Egholm
- 2,730
- 3
- 22
- 35
4
votes
1 answer
Is there a button to show documentation for the element under cursor in IntelliJ Idea?
Some times it would be handy to see a ScalaDoc/JavaDoc page for the type of the element under cursor. Surprisingly, I could find no IDE-built-in way to do this (despite the fact the most of the libraries I use are accompanied by documentation and…
Ivan
- 63,011
- 101
- 250
- 382
3
votes
1 answer
Autogenerated documentation for a mixed java/scala project
I'd love some advice on how best to autogenerate documentation for a mixed Java/Scala project. We're using Scala 2.8; it seems the scaladoc tool that ships with 2.8.1 does not generate usable documentation for our Java classes -- it gets the…
Eric Bowman - abstracto -
- 1,915
- 1
- 14
- 24
3
votes
0 answers
How to add member group tag to parametric field or case class field in scaladoc?
In Scaladoc, we can group class members using @group tag, taking example from Predef.scala
/**
* Retrieve the single value of a type with a unique inhabitant.
* @group utilities
*/
@inline def valueOf[T](implicit vt: ValueOf[T]): T =…
Naitree
- 1,088
- 1
- 14
- 23
3
votes
0 answers
Suppress scaladoc implementation warning while creating spring annotation in Java
I am trying to create a Spring annotation in Java as following.
@Target({ ElementType.METHOD })
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface MyAnnotation {
MyClass myObj();
}
On build, I am getting warning message for…
rakshak satsangi
- 31
- 2
3
votes
0 answers
How do I get scaladoc's @usecase annotation to just print the string I give it?
I'm attempting to use the @usecase scaladoc annotation to simplify a complicated type which has been uglified in the process of kind-projector constructing a type lambda for me. Here is the function in question:
def oneOf[P[_], I](alts:…
Kris Nuttycombe
- 4,560
- 1
- 26
- 29
3
votes
0 answers
How to extend ScalaDoc Annotations?
Is there a way to add a new ScalaDoc annotation? Specifically, I'd like to define @business annotation as an extension of @note.
This, obviously, should be able to behave as the @note:
/**
* @business A business description of the item.
*/
def…
Maximiliano Felice
- 357
- 1
- 3
- 18
3
votes
2 answers
How do I include ScalaDoc options in Maven
I can generate class hierarchy diagram by manually use "scaladoc -diagrams ..."
I can also generate basic ScalaDoc with Maven by "mvn scala:doc"
But How can I put "-diagrams" in when I run ScalaDoc from Maven? In general, how do I put in any of the…
muon
- 41
- 5
3
votes
0 answers
Configuring ScalaDoc task in Gradle to generate aggregated documentation
I have a multi module scala project in Gradle. Everything works great with it, except the ScalaDoc. I would like to generate a single 'uber-scaladoc' with all of the libraries cross-linked. I'm still very new to groovy/gradle, so this is probably…
fbl
- 2,840
- 3
- 33
- 41
3
votes
1 answer
Configure scaladoc to include extension methods
Can I configure scaladoc to include methods from implicit conversions by specifying the implicit conversion?
E.g. given
trait Foo
object Operations {
implicit class FooOps(val f: Foo) extends AnyVal {
def bar = 33
}
}
Can I make scaladoc…
0__
- 66,707
- 21
- 171
- 266
3
votes
3 answers
Where does scaladoc look for the rootdoc.txt to create the root doc
This is a duplicate of Generate scaladoc for root package, however the Answer does not state where sbt doc looks for the rootdoc.txt.
I added
scalacOptions in doc ++= Seq("-doc-root-content", "rootdoc.txt")
to my build.sbt, but sbt doc does not…
Manuel Schmidt
- 2,429
- 1
- 19
- 32
3
votes
1 answer
How to generate Scaladocs from Eclipse project
I want to start generating scaladocs from my Eclipse project. I don't use SBT, but am willing to import my eclipse project to sbt if it is needed.
How do I generate Scaladocs from an eclipse Scala project?
Felix
- 8,385
- 10
- 40
- 59
3
votes
1 answer
Setting up Javadoc for Scala projects in IntelliJ
After setting up my Scaladoc, i see that some documentation is still missing from the IDE
It seems to me (many thanks to Peter for noticing this) that:
functions with non-bold font have no documentation
functions with bold font have bare…
James Raitsev
- 92,517
- 154
- 335
- 470
3
votes
1 answer
Verbatim code in scaladoc
I have a Color companion object which holds a few useful colors, and I'd like to
document them in the following manner:
object Color {
/** (.3, .3, .3, 1) */
val darkGrey = Color(.3, .3, .3, 1);
}
As you have probably noticed, all I want is for…
Malabarba
- 4,473
- 2
- 30
- 49