Skip to content

todesking/sbt-custom-doclet

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

13 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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

// project/build.sbt
addSbtPlugin("com.todesking" %% "sbt_custom_doc" % "0.0.1")

Use inline doc-generator class

// 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

// build.sbt
customDocGeneratorName := "name.of.doc.generator"

libraryDependencies in (Compile, doc) += "name.of.doc" %% "generator" % "1.0.0"

I not tested this yet :(

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages