tags:

views:

56

answers:

1
+1  Q: 

Improve sbt doc generation

When I run sbt doc, it results in a nice but nonetheless pretty basic documentation. Is it possible to

a) include the source files for the class definition and

b) inherit the docstrings for inherited members?

What do I need to add to my project definition?

(It’s a Lift project, so most important would be to have the inherited Lift docstrings present.)

+2  A: 

a) Scala X-Ray (sxr) will give you source code as documentation. It's a compiler plugin and it is most excellent. That link includes a link to the sxr+sbt setup.

b) I am sorry. I can't help with this one.

Synesso  2010-09-20 20:26:16
Nice. Now if only scaladoc would be able to link to the sxr source.
Debilski  2010-09-20 21:43:39
The scaladoc ant target has the `docsourceurl` attribute. See http://lampsvn.epfl.ch/trac/scala/browser/scala/tags/R_2_8_0_final/build.xml#L1379 It should be possible to achieve this. I also found this here http://code.google.com/p/simple-build-tool/wiki/BuildConfiguration#Document_Options
michael.kebe  2010-09-21 09:04:07

related questions

lazy loading some config params, trying to come up with a pattern in Scala...
Building a scala app with maven (that has java source mixed in)
Is there syntactic sugar for binding a value inside an anonymous function in Scala?
Is it possible to add a method to a built-in type in Scala?
Would you recommend the book "Programming in Scala" for an experienced developer?
Examples for creating stub data structures with dynamic JVM Languages ?
Scala syntax - pass string to object
Scala combinator parsers - distinguish between number strings and variable strings
How to use scalax.io.CommandLineParser?
Scala: how to create XML nodes from some collection
Any Real-World Experience Using Software Transactional Memory?
Getting the string representation of a type at runtime in Scala
Real-world examples of Scala applications?
"Arrays" in Scala
Explicit Type Conversion in Scala
Language features to implement relational algebra
F# and Scala comparison
Recursive overloading semantics in the Scala REPL - JVM languages
How to count rows in Lift (Scala's web framework)
Does the JVM prevent tail call optimizations?
What is a good functional language on which to build a web service?
Good way to learn Scala?
Returning an element from a List in Scala
Multimap in Scala
Is Scala the next big thing?