Successfully reported this slideshow.
We use your LinkedIn profile and activity data to personalize ads and to show you more relevant ads. You can change your ad preferences anytime.
SXR
    Scala X­Ray




                                   Template by 
                      presentationmagazine.com
Scala X­Ray
• A plugin for scalac
• Generates browsable source in HTML
    – Syntax highlighting
    – Call­outs for type ...
Examples
• A full library
• Extract in a Blog




                       
Getting it
• git clone git://github.com/harrah/browse.git
• sbt “+update” “+package”
    – The plus performs actions for a...
Using it
• Configure the compiler to use it
• With scalac
    ­Xplugin:<path­to­sxr­jar>
           ­P:sxr:base­directory:...
Using it with SBT
• In your project class
    – Mix in AutoCompilerPlugins trait
    – Add compiler plugin to the compile ...
The output
• Inside <src>.sxr path, we'll find stuff
    – HTML – an index & one per each source file
    – Javascript (jq...
Extracts
• Extract in an iframe
    – Click export and copy/paste the snippet
    – Honours current window size
    – Sour...
Project
•   http://github.com/harrah/browse
•   By Mark Harrah, author of SBT
•   Written as a POC, but good enough to use...
Upcoming SlideShare
Loading in …5
×

SXR - Scala XRay

1,866 views

Published on

A very brief overview of the SXR compiler plugin

Published in: Technology
  • Be the first to comment

  • Be the first to like this

SXR - Scala XRay

  1. 1. SXR Scala X­Ray     Template by  presentationmagazine.com
  2. 2. Scala X­Ray • A plugin for scalac • Generates browsable source in HTML – Syntax highlighting – Call­outs for type info – Linking & highlighting for declarations    
  3. 3. Examples • A full library • Extract in a Blog    
  4. 4. Getting it • git clone git://github.com/harrah/browse.git • sbt “+update” “+package” – The plus performs actions for all targeted  scala versions “cross­building”     
  5. 5. Using it • Configure the compiler to use it • With scalac ­Xplugin:<path­to­sxr­jar>        ­P:sxr:base­directory:<src­dir>     
  6. 6. Using it with SBT • In your project class – Mix in AutoCompilerPlugins trait – Add compiler plugin to the compile options     
  7. 7. The output • Inside <src>.sxr path, we'll find stuff – HTML – an index & one per each source file – Javascript (jquery) and css    
  8. 8. Extracts • Extract in an iframe – Click export and copy/paste the snippet – Honours current window size – Source HTML must be at permanent address    
  9. 9. Project • http://github.com/harrah/browse • By Mark Harrah, author of SBT • Written as a POC, but good enough to use • Seeking contributors    

×