Scaladoc and VScaladoc Support
------------------------------
Key: BUILDR-265
URL: https://issues.apache.org/jira/browse/BUILDR-265
Project: Buildr
Issue Type: New Feature
Reporter: Daniel Spiewak
Fix For: 1.3.4
Buildr supports javadoc, but not (to my knowledge) scaladoc or vscaladoc. We
could just add a `scaladoc` and `vscaladoc` task, but I would propose that we
actually factor the documentation generation into something more generic like a
`doc` task. The actual documentation provider could be auto-selected based on
the compiler or overridden via the following directive:
doc.using :vscaladoc # for example
There is also the annoying problem of documentation generation in a
joint-compiler setting. Scaladoc does not actually support generation of
documentation for .java sources (it's something the Scala team is aware of).
However, we could potentially do a three-pass documentation generator for
Scala/Java joint compilation. First pass would generate scaladoc from *.scala,
the second pass would generate javadoc from *.java linked to the scaladoc, and
the third pass would re-generate the scaladoc linked to the javadoc. A similar
approach could be used for vscaladoc, though I'm not sure how well the interop
will work.
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
