IDE Configuration

IDE Documentation in the root build.gradle file

Some Integrated Development Environments (IDE)s can display Conclave documentation while you edit code. For this to work, you must add some configuration to the root build.gradle depending on your IDE.

Start by adding the Gradle plugin required to support your IDE. Note that Visual Studio Code shares the configuration provided by the eclipse plugin.

plugins {
    id 'java'
    id 'idea'
    id 'eclipse'
}

Then add sections to tell the IDEs to download Javadoc for dependencies.

eclipse {
    classpath {
        downloadJavadoc = true
    }
}

idea {
    module {
        downloadJavadoc = true
    }
}

Finally, apply the same configuration to all subprojects.

subprojects {
    apply plugin: 'idea'
    apply plugin: 'eclipse'
    idea {
        module {
            downloadJavadoc = true
        }
    }
    eclipse {
        classpath {
            downloadJavadoc = true
        }
    }

    repositories {