Skip to content

ThoughtWorksInc/sbt-api-mappings

Folders and files

NameName
Last commit message
Last commit date

Latest commit

3e380bb · Jul 15, 2023
Jul 15, 2023
Nov 2, 2021
Jul 15, 2023
Mar 20, 2022
Jan 10, 2023
Mar 19, 2022
Jul 1, 2023
Jul 10, 2015
Jul 10, 2015
Jan 10, 2019
Jul 15, 2023
Jan 31, 2016
Jan 11, 2023

Repository files navigation

sbt-api-mappings

Build Status

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.