Skip to content

Commit 0ddd254

Browse files
committed
Refine doc
1 parent d4b8a58 commit 0ddd254

2 files changed

Lines changed: 12 additions & 4 deletions

File tree

doc/Development.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,8 @@ Internal types also have javadoc for more information.
1616
* `e2e` contains e2e json 2-way serialization and deserialization tests against target languages' http servers.
1717
* `build-tool-plugins` contains Maven and Gradle plugin for SharedType annotation.
1818
* `exec` contains generic annotation processor executor.
19-
* `maven-plugin/it` contains integration tests for maven plugin.
19+
* `maven-plugin` and `maven-plugin/it` contains Maven plugin and integration tests.
20+
* `gradle-plugin` and `gradle-plugin/it` contains Gradle plugin and integration tests.
2021

2122
Domain types are shared among processor and integration tests to reduce maven module count.
2223

@@ -33,14 +34,15 @@ Optionally mount tmpfs to save your disk by:
3334
```
3435
Optionally setup `MVND_HOME` to use [maven daemon](https://github.com/apache/maven-mvnd) by `mvnd`
3536

36-
Choose maven profiles in IDE accordingly as below.
37+
**Choose maven profiles in IDE accordingly as below.**
3738

3839
### Maven profiles
3940
* `dev` and `release` - control whether to include test maven modules during build.
4041
* `it` - enable integration test profile. `internal` folder is shared source between `processor` and `it`,
4142
IDE may not able to properly resolve classes in `internal` folder for both modules.
4243
Enable this profile to enable `it` modules in IDE, and disable it when developing against `processor` module.
4344
* `it-no-jpms` and `it-jpms` - control whether to enable Java 9 Jigsaw module test in `it`. `it/java8` sources are reused to test on jdk9. Turn on `it-jpms` for IDE to correctly resolve `it/java8` classes.
45+
* `java8-jdk-tools-jar` - auto managed for adding `tools.jar` dependency for annotation processor.
4446
* `dev-build-tool` - controls build tool plugin modules.
4547

4648
## Development

doc/Usage.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,13 +41,19 @@ The advantage of using `sharedtype-maven-plugin` is that no need to execute othe
4141

4242
### Gradle
4343
Add sharedtype plugin and annotation dependency:
44+
```properties
45+
# gradle.properties
46+
sharedtypeVersion=<your-version>
47+
```
48+
4449
```groovy
50+
// build.gradle
4551
plugins {
46-
id("online.sharedtype.sharedtype-gradle-plugin") version "${sharedtype.version}"
52+
id "online.sharedtype.sharedtype-gradle-plugin" version "${sharedtypeVersion}"
4753
}
4854
4955
dependencies {
50-
compileOnly "online.sharedtype:sharedtype:${sharedtype.version}"
56+
compileOnly "online.sharedtype:sharedtype:${sharedtypeVersion}"
5157
}
5258
```
5359

0 commit comments

Comments
 (0)