scaladoc Questions
1
I have a top level trait that contains a number of classes and traits like:
trait Trees { self: Types =>
trait Tree
trait IdentifiedTree extends Tree
trait Empty extends Tree
/** The facto...
Seda asked 28/5, 2015 at 15:50
1
Solved
I'm using sbt 0.13.7 and Scala 2.11.4.
In my build.sbt, I have:
autoAPIMappings := true
and in a File.scala:
/** scaladoc link to [[scala.concurrent.duration.FiniteDuration]] */
When running...
1
I have a comment that contains an example Java servlet configuration. It looks like:
/** Blah blah blah...
*
* {{{
* <servlet-mapping>
* <servlet-name>MyAppServlet</servlet-nam...
Forge asked 30/5, 2014 at 17:7
1
Solved
Suppose my entire project configuration is this simple build.sbt:
scalaVersion := "2.11.4"
libraryDependencies += "org.scalaz" %% "scalaz-core" % "7.1.0"
And this is my code:
import scalaz.Equ...
Mcquiston asked 3/11, 2014 at 14:46
2
Solved
In Eclipse I have set the Javadoc Location property of my Scala project to file:/D:/EclipseWorkspace/MyProject/target/scala-2.9.1/api where D:/EclipseWorkspace/MyProject is the location of my scala...
1
Solved
There are a lot of places in the Scala API, particularly in collections, where method signatures are wrong.
For example, the scaladoc signature for Map.flatMap says
def flatMap[B](f: (A) ⇒ GenTra...
2
Solved
I have a short Bash script that does a find-and-replace on my Scaladoc comments in order to generate links to external documentation of a third-party library. I would like this script to run every ...
1
Solved
Adding the following settings to the build.sbt file of a Play 2.2.x app
does not disable Scaladoc generation. How can it be disabled?
play.Project(appName, appVersion, appDependencies)
.settings(...
Hols asked 30/1, 2014 at 16:18
2
Solved
I am trying to follow the sbt documentation for scaladoc generation. I have a multi project (i.e. aggregate with sub-projects) build which was a ./build.sbt for general settings. I added the last e...
1
Solved
Looking at http://www.scala-sbt.org/release/docs/Howto/scaladoc.html there are examples for giving scaladoc options such -groups and -implicits.
Where is the information regarding the scaladoc (2....
5
Solved
Ruby has a program called ri where you can type in 'ri Array' and get its manpage. Is there something like that for scaladoc?
3
Solved
I was looking at the definition of toArray for hashmaps :
http://www.scala-lang.org/api/current/index.html#scala.collection.immutable.HashMap
It has
toArray: Array[A]
def toArray[B >: (A, B)...
1
Solved
I am generating the ScalaDoc HTML files for some SBT projects (in a Multi-Project configuration). If I execute doc in the SBT console, the documentation is generated nicely, but it is deployed in a...
1
Solved
Say, i am looking to better understand what reduceLeft method does when applied on a Array[String]
The scaladoc says:
Ok, i must ask again, what does this method do? And what's more important, i...
1
I'm trying to configure the Scaladoc in SBT, specifically the title, output directory and classpath.
I managed to define the title by adding the following to build.sbt:
scalacOptions in (Compile,...
Atonic asked 10/12, 2012 at 19:3
1
Solved
I want that Scaladoc generates a type hierarchy diagram for the following code snippet:
trait A
trait B extends A
But when I execute scaladoc <file>.scala there is no type hierarchy shown ...
1
Solved
Among all the various incomplete lists of features going into Scala 2.10, there are various mentions of improvements to Scaladoc. But it's unclear which ones there are, and which ones are act...
Suzan asked 6/7, 2012 at 4:38
1
Solved
I'm using sbt 0.11.2 for a mixed Java/Scala project. I've realized that when I run the doc command from within sbt, it does not only create the scaladocs for the Scala source files in src/main/scal...
2
When creating a Scala documentation I also use the @throws and @note tags like documented here (Scaladoc Wiki - Tags and Annotations).
Unfortunately I can't find these in the generated Scaladoc.
...
3
Is there any possibility that i can search for a method in a class, trait or object via scala doc, globally? Example: I have a method name and I don't know which class it belongs to so i can type i...
5
Solved
I am trying to find the documentation for the Scala operator method #::. I believe that it is defined in the Stream class because of an example I found that uses it.
My question is not particular ...
1
Solved
Why do some method descriptions in Scaladoc start with [use case]?
Example: scala.collection.immutable.StringOps.++
Is it just a placeholder to be replaced in the future?
Teakettle asked 5/11, 2010 at 14:30
1
How do I use/generate scaladoc from within IntelliJ Idea (running on ubuntu)? Most preferably I would like to configure Tools/generate javadoc to also generate scaladoc, though that might be hard a...
Perilous asked 18/3, 2010 at 12:46
© 2022 - 2024 — McMap. All rights reserved.