Name: browse
Owner: Eclipse Scala IDE
Description: A Scala source code browser
Created: 2012-01-25 14:36:58.0
Updated: 2013-10-05 03:53:38.0
Pushed: 2012-07-05 09:29:39.0
Size: 9677
Language: Scala
GitHub Committers
User | Most Recent Commit | # Commits |
---|
Other Committers
User | Most Recent Commit | # Commits |
---|
Browsable Scala source code in HTML with:
See http://harrah.github.com/browse/samples/index.html for samples.
Still in development. Bugs are features and features are accidental.
To build with sbt (see https://github.com/harrah/xsbt/wiki/Setup for setup instructions):
t "+ package"
This produces a compiler plugin in target/.
Usage
Add the following options to your compile command for your project:
plugin:<path-to-sxr>/sxr-0.2.7.jar
:sxr:base-directory:<src-dir>
If you are using sbt (0.10), add sxr as a plugin and configure the sxr plugin:
ompilerPlugin("org.scala-tools.sxr" %% "sxr" % "0.2.7")
acOptions <+= scalaSource in Compile map { "-P:sxr:base-directory:" + _.getAbsolutePath }
You will get a directory
Other options include specifying the output format and linking to other sxr sources.
To link to other sxr sources (produced with sxr 0.2.5 or later), follow these two steps.
acOptions <+= baseDirectory map { base =>
l linkFile = base / "sxr.links"
P:sxr:link-file:" + linkFile.getAbsolutePath)