https://github.com/todesking/sbt-custom-doclet
https://github.com/todesking/sbt-custom-doclet
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/todesking/sbt-custom-doclet
- Owner: todesking
- Created: 2014-06-24T12:54:49.000Z (almost 12 years ago)
- Default Branch: master
- Last Pushed: 2014-07-21T14:55:41.000Z (almost 12 years ago)
- Last Synced: 2026-01-17T16:50:15.840Z (5 months ago)
- Language: Scala
- Size: 160 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# sbt-custom-doc: The SBT plugin
This plugin enables scaladoc's `-doc-generator` feature.
## USAGE
1. Setting sbt(described below)
2. use `customDoc` task.
## Enable plugin
```scala
// project/build.sbt
addSbtPlugin("com.todesking" %% "sbt_custom_doc" % "0.0.1")
```
## Use inline doc-generator class
```scala
// project/Build.scala
package com.todesking.example
object Build extends sbt.Build{
import sbt._
import com.todesking.sbt_custom_doc.Plugin.autoImport._
lazy val root = Project(
"example",
file("."),
settings = Seq(
customDocGeneratorClass := Some(classOf[DocGen])
)
)
}
class DocGen extends scala.tools.nsc.doc.doclet.Generator {
override def generateImpl():Unit = {
println("This is a sample doclet")
}
}
```
## Use outer doc-generator class
```scala
// build.sbt
customDocGeneratorName := "name.of.doc.generator"
libraryDependencies in (Compile, doc) += "name.of.doc" %% "generator" % "1.0.0"
```
I not tested this yet :(