From b4e41dd5493aeb950d12e8086c4461ca0a4d4ee9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Clermont=C3=A9?= Date: Tue, 16 Aug 2016 19:18:26 +0200 Subject: [PATCH] Issue#42 improved javadoc --- build.xml | 2 ++ src/org/dclermonte/siba/gui/AboutDialog.java | 1 + src/org/dclermonte/siba/gui/BackupPanel.java | 4 +++ .../siba/gui/CheckDirectorySelector.java | 6 +++- src/org/dclermonte/siba/gui/CheckPanel.java | 3 ++ src/org/dclermonte/siba/gui/SibaGUI.java | 1 + .../siba/gui/SourceDirectorySelector.java | 7 +++- .../siba/gui/TargetDirectorySelector.java | 7 +++- src/org/dclermonte/siba/model/SibaUtils.java | 35 +++++++++++++++---- 9 files changed, 57 insertions(+), 9 deletions(-) diff --git a/build.xml b/build.xml index 96d2fe7..9f6b1a4 100644 --- a/build.xml +++ b/build.xml @@ -31,11 +31,13 @@ + + diff --git a/src/org/dclermonte/siba/gui/AboutDialog.java b/src/org/dclermonte/siba/gui/AboutDialog.java index c4a4c51..0db09e2 100644 --- a/src/org/dclermonte/siba/gui/AboutDialog.java +++ b/src/org/dclermonte/siba/gui/AboutDialog.java @@ -55,6 +55,7 @@ public class AboutDialog extends JDialog * This is the constructor for the dialog. * * @throws IOException + * IOException */ public AboutDialog() throws IOException { diff --git a/src/org/dclermonte/siba/gui/BackupPanel.java b/src/org/dclermonte/siba/gui/BackupPanel.java index fea5e44..d4070ed 100644 --- a/src/org/dclermonte/siba/gui/BackupPanel.java +++ b/src/org/dclermonte/siba/gui/BackupPanel.java @@ -60,6 +60,9 @@ public class BackupPanel extends JPanel /** * This is the constructor for this panel. + * + * @throws SibaException + * specific exception */ public BackupPanel() throws SibaException { @@ -207,6 +210,7 @@ public class BackupPanel extends JPanel /** * * @param sourceDirectory + * the source Directory */ public void setSourceDirectory(final String sourceDirectory) { diff --git a/src/org/dclermonte/siba/gui/CheckDirectorySelector.java b/src/org/dclermonte/siba/gui/CheckDirectorySelector.java index 581ea1e..1e22f6f 100644 --- a/src/org/dclermonte/siba/gui/CheckDirectorySelector.java +++ b/src/org/dclermonte/siba/gui/CheckDirectorySelector.java @@ -26,6 +26,7 @@ public class CheckDirectorySelector extends JFileChooser /** * * @param targetFile + * target file */ public CheckDirectorySelector(final File targetFile) { @@ -89,7 +90,10 @@ public class CheckDirectorySelector extends JFileChooser * This method is the main one of the selector. * * @param parent - * @return + * The parent's component + * @param targetFile + * target file + * @return the selected file */ public static File showSelectorDialog(final Component parent, final File targetFile) { diff --git a/src/org/dclermonte/siba/gui/CheckPanel.java b/src/org/dclermonte/siba/gui/CheckPanel.java index b513981..6ea5b73 100644 --- a/src/org/dclermonte/siba/gui/CheckPanel.java +++ b/src/org/dclermonte/siba/gui/CheckPanel.java @@ -62,6 +62,8 @@ public class CheckPanel extends JPanel /** * + * @throws SibaException + * specific exception */ public CheckPanel() throws SibaException { @@ -168,6 +170,7 @@ public class CheckPanel extends JPanel /** * * @param sourceDirectory + * the source directory */ public void setFileToCheck(final String sourceDirectory) { diff --git a/src/org/dclermonte/siba/gui/SibaGUI.java b/src/org/dclermonte/siba/gui/SibaGUI.java index 2102686..39b42d9 100644 --- a/src/org/dclermonte/siba/gui/SibaGUI.java +++ b/src/org/dclermonte/siba/gui/SibaGUI.java @@ -321,6 +321,7 @@ public final class SibaGUI * This method set the local language. * * @param source + * locale */ public static void updateLanguage(final Locale source) { diff --git a/src/org/dclermonte/siba/gui/SourceDirectorySelector.java b/src/org/dclermonte/siba/gui/SourceDirectorySelector.java index 728830a..d4af083 100644 --- a/src/org/dclermonte/siba/gui/SourceDirectorySelector.java +++ b/src/org/dclermonte/siba/gui/SourceDirectorySelector.java @@ -23,6 +23,8 @@ public class SourceDirectorySelector extends JFileChooser /** * + * @param targetFile + * target file */ public SourceDirectorySelector(final File targetFile) { @@ -85,7 +87,10 @@ public class SourceDirectorySelector extends JFileChooser * This method is the main one of the selector. * * @param parent - * @return + * the parent's component + * @param targetFile + * target file + * @return the selected file */ public static File showSelectorDialog(final Component parent, final File targetFile) { diff --git a/src/org/dclermonte/siba/gui/TargetDirectorySelector.java b/src/org/dclermonte/siba/gui/TargetDirectorySelector.java index 1a5fde0..088c4f7 100644 --- a/src/org/dclermonte/siba/gui/TargetDirectorySelector.java +++ b/src/org/dclermonte/siba/gui/TargetDirectorySelector.java @@ -23,6 +23,8 @@ public class TargetDirectorySelector extends JFileChooser /** * + * @param targetFile + * target file */ public TargetDirectorySelector(final File targetFile) { @@ -87,7 +89,10 @@ public class TargetDirectorySelector extends JFileChooser * This method is the main one of the selector. * * @param parent - * @return + * the parent's component + * @param targetFile + * target file + * @return the selected file */ public static File showSelectorDialog(final Component parent, final File targetFile) { diff --git a/src/org/dclermonte/siba/model/SibaUtils.java b/src/org/dclermonte/siba/model/SibaUtils.java index 091c1a7..40419a1 100644 --- a/src/org/dclermonte/siba/model/SibaUtils.java +++ b/src/org/dclermonte/siba/model/SibaUtils.java @@ -55,9 +55,11 @@ public final class SibaUtils * the file on which the md5 is calculate * @param target * the MD5 file - * @return + * @return the MD5 file * @throws IOException + * IOException * @throws NoSuchAlgorithmException + * NoSuchAlgorithmException */ public static File createMD5File(final File inputFile, final String target) throws IOException, NoSuchAlgorithmException @@ -75,10 +77,14 @@ public final class SibaUtils /** * * @param md5 + * Hash MD5 * @param fileName + * The name of the file * @param target - * @return + * directory to put the file + * @return The MD5 file * @throws IOException + * IOexception */ public static File createMD5File(final String md5, final String fileName, final String target) throws IOException { @@ -107,8 +113,10 @@ public final class SibaUtils /** * * @param choosenFile - * @return + * the file to check + * @return The MD5sum * @throws IOException + * IOException */ public static String loadMD5Sum(final File choosenFile) throws IOException { @@ -141,9 +149,12 @@ public final class SibaUtils * This method calculate the MD5 itself. * * @param input - * @return + * The name of the file for witch the MD5 sum is to calculate + * @return The MD5Sum * @throws IOException + * IOException * @throws NoSuchAlgorithmException + * NoSuchAlgorithmException */ public static String md5(final File input) throws IOException, NoSuchAlgorithmException { @@ -192,8 +203,10 @@ public final class SibaUtils /** * * @param choosenFile - * @return + * The MD5file + * @return the file to check * @throws IOException + * IOException */ public static File readFileNameToCheck(final File choosenFile) throws IOException { @@ -234,8 +247,11 @@ public final class SibaUtils /** * - * @return + * @param resource + * the resource to read + * @return the string of the resource * @throws IOException + * IOException */ public static String readResource(final String resource) throws IOException { @@ -250,8 +266,11 @@ public final class SibaUtils /** * * @param fileToSave + * The directory to backup * @param outputStream + * local Stream * @throws IOException + * IOException */ public static void tarDirectoryTree(final File fileToSave, final TarArchiveOutputStream outputStream) throws IOException @@ -265,9 +284,13 @@ public final class SibaUtils * This method generates ArchiveEntry. * * @param directory + * The actual directory being archived * @param outputStream + * local stream * @param pathLength + * used to select the starting directory * @throws IOException + * IOException */ public static void tarDirectoryTree(final File directory, final TarArchiveOutputStream outputStream, final int pathLength) throws IOException