From f6735576419f7861c7f5977c5bf29eb7c29f2c82 Mon Sep 17 00:00:00 2001 From: ribeaudc <ribeaudc> Date: Tue, 22 May 2007 16:14:32 +0000 Subject: [PATCH] Javadoc completed. SVN: 175 --- .../java/ch/systemsx/cisd/common/utilities/FileUtilities.java | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/common/source/java/ch/systemsx/cisd/common/utilities/FileUtilities.java b/common/source/java/ch/systemsx/cisd/common/utilities/FileUtilities.java index 4c2be6806a1..d40fed2c568 100644 --- a/common/source/java/ch/systemsx/cisd/common/utilities/FileUtilities.java +++ b/common/source/java/ch/systemsx/cisd/common/utilities/FileUtilities.java @@ -45,7 +45,9 @@ public class FileUtilities /** * Loads the specified text file. * - * @return text from <code>text</code>. All newline characters are '\n'. + * @param file the file that should be loaded. This method assumes that given <code>File</code> is not + * <code>null</code> and that it exists. + * @return text from <code>text</code>. All newline characters are '\n'. */ public static String loadText(File file) { -- GitLab