improved javadoc

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

diff --git a/src/main/java/eu/svjatoslav/commons/file/CommonPathResolver.java b/src/main/java/eu/svjatoslav/commons/file/CommonPathResolver.java
old mode 100644 (file)
new mode 100755 (executable)
index d3c1f9f..7441290
--- a/src/main/java/eu/svjatoslav/commons/file/CommonPathResolver.java
+++ b/src/main/java/eu/svjatoslav/commons/file/CommonPathResolver.java
@@ -1,10 +1,10 @@
 /*
  * Svjatoslav Commons - shared library of common functionality.
- * Copyright ©2012-2013, Svjatoslav Agejenko, svjatoslav@svjatoslav.eu
- * 
+ * 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 2 of the GNU General Public License
- * as published by the Free Software Foundation.
+ * modify it under the terms of version 3 of the GNU Lesser General Public License
+ * or later as published by the Free Software Foundation.
  */
 
 package eu.svjatoslav.commons.file;
@@ -30,6 +30,10 @@ public class CommonPathResolver {
        /**
         * This method tries to guess user desktop directory. Implementation is
         * pretty lousy. Need to improve it some day.
+        *
+        * @return file that points to user desktop directory.
+        * @throws RuntimeException
+        *             if user desktop directory is not found.
         */
        public static File getDesktopDirectory() {
 
@@ -43,7 +47,7 @@ public class CommonPathResolver {
                        final String desktopPath = userHomePath + "/" + desktopName;
 
                        final File possibleDesktopFile = new File(desktopPath);
-                       if (desktopFile.exists()) {
+                       if (possibleDesktopFile.exists()) {
                                desktopFile = possibleDesktopFile;
                                return desktopFile;
                        }