SBT Plugin for Viewing ScalaDoc and JavaDoc
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
license
project
src/main/scala/com/persist
.gitignore
README.md
build.sbt

README.md

Scaladoc/JavaDoc Viewer SBT Plugin

Maven Central

Opens a browser window with Javadoc/Scaladoc for the current project or its dependencies.

  1. In project/plugins.sbt add

    addSbtPlugin("com.persist" % "sbt-view" % "1.0.2")

  2. In build.sbt add

    viewSettings

  3. Make sure that your SBT dependencies include the javadoc jar. Here is an example

    "com.foo" %% "foopackage" % "1.2.3" withJavadoc()

  4. View Scaladoc for current project. Calls doc if none there.

    view

  5. Finds an item in the classpath where all words are matched. Unpack the javadoc jar (if not already done) in the ivy2 cache and then view it.

    view WORD1 WORD2 ...

The plugin is based on a plugin developed by Whitepages https://github.com/whitepages/WP_Sbt_Plugins

Development of this plugin was supported by 47 Degrees.