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
index bef34aa..7441290 100755 (executable)
--- a/src/main/java/eu/svjatoslav/commons/file/CommonPathResolver.java
+++ b/src/main/java/eu/svjatoslav/commons/file/CommonPathResolver.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.
@@ -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() {