improved javadoc

[svjatoslav_commons.git] / src / main / java / eu / svjatoslav / commons / file / IOHelper.java

diff --git a/src/main/java/eu/svjatoslav/commons/file/IOHelper.java b/src/main/java/eu/svjatoslav/commons/file/IOHelper.java
index 46abaa5..e7ee659 100755 (executable)
--- a/src/main/java/eu/svjatoslav/commons/file/IOHelper.java
+++ b/src/main/java/eu/svjatoslav/commons/file/IOHelper.java
@@ -20,6 +20,12 @@ public class IOHelper {
 
        /**
         * Deletes files and directories recursively. WARNING!!! Follows symlinks!!!
+        *
+        * @param file
+        *            directory to delete with entire contents.
+        *
+        * @throws IOException
+        *             if filesystem error happens
         */
        public static void deleteRecursively(final File file) throws IOException {
                if (file.isDirectory()) {
@@ -64,7 +70,16 @@ public class IOHelper {
         * then leaves file as-is. If content differs, then overrides file with the
         * new content.
         *
+        * @param file
+        *            file to potentially overwrite
+        * @param newContent
+        *            new content
         * @return <code>true</code> if file was overwritten.
+        *
+        * @throws FileNotFoundException
+        *             if file is not found.
+        * @throws IOException
+        *             if error happens during file IO.
         */
        public static boolean overwriteFileIfContentDiffers(final File file,
                        final byte[] newContent) throws FileNotFoundException, IOException {