Skip to content

Commit 0ee3d21

Browse files
committed
Add package infos
2 parents ed3d252 + 95b3570 commit 0ee3d21

File tree

4 files changed

+54
-0
lines changed

4 files changed

+54
-0
lines changed
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
/**
2+
* Provides all classes for the well-known <em>keyword-based configuration</em> or <em>DSL</em> that all default
3+
* <em>Gradle</em> plugins provide.
4+
*
5+
* <p>
6+
* The entry point to this configuration is {@link GitflowPluginExtension}.
7+
* </p>
8+
*/
9+
package com.github.amkay.gradle.gitflow.dsl;
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
/**
2+
* For a detailed description of this <em>Gradle</em> plugin please see the Project page on <em>GitHub</em>.
3+
*/
4+
package com.github.amkay.gradle.gitflow;
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
/**
2+
* Provides the strategies for inferring the version of the project to which the plugin is applied.
3+
*
4+
* <p>
5+
* The entry point to this package is the interface {@link Strategy}.
6+
* </p>
7+
*
8+
* <p>
9+
* There is exactly one class for each type of branch defined in the <em>Gitflow Branching Model</em> that
10+
* provides a strategy to infer the version of the project.
11+
* Furthermore, there is {@link DetachedHeadStrategy} that applies if the current commit is a <strong>detached
12+
* head</strong>.
13+
* {@link AbstractStrategy} is the base class of these strategies and provides common logic like logging.
14+
* </p>
15+
*/
16+
package com.github.amkay.gradle.gitflow.strategy;
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
/**
2+
* Contains the object that is set as <code>version</code> property on the project to which this plugin is applied.
3+
*
4+
* The most important aspects of this <code>version</code> object are:
5+
*
6+
* <ul>
7+
* <li>
8+
* The version is <strong>lazily</strong> inferred. That means the plugin only interacts with Your
9+
* <em>Git</em> repository if a method on this <code>version</code> object is called, e.g. <code>toString()
10+
* </code>. This functionality is realized by {@link DelayedVersionWithType}, which is the actual type of the
11+
* set <code>version</code> object.
12+
* </li>
13+
* <li>
14+
* This {@link DelayedVersionWithType} delegates to {@link VersionWithType}, which provides the real
15+
* functionality of the <code>version</code> object.
16+
* </li>
17+
* <li>
18+
* The class {@link VersionWithType} actually delegates to {@link Version} and provides additional
19+
* functionality to determine the {@link VersionType type} of the inferred version.
20+
* </li>
21+
* <ul>
22+
*/
23+
package com.github.amkay.gradle.gitflow.version
24+
25+
import com.github.zafarkhaja.semver.Version;

0 commit comments

Comments
 (0)