Skip to content

Commit bcab5b4

Browse files
committed
Improve documentation and changelog ref
1 parent 69e8524 commit bcab5b4

File tree

3 files changed

+6
-1
lines changed

3 files changed

+6
-1
lines changed

lib/src/cleanthat/java/com/diffplug/spotless/glue/java/JavaCleanthatRefactorerFunc.java

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,10 @@
3030
import eu.solven.cleanthat.engine.java.refactorer.JavaRefactorerProperties;
3131
import eu.solven.cleanthat.formatter.LineEnding;
3232

33+
/**
34+
* The glue for CleanThat: it is build over the version in build.gradle, but at runtime it will be executed over
35+
* the version loaded in JarState, which is by default defined in com.diffplug.spotless.java.CleanthatJavaStep#JVM_SUPPORT
36+
*/
3337
public class JavaCleanthatRefactorerFunc implements FormatterFunc {
3438
private static final Logger LOGGER = LoggerFactory.getLogger(JavaCleanthatRefactorerFunc.class);
3539

lib/src/main/java/com/diffplug/spotless/java/CleanthatJavaStep.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,7 @@ public final class CleanthatJavaStep {
3939
private static final String NAME = "cleanthat";
4040
private static final String MAVEN_COORDINATE = "io.github.solven-eu.cleanthat:java";
4141

42+
// CleanThat changelog is available at https://github.com/solven-eu/cleanthat/blob/master/CHANGES.MD
4243
private static final Jvm.Support<String> JVM_SUPPORT = Jvm.<String> support(NAME).add(11, "2.1");
4344

4445
// prevent direct instantiation

plugin-maven/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -278,7 +278,7 @@ These mechanisms already exist for the Gradle plugin.
278278

279279
### Cleanthat
280280

281-
[homepage](https://github.com/solven-eu/cleanthat). CleanThat enables automatic refactoring of Java code
281+
[homepage](https://github.com/solven-eu/cleanthat). CleanThat enables automatic refactoring of Java code. [ChangeLog](https://github.com/solven-eu/cleanthat/blob/master/CHANGES.MD)
282282

283283
```xml
284284
<cleanthat>

0 commit comments

Comments
 (0)