Skip to content

nestorpersist/sbt-view

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

22 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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.

About

SBT Plugin for Viewing ScalaDoc and JavaDoc

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages