CODEWITHSUNDEEP
gradlegroovy
Rajesh Kazhankodath
Rajesh Kazhankodath

Reputation: 409

Example of includes in GroovyDoc Gradle task

I have a Gradle project with Groovy and Java source files. For one of the packages "com.myorg....dsl" I'd like to generate the documentation using the GroovyDoc. The following is by groovy doc configuration in the gradle file

groovydoc {
    groovyClasspath = project.configurations.jansi
    includes  = { "**/dsl/**" }
}

The intend of includes property is to only generate the documentation for packages with name dsl. But I'm not using the syntax right as the gradle script is failing.

Any example on the correct usage of includes is greatly appreciated.

Upvotes: 1

Views: 1288

Answers (1)

Opal
Opal

Reputation: 84844

There's invalid syntax in the code sample you provided. Should be either:

groovydoc {
    groovyClasspath = project.configurations.jansi
    includes  = ["**/dsl/**"]
}

or:

groovydoc {
    groovyClasspath = project.configurations.jansi
    include "**/dsl/**" 
}

Upvotes: 2

Related Questions