Skip to content

Commit 1d150a2

Browse files
author
TheSnoozer
committed
update javadoc
1 parent 2f14478 commit 1d150a2

3 files changed

Lines changed: 9 additions & 9 deletions

File tree

src/main/java/io/github/git/commit/id/gradle/plugin/GitCommitIdPluginExtension.java

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,13 +18,9 @@
1818
package io.github.git.commit.id.gradle.plugin;
1919

2020
import java.util.Collections;
21-
import java.util.TimeZone;
2221
import javax.inject.Inject;
23-
import org.gradle.api.file.DirectoryProperty;
24-
import org.gradle.api.file.ProjectLayout;
2522
import org.gradle.api.provider.ListProperty;
2623
import org.gradle.api.provider.Property;
27-
import pl.project13.core.git.GitDescribeConfig;
2824

2925
/**
3026
* The {@link GitCommitIdPlugin} comes with a sensible set of default configurations and settings.

src/main/java/io/github/git/commit/id/gradle/plugin/GitCommitIdPluginFormatSettingsExtension.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,8 +48,8 @@ public abstract class GitCommitIdPluginFormatSettingsExtension {
4848
* DSL like configuration in the {@code build.gradle}:
4949
* <pre>
5050
* gitCommitId {
51-
* outputSettings {
52-
* shouldGenerateOutputFile.set(true)
51+
* formatSettings {
52+
* propertyPrefix.set("git")
5353
* }
5454
* }
5555
* </pre>

src/main/java/io/github/git/commit/id/gradle/plugin/GitCommitIdPluginGitSettingsExtension.java

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -48,8 +48,12 @@ public abstract class GitCommitIdPluginGitSettingsExtension {
4848
* DSL like configuration in the {@code build.gradle}:
4949
* <pre>
5050
* gitCommitId {
51-
* outputSettings {
52-
* shouldGenerateOutputFile.set(true)
51+
* gitSettings {
52+
* dotGitDirectory.set(
53+
* project.getObjects().directoryProperty().set(
54+
* project.getLayout().getProjectDirectory().dir(".git")
55+
* )
56+
* )
5357
* }
5458
* }
5559
* </pre>
@@ -80,7 +84,7 @@ public abstract class GitCommitIdPluginGitSettingsExtension {
8084
*
8185
* <p>Refer to {@link GitDescribeConfig} for options that can be passed towards git-describe.
8286
* The result of this configuration is exposed as
83-
* {@link GitCommitIdPluginExtension#getPropertyPrefix()}{@code .commit.id.describe}.
87+
* {@link GitCommitIdPluginFormatSettingsExtension#getPropertyPrefix()}{@code .commit.id.describe}.
8488
*/
8589
public abstract Property<GitDescribeConfig> getGitDescribeConfig();
8690

0 commit comments

Comments
 (0)