scaladoc Questions
3
Solved
When attempting to publish the jars for my project via sbt "++2.11.6 publishLocal" or sbt +publishLocal, I encounter Scaladoc issues when publishing for Scala 2.11.6. It appears that I have invalid...
1
Solved
I cannot add a package description in ScalaDoc with Scala 3
/** package description */
package foo {
/** some scaladoc comment */
def method():A = ???
}
Then I generate the doc with sbt (1.5.3)
...
2
What is the correct way to create link to a method in the same class?
Scaladoc documentation doesn't have examples of this.
Consider a class such as:
package controllers
// import ...
class Acc...
Thicken asked 28/12, 2015 at 10:1
1
Solved
To link another class, I can use [[package.Classname]].
Linking functions defined by def works as well, but trying to link variables doesn't work.
What I've tried:
object Foo {
val BAR = 0
}
obj...
1
Is there a way that I can reference the name of a val in a Object class using scaladoc, similar to
{@value #STATIC_FIELD}
in javadoc.
4
Solved
I would like to enter math formulae in Scaladoc documentation of mathematical Scala code. In Java, I found a library called LatexTaglet that can do exactly this for Javadoc, by writing formulae in ...
4
Solved
I'm documenting a Scala class with overloaded methods. How can I distinguish them when referring to them in scaladoc comments? For example, if I have
/**
* The most important method is [[Doc.foo]...
Postmortem asked 13/3, 2013 at 19:9
2
Solved
How do I access Scala docs in IntelliJ? The other answers in SO are for earlier versions. I added the scala doc jar file, but still I am unable to link scala docs with IntelliJ.
I do get the Quick...
Barkeeper asked 3/1, 2017 at 5:19
1
What is the exact syntax of using @See scaladoc? How do I reference:
a method in the same class
another class
an "http" reference
?
3
Solved
I'm trying to organise the members of a class in my library API documentation using @groupname and @group tags, but it doesn't work (I'm using sbt 0.13.11)
My toy build.sbt:
name := "test"
scalaV...
2
Solved
I am currently writing the documentation of an API written in Scala. I would like to include several diagrams to make the code more understandable.
I am wondering where to put resources (such as d...
1
I have a few libraries that depend on Cats. Let's say the new Cats 0.4.0 release has the wrong apiURL value in its POM. I don't want my API docs to break, so I provide the URL mapping with apiMappi...
1
Solved
For an in-application help browser, I would like to render API docs. Unfortunately, Scaladoc seems to produce only HTML files full of horrible JavaScript stuff, so it's impossible to render these f...
1
Is it possible to generate diagrams with Scaladoc and SBT?
I tried to add this line in my build.sbt:
scalacOptions in (Compile,doc) := Seq("-diagrams", "-diagrams-debug")
But I receive:
Diagra...
2
Solved
I just installed the Scala IDE Eclipse plugin with a fresh install of Eclipse Indigo. I followed the getting started youtube video on the scala-ide.org main page on a fresh installation of Indigo. ...
3
Solved
Since Scala 2.10.2, I can't find the download link for its API documentation. Is this an intentional omission? Where can I download it?
Alternatively, what is the exact scalac command to generate ...
3
Solved
I'd like the ScalaDoc I generate with sbt to link to external libraries, and in sbt 0.13 we have autoAPIMappings which is supposed to add these links for libraries that declare their apiURL. In pra...
0
I may be missing something obvious, but I can't get Scaladoc to link to classes—only to companion objects. Consider these examples.
This works fine:
/** Returns a [[scala.List]] (also known...
1
Solved
Using Scaladoc, is there a way to include hyperlink to some external HTTP URL ?
using Javadoc this was easy.. but I am having trouble figuring out the syntax for Scaladoc. I looked here: https://w...
5
Solved
I binged or googled for scaladoc 2.0 tutorial or example, I could not find anything, in fact not even a link to official scaladoc 2.0 documentation.
Anyone know where to find one?
1
Solved
What is the standard convention (or tag) to add code examples in ScalaDoc? Example in the code below, I want to provide coding example to demonstrate it's usage:
/**
* Adds a filter on DB Table Q...
2
Solved
I am running into a problem with ScalaDoc not accepting a method link when using overloading.
A standalone example: File project/build.properties:
sbt.version=0.13.2
File build.sbt:
scalaVersi...
Lucianaluciano asked 20/4, 2014 at 11:53
2
I'd like to setup ScalaDoc to link to the standard library, from SBT. I'm using 0.12.4 but I'm going to switch to 0.13 soon. Moreover, I'd like to make the setup simple by using 0.13's support.
Th...
2
I'm trying to link classes from the JDK into the scaladoc-generated doc.
I've used the -doc-external-doc option of scaladoc 2.10.1 but without success.
I'm using -doc-external-doc:/usr/lib/jvm/jav...
3
Solved
I'm attempting to run sbt test:doc and I'm seeing a number of warnings similar to below:
[warn] /Users/tleese/code/my/stuff/src/test/scala/com/my/stuff/common/tests/util/NumberExtractorsSpecs.sc...
1 Next >
© 2022 - 2024 — McMap. All rights reserved.