improved javadoc

[svjatoslav_commons.git] / src / main / java / eu / svjatoslav / commons / string / String2.java

diff --git a/src/main/java/eu/svjatoslav/commons/string/String2.java b/src/main/java/eu/svjatoslav/commons/string/String2.java
index b19e99a..45c6cd0 100755 (executable)
--- a/src/main/java/eu/svjatoslav/commons/string/String2.java
+++ b/src/main/java/eu/svjatoslav/commons/string/String2.java
@@ -1,7 +1,7 @@
 /*
  * Svjatoslav Commons - shared library of common functionality.
  * Copyright ©2012-2014, Svjatoslav Agejenko, svjatoslav@svjatoslav.eu
- * 
+ *
  * This program is free software; you can redistribute it and/or
  * modify it under the terms of version 3 of the GNU Lesser General Public License
  * or later as published by the Free Software Foundation.
@@ -36,8 +36,11 @@ public class String2 {
        }
 
        /**
-        * Cut given amount of characters from the left of the string. Return cutted
-        * part.
+        * Cut given amount of characters from the left of the string.
+        *
+        * @param cutAmount
+        *            of characters to cut
+        * @return cutted part.
         */
        public String cutLeft(final int cutAmount) {