帮酷LOGO
  • 显示原文与译文双语对照的内容
文章标签:  FILL  COM  COMM  Scala  sbt-plugin  API  SCA  
A Sbt plugin that fills apiMappings for common Scala libraries.

  • 源代码名称:sbt-api-mappings
  • 源代码网址:http://www.github.com/ThoughtWorksInc/sbt-api-mappings
  • sbt-api-mappings源代码文档
  • sbt-api-mappings源代码下载
  • Git URL:
    git://www.github.com/ThoughtWorksInc/sbt-api-mappings.git
  • Git Clone代码到本地:
    git clone http://www.github.com/ThoughtWorksInc/sbt-api-mappings
  • Subversion代码到本地:
    $ svn co --depth empty http://www.github.com/ThoughtWorksInc/sbt-api-mappings
    Checked out revision 1.
    $ cd repo
    $ svn up trunk
  • sbt-api-mappings

    Build Status

    sbt-api-mappings 是一个sbt插件,用于填充通用 Scala 库的apiMappings

    动机

    有时在为自己的类编写ScalaDoc时,你可能希望参考一些其他库中的文档。

    例如:

    /** * My own class, which works with [[scala.Option]] and [[scalaz.Monad]].*/classMyClass(optionMonad: scalaz.Monad[Option])

    但是,在Sbt中运行 doc 命令时,将收到警告,并且不会创建链接。

    /path/to/MyClass.scala:3: Could not find any member to link for"scala.Option".

    这个插件解决了这个问题。

    用法

    步骤1: 在你的project/plugins.sbt 中添加以下代码行:
    addSbtPlugin("com.thoughtworks.sbt-api-mappings"%"sbt-api-mappings"%"latest.release")

    注意,sbt-api-mappings 1.x 需要 sbt 0.13. x, sbt-api-mappings 2.x 需要 sbt 1. x.

    步骤 2: 重新装入Sbt配置:
    > reload
    步骤 3: 生成你的API文档:
    > doc

    现在,在浏览器中打开API文档,并在 MyClass 页面中找到指向 scala.Optionscalaz.Monad 文档的链接。



    文章标签:COM  plugin  API  COMM  SCA  Scala    SBT  

    Copyright © 2011 HelpLib All rights reserved.    知识分享协议 京ICP备05059198号-3  |  如果智培  |  酷兔英语