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
0
votes
1 answer
Scaladoc 2.11.8 API incomplete?
Scala API 2.10.2 shows indexes for some packages such as scala.util.parsing.json and scala.xml
Scala API 2.11.8 doesn't show those packages. But the code does exist in Scala 2.11.
scala.util.parsing.json.JSONArray(List("Banana", "Yogurt",…
Polymerase
- 6,311
- 11
- 47
- 65
0
votes
1 answer
Scaladoc API of scala.reflect.io?
Is there any public Scaladoc API of scala.reflect.io? It seems there are useful IO utilities in there. Would it be more beneficial to use these instead of Java IO?
Saw in Scala 2.11.8 Source
there is an object scala.reflect.io.Directory which allows…
Polymerase
- 6,311
- 11
- 47
- 65
0
votes
2 answers
what are value members in scaladocs
I am trying to dig scala deeper but scaladocs is not straight as javadocs. While doing some mathematical operation I visited to scala.math here package.
I am not able to understand value member in the docs.please suggest some guide line to decipher…
optional
- 3,260
- 5
- 26
- 47
0
votes
1 answer
link to [[importedName]], and not the fully qualified name, in scaladoc
How to make a link to some imported name (which is in another package) in scaladoc, whithout having to use fully qualified name?
Example:
file 1
package com.pany.pck1.subpck
class Class1
file 2
package com.pany.pck2.othersubpck
import…
Juh_
- 14,628
- 8
- 59
- 92
0
votes
2 answers
How to reference a class in another project?
I have a multi-project SBT configuration. I have a class my.AClass in project1. What should I add to configuration to make scaladoc as follows
/**
* [[my.AClass]]
*/
class BClass
in project2 be successfully compiled by sbt project2/doc?
Alexander Myltsev
- 459
- 1
- 3
- 13
0
votes
1 answer
How to use Play 2 "doc" command?
Play seem to generate documentation thru "build" or "doc" commands.
How are we supposed to use this feature ?
Is it generating text files ?
Is it generating html files ?
How can i consult this doc ?
Is it even made for humans or is it an internal…
Manel
- 1,616
- 19
- 42
0
votes
1 answer
How to view scala doc in eclipse
I am using Eclipse for writing Scala code.
I installed the Scala plugin in Eclipse. In the Java environment in Eclipse there are explanations available for every built in method, but for Scala, Eclipse does not show Scala doc.
What can I do to view…
swaheed
- 3,671
- 10
- 42
- 103
0
votes
1 answer
Why does custom scaladoc task throw MissingRequirementError: object scala.annotation.Annotation in compiler mirror not found?
I hit a MissingRequirementError when I try to invoke scaladoc from within an sbt task.
Using any version of sbt 0.13.x, start with this build.sbt:
val scaladoc = taskKey[Unit]("run scaladoc")
scaladoc := {
import scala.tools.nsc._
val settings…
gladed
- 1,705
- 1
- 17
- 25
0
votes
1 answer
scala, slick : where can I find exceptions raised by a given method?
I wonder where I can find the exceptions raised by such a code:
def readFromDB: String = {
db_sqlite_xml.withSession {
implicit db: Session =>
xmlQuery.first.text
}
}
I can't find it in the slick scaladoc…
lolveley
- 1,659
- 2
- 18
- 34
0
votes
1 answer
Does scala has a class for lazy thunks that are evaluated once or never?
Something as simple
class Thunk[+A](body: => A) {
lazy val result: A = body;
}
Is it defined somewhere?
Or perhaps a slightly more sohpisticated
class Thunk[+A](body: => A) {
private[this] var evaluatedInternal = false;
lazy val result: A =…
Petr
- 62,528
- 13
- 153
- 317
-1
votes
1 answer
methods missing from scaladoc search
None of the Value Members of the Tuple2 class appear when I do a search for them.
Examples: _2, invert, swap
Are some classes intentionally left out when doing a scaladoc search? Is my browser playing tricks on me?
jwvh
- 50,871
- 7
- 38
- 64