ThoughtWorksInc / Sbt Api Mappings
Licence: apache-2.0
An Sbt plugin that fills apiMappings for common Scala libraries.
Stars: ✭ 76
Programming Languages
scala
5932 projects
Labels
Projects that are alternatives of or similar to Sbt Api Mappings
Soteria
Plugin to block compilation when unapproved dependencies are used or code styling does not comply.
Stars: ✭ 36 (-52.63%)
Mutual labels: sbt-plugin
Sbt Thank You Stars
Give your dependencies stars on GitHub!
Stars: ✭ 15 (-80.26%)
Mutual labels: sbt-plugin
Sbt Updates
sbt plugin that can check Maven and Ivy repositories for dependency updates
Stars: ✭ 653 (+759.21%)
Mutual labels: sbt-plugin
sbt-publish-more
📤 Publish artifacts to more than one repository
Stars: ✭ 21 (-72.37%)
Mutual labels: sbt-plugin
Sbt Buildinfo
I know this because build.sbt knows this.
Stars: ✭ 486 (+539.47%)
Mutual labels: sbt-plugin
Sbt Ignore Play Generated
Configure linters and coverage tools to ignore Play's generated source files.
Stars: ✭ 10 (-86.84%)
Mutual labels: sbt-plugin
Mima
A tool for catching binary incompatibility in Scala
Stars: ✭ 345 (+353.95%)
Mutual labels: sbt-plugin
Sbt Pack
A sbt plugin for creating distributable Scala packages.
Stars: ✭ 438 (+476.32%)
Mutual labels: sbt-plugin
Sbt Sonatype
A sbt plugin for publishing Scala/Java projects to the Maven central.
Stars: ✭ 265 (+248.68%)
Mutual labels: sbt-plugin
sbt-assembly
Deploy über-JARs. Restart processes. (port of codahale/assembly-sbt)
Stars: ✭ 1,801 (+2269.74%)
Mutual labels: sbt-plugin
Genjavadoc
A compiler plugin for generating doc’able Java source from Scala source
Stars: ✭ 51 (-32.89%)
Mutual labels: sbt-plugin
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.
Note that the project description data, including the texts, logos, images, and/or trademarks,
for each open source project belongs to its rightful owner.
If you wish to add or remove any projects, please contact us at [email protected].