scalagradlescaladoc

Setting scaladoc header/footer in Gradle

I'm not sure how to set ScalaDoc options in Gradle, but it appears possible because I see that Gradle has ScalaDoc and ScalaDocOptions. ScalaDocOptions has a setFooter, which I am interested in calling.

How do I use these methods?

Solution

  • The following piece of code should work:

    apply plugin: 'scala'

repositories {
    mavenCentral()
}

dependencies {
    compile 'org.scala-lang:scala-library:2.11.1'
}

project.tasks.scaladoc.scalaDocOptions.footer = 'lol'

    but it doesn't since gradle under the hood calls ant which does not support this attribute.

    Here you have a demo. Run it with gradle scaladoc -s to see where the problem lies.

    However this answer in general shows how you can configure task's options and attributes.