Stack Overflow
Stack Overflow

Questions tagged [scaladoc]

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

146 questions
1
vote
1 answer

scaladoc is not compiling like the compiler

When I compile my program it compiles well, however, when I run scaladoc it doesn't work. Here is the minimal code where sbt compile compiles well and sbt doc does not work: /** * Doc here. */ object SigmaDDFactoryImpl { lazy val ipfFactory = new…
mundacho
  • 229
  • 1
  • 8
1
vote
1 answer

How to make scaladoc show default parameter values?

I have many methods like def foo(..., ..., runFinalizer: Boolean = true) (implicit finalizer: Finalizer): Result = ... But when I run scaladoc (using sbt), it doesn't document that runFinalizer has the default value. This is quite…
Petr
  • 62,528
  • 13
  • 153
  • 317
1
vote
3 answers

How to configure scaladoc in eclipse juno?

I'm new to scala. I've installed the nightly build since I use eclipse juno. The problem I'm facing is I do not see scaladoc when the cursor is on a class/trait and I press F2(like in java).
Harshal Kshatriya
  • 5,630
  • 11
  • 44
  • 60
1
vote
1 answer

Is it possible to tell scaladoc to make all links to sources to open in a new tab?

Currently, scaladoc tries to open all links in the same frame - and it results in errors if the source location is unable to work in a frame (for example, github pages). For example: Scallop Trying to open the source by left-clicking on a link…
Rogach
  • 26,050
  • 21
  • 93
  • 172
1
vote
1 answer

Newer scaladoc with older scala compiler?

Is it possible to use scaladoc from trunk without any problems on Scala code written for 2.8.1? I ask because scaladoc in trunk supports some additional tags that are unimplemented in scaladoc in 2.8.1. I don't anticipate any problems, but I just…
Robin Green
  • 32,079
  • 16
  • 104
  • 187
0
votes
1 answer

Document a recurring argument with a built-in type

Several packages have multiple classes with methods that have an argument called p. I want to document p. I can't document the type of p because the type is built-in (e.g. Map[String, String]). How to document p? class A { def (p: Map[String,…
Gradle Trampled
  • 3
  • 3
0
votes
1 answer

Extract source comments from a Scala source file

I would like to programmatically extract the code comments from a Scala source file. I have access to both the source file and objects of the classes whose comments I am interested in. I am also open to writing the comments in the Scala source file…
skm
  • 11
0
votes
1 answer

Scaladoc reference documentation - does it exist?

I'm looking for anything that can be used as a full reference on scaladoc tags (at least). Web search gives just a style guide, an overview here and differences between dotty(scala3) scaladoc and the old one. No complete list of tags. A lot of tags…
Anatol
  • 45
  • 6
0
votes
1 answer

Intellij scaladoc exception

I'm using intellij community 2018.3 with scala 2.12. I try to generate scaladoc of my project (a library) but intellij print me this error: Exception in thread "main" java.lang.NoSuchMethodError:…
Marco Mantovani
  • 111
  • 2
  • 7
0
votes
0 answers

What does "use case" mean in ScalaDoc?

Possible Duplicate: Scaladoc [use case] Some methods on ScalaDoc API have their descriptions preceded with [use case]. However, I can't find them on the source code, and they don't make sense sometimes. For example, def +: ( elem : A ) : List is…
Daniel C. Sobral
  • 295,120
  • 86
  • 501
  • 681
0
votes
1 answer

How do I configure Maven to use 'rootdoc.txt' in scaladoc report?

I know how to do this via SBT: Where does scaladoc look for the rootdoc.txt to create the root doc but cannot figure it out using Maven. Because of defects in SBT, I cannot use SBT for general builds. Following…
Eric Kolotyluk
  • 1,958
  • 2
  • 21
  • 30
0
votes
1 answer

scaladoc: Exclude methods

I am using maven to generate scaladocs (see below) Problem: I have some utility traits. Their methods are public as I want to mix them in to any classes (typical functions are String manipulations etc). Scaladoc, however, includes the methods in…
Jake
  • 4,322
  • 6
  • 39
  • 83
0
votes
1 answer

Scaladoc: Do I really need to give the full path everytime I use a link?

This screenshot summarizes my problem pretty well I think: I want to link to an object/class/method/... in Scaladoc. Even when I have the package correctly importet (see: import zoo.animals.Dog in my example) IntelliJ does not correctly recognize…
Florian Baierl
  • 2,378
  • 3
  • 25
  • 50
0
votes
1 answer

Scaladocs: Reference values of enums

In Scala, if I have an Enumeration like this: package myPackage.letters object Alphabet extends Enumeration { val A: Value = Value("A") val B: Value = Value("B") val C: Value = Value("C") } Now, I want to write a ScalaDoc for a method in…
Florian Baierl
  • 2,378
  • 3
  • 25
  • 50
0
votes
1 answer

How to include comments for a package with scaladoc?

So, for scaladoc, you can specify comments for a particular component of your code like so: package connector import java.io.RandomAccessFile; /** Fs class guides file opening * */ object fs { def printFile(path:String):Unit = { …
Josh Weinstein
  • 2,788
  • 2
  • 21
  • 38
1 2 3
…
9
10