sbt-unidoc 项目使用教程

sbt-unidoc 项目使用教程

sbt-unidocsbt plugin to create a unified Scaladoc or Javadoc API document across multiple subprojects.项目地址:https://gitcode.com/gh_mirrors/sb/sbt-unidoc

1. 项目的目录结构及介绍

sbt-unidoc 是一个用于在多个子项目中创建统一 Scaladoc 或 Javadoc API 文档的 sbt 插件。以下是该项目的目录结构及其介绍：

sbt-unidoc/
├── project/
│   ├── build.properties
│   └── plugins.sbt
├── src/
│   ├── main/
│   │   └── scala/
│   │       └── sbt-unidoc/
│   │           ├── JavaUnidocPlugin.scala
│   │           ├── ScalaUnidocPlugin.scala
│   │           └── UnidocPlugin.scala
├── .gitignore
├── LICENSE
├── README.md
└── build.sbt

• project/: 包含项目的构建配置文件。
  • build.properties: 定义 sbt 版本。
  • plugins.sbt: 定义项目依赖的插件。
• src/: 包含项目的源代码。
  • main/scala/sbt-unidoc/: 包含插件的主要实现代码。
    • JavaUnidocPlugin.scala: 用于生成 Javadoc 的插件。
    • ScalaUnidocPlugin.scala: 用于生成 Scaladoc 的插件。
    • UnidocPlugin.scala: 统一文档生成插件。
• .gitignore: 定义 Git 忽略的文件和目录。
• LICENSE: 项目的许可证文件。
• README.md: 项目的说明文档。
• build.sbt: 项目的构建脚本。

2. 项目的启动文件介绍

sbt-unidoc 项目的启动文件主要是 build.sbt 和 project/plugins.sbt。

build.sbt

build.sbt 是 sbt 项目的主要构建脚本，定义了项目的名称、版本、依赖等信息。以下是一个示例：

name := "sbt-unidoc"

version := "0.5.0"

organization := "com.github.sbt"

sbtPlugin := true

addSbtPlugin("com.eed3si9n" % "sbt-unidoc" % "0.5.0")

project/plugins.sbt

project/plugins.sbt 定义了项目依赖的插件。以下是一个示例：

addSbtPlugin("com.github.sbt" % "sbt-unidoc" % "0.5.0")

3. 项目的配置文件介绍

sbt-unidoc 项目的配置文件主要包括 build.sbt 和 project/plugins.sbt。

build.sbt

在 build.sbt 中，可以配置项目的名称、版本、依赖等信息，以及启用 ScalaUnidocPlugin 和 JavaUnidocPlugin。以下是一个示例：

val root = (project in file("."))
  .enablePlugins(ScalaUnidocPlugin, JavaUnidocPlugin)
  .aggregate(library, app)
  .settings(
    name := "foo",
    ScalaUnidoc / unidoc / unidocConfigurationFilter := inConfigurations(Compile, Test)
  )

project/plugins.sbt

在 project/plugins.sbt 中，添加 sbt-unidoc 插件：

addSbtPlugin("com.github.sbt" % "sbt-unidoc" % "0.5.0")

通过这些配置，可以生成统一的 Scaladoc 和 Javadoc 文档。

sbt-unidocsbt plugin to create a unified Scaladoc or Javadoc API document across multiple subprojects.项目地址:https://gitcode.com/gh_mirrors/sb/sbt-unidoc