sbt-api-mappings alternatives and similar packages
Based on the "Sbt plugins" category.
Alternatively, view sbt-api-mappings alternatives based on common mentions on social networks and blogs.
-
sbt-ensime
DISCONTINUED. Generates .ensime config files for SBT projects http://ensime.org/build_tools/sbt -
sbt-dependency-check
SBT Plugin for OWASP DependencyCheck. Monitor your dependencies and report if there are any publicly known vulnerabilities (e.g. CVEs). :rainbow: -
sbt-unidoc
sbt plugin to create a unified Scaladoc or Javadoc API document across multiple subprojects. -
sbt-classfinder
SBT plugin for retrieving runtime information about the classes and traits in a project
CodeRabbit: AI Code Reviews for Developers
Do you think we are missing an alternative of sbt-api-mappings or a related project?
README
sbt-api-mappings
sbt-api-mappings is a sbt plugin that fills apiMappings
for common Scala libraries.
Motivation
Sometimes when you wrote ScalaDoc for your own classes, you may want to reference to documentation in some other libraries.
For example:
/**
* My own class, which works with [[scala.Option]] and [[scalaz.Monad]].
*/
class MyClass(optionMonad: scalaz.Monad[Option])
Unfortunately when running doc
command in Sbt, you will receive a warning and the link would not be created.
/path/to/MyClass.scala:3: Could not find any member to link for "scala.Option".
This plugin resolves the problem.
Usage
Step 1: Add the following lines in your project/plugins.sbt
:
addSbtPlugin("com.thoughtworks.sbt-api-mappings" % "sbt-api-mappings" % "latest.release")
Note that sbt-api-mappings 1.x requires sbt 0.13.x, sbt-api-mappings 2.x requires sbt 1.x.
Step 2: Reload the Sbt configuration:
> reload
Step 3: Generate your API documentation:
> doc
Now, open the API documentation in your browser, and you will find the links to the scala.Option
and scalaz.Monad
's documentation in your MyClass
page.