add javadoc
authorDavid ‘Bombe’ Roden <bombe@freenetproject.org>
Sun, 22 Jun 2008 14:03:41 +0000 (16:03 +0200)
committerDavid ‘Bombe’ Roden <bombe@freenetproject.org>
Sun, 22 Jun 2008 23:29:36 +0000 (01:29 +0200)
src/de/todesbaum/jsite/gui/FileScannerListener.java

index b8e373b..3ca01db 100644 (file)
@@ -21,8 +21,21 @@ package de.todesbaum.jsite.gui;
 
 import java.util.EventListener;
 
+/**
+ * Listener interface for objects that want to be notified when scanning a
+ * project’s local path has finished.
+ * 
+ * @see FileScanner
+ * @author David ‘Bombe’ Roden &lt;bombe@freenetproject.org&gt;
+ */
 public interface FileScannerListener extends EventListener {
 
+       /**
+        * Notifies a listener that scanning a project’s local path has finished.
+        * 
+        * @param fileScanner
+        *            The file scanner that finished
+        */
        public void fileScannerFinished(FileScanner fileScanner);
 
 }
\ No newline at end of file