svn commit: r1420399 - /maven/release/trunk/maven-release-manager/src/main/java/org/apache/maven/shared/release/versions/VersionInfo.java

[rfscholte]

Author: rfscholte
Date: Tue Dec 11 20:55:18 2012
New Revision: 1420399

URL: http://svn.apache.org/viewvc?rev=1420399&view=rev
Log:
Add javadoc

Modified:
    
maven/release/trunk/maven-release-manager/src/main/java/org/apache/maven/shared/release/versions/VersionInfo.java

Modified: 
maven/release/trunk/maven-release-manager/src/main/java/org/apache/maven/shared/release/versions/VersionInfo.java
URL: 
http://svn.apache.org/viewvc/maven/release/trunk/maven-release-manager/src/main/java/org/apache/maven/shared/release/versions/VersionInfo.java?rev=1420399&r1=1420398&r2=1420399&view=diff
==============================================================================
--- 
maven/release/trunk/maven-release-manager/src/main/java/org/apache/maven/shared/release/versions/VersionInfo.java
 (original)
+++ 
maven/release/trunk/maven-release-manager/src/main/java/org/apache/maven/shared/release/versions/VersionInfo.java
 Tue Dec 11 20:55:18 2012
@@ -29,28 +29,28 @@ public interface VersionInfo
     /**
      * Returns a string representing the version with a snapshot specification
      *
-     * @return
+     * @return the snapshot version transformation of the original value
      */
     String getSnapshotVersionString();
 
     /**
      * Returns a string representing the version without a snapshot 
specification.
      *
-     * @return
+     * @return the final version transformation of the original value
      */
     String getReleaseVersionString();
 
     /**
      * Returns a {@link VersionInfo} object which represents the next version 
of this object.
      *
-     * @return
+     * @return the next VersionInfo
      */
     VersionInfo getNextVersion();
 
     /**
      * Returns whether this represents a snapshot version.
      *
-     * @return
+     * @return {@code true} if the original value was a snapshot, otherwise 
{@code false}
      */
     boolean isSnapshot();
 }