Skip to content

IDE Configuration

IDE Documentation in the root build.gradle file

Info

At the moment, IntelliJ IDEA has an issue that means it does not correctly display the documentation for Conclave, even if you provide this configuration. Instead, please refer to the online Javadocs for Conclave.

Some IDEs are able to automatically display Conclave SDK documentation whilst editing code. In order for this to work you may need to 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.

1
2
3
4
5
plugins {
    id 'java'
    id 'idea'
    id 'eclipse'
}

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

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
eclipse {
    classpath {
        downloadJavadoc = true
    }
}

idea {
    module {
        downloadJavadoc = true
    }
}

Finally apply the same configuration to all subprojects.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
subprojects {
    apply plugin: 'idea'
    apply plugin: 'eclipse'
    idea {
        module {
            downloadJavadoc = true
        }
    }
    eclipse {
        classpath {
            downloadJavadoc = true
        }
    }

    repositories {