Skip to content

Commit 0cbfee2

Browse files
committed
improve docs
1 parent 8bd287e commit 0cbfee2

File tree

1 file changed

+35
-0
lines changed

1 file changed

+35
-0
lines changed

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

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,41 @@ public abstract class GitCommitIdPluginExtension {
7373

7474
/**
7575
* Setup the default values / conventions for the GitCommitIdPluginExtension.
76+
*
77+
* <p>This extension provides basic configuration options. For more advanced settings,
78+
* refer to the following nested extensions:
79+
*
80+
* <ul>
81+
* <li>{@link GitCommitIdPluginGitSettingsExtension} - Configure git repository settings:
82+
* <ul>
83+
* <li>.git directory location</li>
84+
* <li>git describe options</li>
85+
* <li>native git usage</li>
86+
* <li>abbrev length</li>
87+
* <li>offline mode</li>
88+
* </ul>
89+
* </li>
90+
* <li>{@link GitCommitIdPluginFormatSettingsExtension} - Configure property formatting:
91+
* <ul>
92+
* <li>property prefix</li>
93+
* <li>date format</li>
94+
* <li>timezone for generated properties</li>
95+
* </ul>
96+
* </li>
97+
* <li>{@link GitCommitIdPluginOutputSettingsExtension} - Configure output file generation:
98+
* <ul>
99+
* <li>output file location</li>
100+
* <li>format (JSON or properties)</li>
101+
* <li>unicode escaping</li>
102+
* </ul>
103+
* </li>
104+
* <li>{@link GitCommitIdPluginFilterSettingsExtension} - Configure property filtering:
105+
* <ul>
106+
* <li>include specific properties</li>
107+
* <li>exclude specific properties</li>
108+
* </ul>
109+
* </li>
110+
* </ul>
76111
*/
77112
@Inject
78113
public GitCommitIdPluginExtension() {

0 commit comments

Comments
 (0)