api / org.gradle.plugins.ide.idea / GenerateIdeaModule

GenerateIdeaModule

open class GenerateIdeaModule : XmlGeneratorTask<Module>

Generates an IDEA module file. If you want to fine tune the idea configuration

Please refer to interesting examples on idea configuration in IdeaModule.

At this moment nearly all configuration is done via IdeaModule.

Constructors

<init>

GenerateIdeaModule()
GenerateIdeaModule(module: IdeaModule)

Functions

getModule

open fun getModule(): IdeaModule

The Idea module model containing the details required to generate the module file.

getOutputFile

open fun getOutputFile(): File

Configures output *.iml file. It's optional because the task should configure it correctly for you (including making sure it is unique in the multi-module build). If you really need to change the output file name it is much easier to do it via the idea.module.name property.

Please refer to documentation in IdeaModule name property. In IntelliJ IDEA the module name is the same as the name of the *.iml file.

getXmlTransformer

open fun getXmlTransformer(): XmlTransformer

setModule

open fun setModule(module: IdeaModule): Unit

setOutputFile

open fun setOutputFile(newOutputFile: File): Unit