Skip to content

Commit e86e016

Browse files
author
travis-ci
committed
Reorganized docs to be a tad more hierarchical. Show the basics first, and give links to the more detailed stuff later.
1 parent 0b59b6c commit e86e016

File tree

4 files changed

+49
-25
lines changed

4 files changed

+49
-25
lines changed

README.md

Lines changed: 2 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -36,15 +36,7 @@ When you run `gradlew ide`, it builds and downloads an IDE into `build/oomphIde`
3636
apply plugin: 'com.diffplug.gradle.oomph.ide'
3737
oomphIde {
3838
repoEclipseLatest()
39-
jdt {
40-
//Some *optional* older (or newer) JRE/JDK
41-
installedJre({ jre ->
42-
jre.version = '1.6.0_45'
43-
jre.installedLocation = new File('C:/jdk1.6.0_45')
44-
jre.markDefault = true // or false
45-
jre.executionEnvironments = ['JavaSE-1.6'] //any or as many execution environments can be specified here.
46-
})
47-
}
39+
jdt {}
4840
eclipseIni {
4941
vmargs('-Xmx2g') // IDE can have up to 2 gigs of RAM
5042
}
@@ -55,14 +47,7 @@ oomphIde {
5547
}
5648
```
5749

58-
See the [plugin's javadoc](https://diffplug.github.io/goomph/javadoc/3.4.0/com/diffplug/gradle/oomph/OomphIdePlugin.html) for more details.
59-
60-
Examples (submit a PR with yours here!)
61-
62-
- [Gradle and Eclipse RCP talk](https://github.com/diffplug/gradle_and_eclipse_rcp/blob/master/ide/build.gradle) (multi-project Eclipse RCP project)
63-
- [ls-api](https://github.com/TypeFox/ls-api/blob/61a3089569acbe159f043534f282401452a34bc3/ide/build.gradle) (xtend IDE example)
64-
- [Spotless](https://github.com/diffplug/spotless/blob/master/build.gradle) (single-project Gradle plugin)
65-
- (your example here)
50+
See the [plugin's javadoc](https://diffplug.github.io/goomph/javadoc/3.4.0/com/diffplug/gradle/oomph/OomphIdePlugin.html) for a quickstart, and [HOW_TO_AUTOMATE_IDE.md](HOW_TO_AUTOMATE_IDE.md) for examples and more in-depth details.
6651

6752
## Blog posts
6853

src/main/java/com/diffplug/gradle/oomph/ConventionJdt.java

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,29 @@
2020

2121
import org.gradle.api.Action;
2222

23+
/**
24+
* Adding the JDT convention to your project
25+
* adds the following features:
26+
*
27+
* - `org.eclipse.platform.ide`
28+
* - `org.eclipse.jdt`
29+
* - `org.eclipse.ui.views.log`
30+
*
31+
* You can set the installed JRE as follows:
32+
*
33+
* ```gradle
34+
* oomphIde {
35+
* jdt {
36+
* installedJre {
37+
* version = '1.6.0_45'
38+
* installedLocation = new File('C:/jdk1.6.0_45')
39+
* markDefault = true // or false
40+
* executionEnvironments = ['JavaSE-1.6'] // any execution environments can be specified here.
41+
* }
42+
* }
43+
* }
44+
* ```
45+
*/
2346
public class ConventionJdt extends OomphConvention {
2447
ConventionJdt(OomphIdeExtension extension) {
2548
super(extension);

src/main/java/com/diffplug/gradle/oomph/ConventionPde.java

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,27 @@
2323

2424
import com.diffplug.gradle.OrderingConstraints;
2525

26+
/**
27+
* Adding the PDE convention to your project
28+
* adds the following features:
29+
*
30+
* - `org.eclipse.platform.ide`
31+
* - `org.eclipse.jdt`
32+
* - `org.eclipse.pde`
33+
*
34+
* You can set the targetplatform as follows:
35+
*
36+
* ```gradle
37+
* oomphIde {
38+
* pde {
39+
* targetplatform {
40+
* it.installation '../target.maven/build'
41+
* it.installation '../target.p2/build/p2asmaven/p2runnable/eclipse-deps'
42+
* }
43+
* }
44+
* }
45+
* ```
46+
*/
2647
public class ConventionPde extends OomphConvention {
2748
ConventionPde(OomphIdeExtension extension) {
2849
super(extension);

src/main/java/com/diffplug/gradle/oomph/OomphIdePlugin.java

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
*
3232
* - `gradlew ide` launches the IDE, after running any required setup tasks.
3333
*
34-
* To create an IDE for java projects:
34+
* To create an IDE for java projects (see {@link ConventionJdt} for more JDT options).
3535
*
3636
* ```groovy
3737
* apply plugin: 'com.diffplug.gradle.oomph.ide'
@@ -41,17 +41,12 @@
4141
* }
4242
* ```
4343
*
44-
* For an Eclipse Plugin project with a target platform:
44+
* For an Eclipse Plugin project (see {@link ConventionPde} for more JDT options).
4545
*
4646
* ```groovy
4747
* oomphIde {
4848
* repoEclipse '4.5.2'
49-
* pde {
50-
* targetplatform {
51-
* installation 'target.maven/build'
52-
* installation 'target.p2/build/p2asmaven/p2'
53-
* }
54-
* }
49+
* pde {}
5550
* }
5651
* ```
5752
*

0 commit comments

Comments
 (0)