Skip to content

Commit c624a72

Browse files
authored
Merge pull request #917 from diffplug/feat/javadoc-fixup
2 parents a509e13 + cec94e3 commit c624a72

File tree

17 files changed

+51
-51
lines changed

17 files changed

+51
-51
lines changed

lib-extra/src/main/java/com/diffplug/spotless/extra/GitAttributesLineEndings.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@
5555
import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
5656

5757
/**
58-
* Uses [.gitattributes](https://git-scm.com/docs/gitattributes) to determine
58+
* Uses <a href="https://git-scm.com/docs/gitattributes">.gitattributes</a> to determine
5959
* the appropriate line ending. Falls back to the {@code core.eol} property in the
6060
* git config if there are no applicable git attributes, then finally falls
6161
* back to the platform native.

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929
import com.diffplug.spotless.Provisioner;
3030
import com.diffplug.spotless.ThrowingEx.Function;
3131

32-
/** Wraps up [google-java-format](https://github.com/google/google-java-format) as a FormatterStep. */
32+
/** Wraps up <a href="https://github.com/google/google-java-format">google-java-format</a> as a FormatterStep. */
3333
public class GoogleJavaFormatStep {
3434
// prevent direct instantiation
3535
private GoogleJavaFormatStep() {}

lib/src/main/java/com/diffplug/spotless/kotlin/DiktatStep.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727

2828
import com.diffplug.spotless.*;
2929

30-
/** Wraps up [diktat](https://github.com/cqfn/diKTat) as a FormatterStep. */
30+
/** Wraps up <a href="https://github.com/cqfn/diKTat">diktat</a> as a FormatterStep. */
3131
public class DiktatStep {
3232

3333
// prevent direct instantiation

lib/src/main/java/com/diffplug/spotless/kotlin/KtLintStep.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@
3232
import com.diffplug.spotless.Provisioner;
3333
import com.diffplug.spotless.ThrowingEx;
3434

35-
/** Wraps up [ktlint](https://github.com/pinterest/ktlint) as a FormatterStep. */
35+
/** Wraps up <a href="https://github.com/pinterest/ktlint">ktlint</a> as a FormatterStep. */
3636
public class KtLintStep {
3737
// prevent direct instantiation
3838
private KtLintStep() {}

lib/src/main/java/com/diffplug/spotless/kotlin/KtfmtStep.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626
import com.diffplug.spotless.*;
2727

2828
/**
29-
* Wraps up [ktfmt](https://github.com/facebookincubator/ktfmt) as a FormatterStep.
29+
* Wraps up <a href="https://github.com/facebookincubator/ktfmt">ktfmt</a> as a FormatterStep.
3030
*/
3131
public class KtfmtStep {
3232
// prevent direct instantiation

lib/src/main/java/com/diffplug/spotless/markdown/FreshMarkStep.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2016 DiffPlug
2+
* Copyright 2016-2021 DiffPlug
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -32,7 +32,7 @@
3232
import com.diffplug.spotless.Provisioner;
3333
import com.diffplug.spotless.ThrowingEx.Supplier;
3434

35-
/** A step for [FreshMark](https://github.com/diffplug/freshmark). */
35+
/** A step for <a href="https://github.com/diffplug/freshmark">FreshMark</a>. */
3636
public class FreshMarkStep {
3737
// prevent direct instantiation
3838
private FreshMarkStep() {}

lib/src/main/java/com/diffplug/spotless/scala/ScalaFmtStep.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@
3434
import com.diffplug.spotless.JarState;
3535
import com.diffplug.spotless.Provisioner;
3636

37-
/** Wraps up [scalafmt](https://github.com/scalameta/scalafmt) as a FormatterStep. */
37+
/** Wraps up <a href="https://github.com/scalameta/scalafmt">scalafmt</a> as a FormatterStep. */
3838
public class ScalaFmtStep {
3939
// prevent direct instantiation
4040
private ScalaFmtStep() {}

plugin-gradle/CHANGES.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -291,7 +291,7 @@ spotless {
291291

292292
## [4.1.0] - 2020-06-01
293293
### Added
294-
* You can now ratchet a project's style by limiting Spotless only to files which have changed since a given [git reference](https://javadoc.io/static/org.eclipse.jgit/org.eclipse.jgit/5.6.1.202002131546-r/org/eclipse/jgit/lib/Repository.html#resolve-java.lang.String-), e.g. `ratchetFrom 'origin/main'`. ([#590](https://github.com/diffplug/spotless/pull/590))
294+
* You can now ratchet a project's style by limiting Spotless only to files which have changed since a given [git reference](https://javadoc.io/doc/org.eclipse.jgit/org.eclipse.jgit/5.6.1.202002131546-r/org/eclipse/jgit/lib/Repository.html#resolve-java.lang.String-), e.g. `ratchetFrom 'origin/main'`. ([#590](https://github.com/diffplug/spotless/pull/590))
295295
* Support for ktfmt in KotlinGradleExtension. ([#583](https://github.com/diffplug/spotless/pull/583))
296296
### Fixed
297297
* Users can now run `spotlessCheck` and `spotlessApply` in the same build. ([#584](https://github.com/diffplug/spotless/pull/584))
@@ -573,7 +573,7 @@ spotless {
573573
* BREAKING CHANGE: `customReplace` and `customReplaceRegex` renamed to just `replace` and `replaceRegex`.
574574
* BREAKING CHANGE: Plugin portal ID is still `com.diffplug.gradle.spotless`, but maven coordinate has changed to `com.diffplug.spotless:spotless-plugin-gradle`.
575575
* HUGE SPEEDUP: Now supports incremental build / up-to-date-checking.
576-
+ If you are using `custom` or `customLazy`, you might want to take a look at [this javadoc](https://javadoc.io/static/com.diffplug.spotless/spotless-plugin-gradle/3.27.0/com/diffplug/gradle/spotless/FormatExtension.html#bumpThisNumberIfACustomStepChanges-int-).
576+
+ If you are using `custom` or `customLazy`, you might want to take a look at [this javadoc](https://javadoc.io/doc/com.diffplug.spotless/spotless-plugin-gradle/3.27.0/com/diffplug/gradle/spotless/FormatExtension.html#bumpThisNumberIfACustomStepChanges-int-).
577577
* BREAKING CHANGE: `freshmark` no longer includes all project properties by default. All properties must now be added manually:
578578

579579
```gradle

0 commit comments

Comments
 (0)