JavaDoc fixes

16 files changed, 18 insertions, 23 deletions

diff --git a/BKUCommonGUI/src/main/java/at/gv/egiz/bku/gui/BKUGUIImpl.java b/BKUCommonGUI/src/main/java/at/gv/egiz/bku/gui/BKUGUIImpl.java
index 111c73a1..82513a0e 100644
--- a/BKUCommonGUI/src/main/java/at/gv/egiz/bku/gui/BKUGUIImpl.java
+++ b/BKUCommonGUI/src/main/java/at/gv/egiz/bku/gui/BKUGUIImpl.java
@@ -1749,11 +1749,11 @@ public class BKUGUIImpl implements BKUGUIFacade {
 	// //////////////////////////////////////////////////////////////////////////
 
 	/**
-	 * @param signedReferences
+	 * @param dataToBeSigned
 	 * @param backListener
 	 *            gets notified if pin-dialog has to be redrawn
 	 *            (signedRefencesList returns via BACK button)
-	 * @param okCommand
+	 * @param backCommand
 	 */
 	@Override
 	public void showSecureViewer(final List<HashDataInput> dataToBeSigned,
diff --git a/BKUCommonGUI/src/main/java/at/gv/egiz/bku/gui/BKUIcons.java b/BKUCommonGUI/src/main/java/at/gv/egiz/bku/gui/BKUIcons.java
index f8bba7f4..ff1d5463 100644
--- a/BKUCommonGUI/src/main/java/at/gv/egiz/bku/gui/BKUIcons.java
+++ b/BKUCommonGUI/src/main/java/at/gv/egiz/bku/gui/BKUIcons.java
@@ -35,7 +35,7 @@ import org.slf4j.LoggerFactory;
 
 /**
  *
- * @author Clemens Orthacker <clemens.orthacker@iaik.tugraz.at>
+ * @author Clemens Orthacker &lt;clemens.orthacker@iaik.tugraz.at&gt;
  */
 public class BKUIcons {
 
diff --git a/BKUCommonGUI/src/main/java/at/gv/egiz/bku/gui/HashDataTableModel.java b/BKUCommonGUI/src/main/java/at/gv/egiz/bku/gui/HashDataTableModel.java
index 44eb7cbf..a9523054 100644
--- a/BKUCommonGUI/src/main/java/at/gv/egiz/bku/gui/HashDataTableModel.java
+++ b/BKUCommonGUI/src/main/java/at/gv/egiz/bku/gui/HashDataTableModel.java
@@ -30,7 +30,7 @@ import javax.swing.table.DefaultTableModel;
 
 /**
  * 
- * @author Clemens Orthacker <clemens.orthacker@iaik.tugraz.at>
+ * @author Clemens Orthacker &lt;clemens.orthacker@iaik.tugraz.at&gt;
  */
 class HashDataTableModel extends DefaultTableModel {
 
diff --git a/BKUCommonGUI/src/main/java/at/gv/egiz/bku/gui/HelpLinkFocusManager.java b/BKUCommonGUI/src/main/java/at/gv/egiz/bku/gui/HelpLinkFocusManager.java
index ad919146..751adf27 100644
--- a/BKUCommonGUI/src/main/java/at/gv/egiz/bku/gui/HelpLinkFocusManager.java
+++ b/BKUCommonGUI/src/main/java/at/gv/egiz/bku/gui/HelpLinkFocusManager.java
@@ -41,7 +41,7 @@ import javax.swing.text.StyleConstants;
 

 /**

  * 

- * @author Thomas Zefferer <thomas.zefferer@iaik.tugraz.at>

+ * @author Thomas Zefferer &lt;thomas.zefferer@iaik.tugraz.at&gt;

  */

 public final class HelpLinkFocusManager extends KeyAdapter { 

 

diff --git a/BKUCommonGUI/src/main/java/at/gv/egiz/bku/gui/HelpURLProvider.java b/BKUCommonGUI/src/main/java/at/gv/egiz/bku/gui/HelpURLProvider.java
index b35aea84..f8b992ae 100644
--- a/BKUCommonGUI/src/main/java/at/gv/egiz/bku/gui/HelpURLProvider.java
+++ b/BKUCommonGUI/src/main/java/at/gv/egiz/bku/gui/HelpURLProvider.java
@@ -30,7 +30,7 @@ package at.gv.egiz.bku.gui;
  * Make current context dependent help topic available (outside the applet).
  * Updated by the GUI whenever the current help topic changes.
  * 
- * @author Clemens Orthacker <clemens.orthacker@iaik.tugraz.at>
+ * @author Clemens Orthacker &lt;clemens.orthacker@iaik.tugraz.at&gt;
  */
 public interface HelpURLProvider {
 
diff --git a/BKUCommonGUI/src/main/java/at/gv/egiz/bku/gui/HelpViewer.java b/BKUCommonGUI/src/main/java/at/gv/egiz/bku/gui/HelpViewer.java
index bd016bca..af5d38e6 100644
--- a/BKUCommonGUI/src/main/java/at/gv/egiz/bku/gui/HelpViewer.java
+++ b/BKUCommonGUI/src/main/java/at/gv/egiz/bku/gui/HelpViewer.java
@@ -54,7 +54,7 @@ import org.slf4j.LoggerFactory;
 
 /**
  *
- * @author Clemens Orthacker <clemens.orthacker@iaik.tugraz.at>
+ * @author Clemens Orthacker &lt;clemens.orthacker@iaik.tugraz.at&gt;
  */
 public class HelpViewer extends JDialog
         implements ActionListener {
@@ -73,7 +73,6 @@ public class HelpViewer extends JDialog
    * 
    * @param ctx external links are opened via ctx.showDocument()
    * @param helpURL
-   * @param helpTopic
    * @param messages
    */
   public static void showHelpDialog(AppletContext ctx,
diff --git a/BKUCommonGUI/src/main/java/at/gv/egiz/bku/gui/HyperlinkRenderer.java b/BKUCommonGUI/src/main/java/at/gv/egiz/bku/gui/HyperlinkRenderer.java
index a861dafa..a2a4479e 100644
--- a/BKUCommonGUI/src/main/java/at/gv/egiz/bku/gui/HyperlinkRenderer.java
+++ b/BKUCommonGUI/src/main/java/at/gv/egiz/bku/gui/HyperlinkRenderer.java
@@ -30,7 +30,7 @@ import javax.swing.table.DefaultTableCellRenderer;
 
 /**
  *
- * @author Clemens Orthacker <clemens.orthacker@iaik.tugraz.at>
+ * @author Clemens Orthacker &lt;clemens.orthacker@iaik.tugraz.at&gt;
  */
 public class HyperlinkRenderer extends DefaultTableCellRenderer {
 
diff --git a/BKUCommonGUI/src/main/java/at/gv/egiz/bku/gui/ImagePanel.java b/BKUCommonGUI/src/main/java/at/gv/egiz/bku/gui/ImagePanel.java
index 87845123..7c4d7eb4 100644
--- a/BKUCommonGUI/src/main/java/at/gv/egiz/bku/gui/ImagePanel.java
+++ b/BKUCommonGUI/src/main/java/at/gv/egiz/bku/gui/ImagePanel.java
@@ -34,7 +34,7 @@ import javax.swing.JPanel;
 /**
  * paints the background image in the lower left corner of the component
  * 
- * @author Clemens Orthacker <clemens.orthacker@iaik.tugraz.at>
+ * @author Clemens Orthacker &lt;clemens.orthacker@iaik.tugraz.at&gt;
  */
 public class ImagePanel extends JPanel {
 
diff --git a/BKUCommonGUI/src/main/java/at/gv/egiz/bku/gui/SecureViewerDialog.java b/BKUCommonGUI/src/main/java/at/gv/egiz/bku/gui/SecureViewerDialog.java
index 45f68a5d..b3c1c69d 100644
--- a/BKUCommonGUI/src/main/java/at/gv/egiz/bku/gui/SecureViewerDialog.java
+++ b/BKUCommonGUI/src/main/java/at/gv/egiz/bku/gui/SecureViewerDialog.java
@@ -65,7 +65,7 @@ import org.slf4j.LoggerFactory;
 
 /**
  *
- * @author Clemens Orthacker <clemens.orthacker@iaik.tugraz.at>
+ * @author Clemens Orthacker &lt;clemens.orthacker@iaik.tugraz.at&gt;
  */
 public class SecureViewerDialog extends JDialog {
 
@@ -245,9 +245,6 @@ public class SecureViewerDialog extends JDialog {
    * Sets the hashdataInput to be displayed and makes the dialog visible.
    * This method blocks until the dialog's close button is pressed.
    * 
-   * @param mimeType defaults to text/plain if null
-   * @param encoding must be null if document contains charset declaration (e.g. HTML page), otherwise the parser crashes
-
    * @param hashDataInput
    */
   public void setContent(HashDataInput hashDataInput) { //throws FontProviderException {
diff --git a/BKUCommonGUI/src/main/java/at/gv/egiz/bku/gui/WindowCloseAdapter.java b/BKUCommonGUI/src/main/java/at/gv/egiz/bku/gui/WindowCloseAdapter.java
index 15fad038..dedeab39 100644
--- a/BKUCommonGUI/src/main/java/at/gv/egiz/bku/gui/WindowCloseAdapter.java
+++ b/BKUCommonGUI/src/main/java/at/gv/egiz/bku/gui/WindowCloseAdapter.java
@@ -33,7 +33,7 @@ import org.slf4j.LoggerFactory;
 
 /**
  *
- * @author Clemens Orthacker <clemens.orthacker@iaik.tugraz.at>
+ * @author Clemens Orthacker &lt;clemens.orthacker@iaik.tugraz.at&gt;
  */
 public class WindowCloseAdapter extends WindowAdapter {
 
diff --git a/BKUCommonGUI/src/main/java/at/gv/egiz/bku/gui/html/RestrictedHTMLEditorKit.java b/BKUCommonGUI/src/main/java/at/gv/egiz/bku/gui/html/RestrictedHTMLEditorKit.java
index 60f0e136..09cdec26 100644
--- a/BKUCommonGUI/src/main/java/at/gv/egiz/bku/gui/html/RestrictedHTMLEditorKit.java
+++ b/BKUCommonGUI/src/main/java/at/gv/egiz/bku/gui/html/RestrictedHTMLEditorKit.java
@@ -33,7 +33,7 @@ import javax.swing.text.html.HTMLEditorKit;
 
 /**
  *
- * @author Clemens Orthacker <clemens.orthacker@iaik.tugraz.at>
+ * @author Clemens Orthacker &lt;clemens.orthacker@iaik.tugraz.at&gt;
  */
 public class RestrictedHTMLEditorKit extends HTMLEditorKit {
   
diff --git a/BKUCommonGUI/src/main/java/at/gv/egiz/bku/gui/html/RestrictedImageView.java b/BKUCommonGUI/src/main/java/at/gv/egiz/bku/gui/html/RestrictedImageView.java
index 2b633139..e3cf2e59 100644
--- a/BKUCommonGUI/src/main/java/at/gv/egiz/bku/gui/html/RestrictedImageView.java
+++ b/BKUCommonGUI/src/main/java/at/gv/egiz/bku/gui/html/RestrictedImageView.java
@@ -30,7 +30,7 @@ import javax.swing.text.html.ImageView;
 
 /**
  *
- * @author Clemens Orthacker <clemens.orthacker@iaik.tugraz.at>
+ * @author Clemens Orthacker &lt;clemens.orthacker@iaik.tugraz.at&gt;
  */
 /**
    * ImageViewer.refreshImage() (and loadImage()) is private :-(
diff --git a/BKUCommonGUI/src/main/java/at/gv/egiz/bku/gui/viewer/FontProvider.java b/BKUCommonGUI/src/main/java/at/gv/egiz/bku/gui/viewer/FontProvider.java
index 49a72edb..fe597704 100644
--- a/BKUCommonGUI/src/main/java/at/gv/egiz/bku/gui/viewer/FontProvider.java
+++ b/BKUCommonGUI/src/main/java/at/gv/egiz/bku/gui/viewer/FontProvider.java
@@ -29,7 +29,7 @@ import java.awt.Font;
 
 /**
  *
- * @author Clemens Orthacker <clemens.orthacker@iaik.tugraz.at>
+ * @author Clemens Orthacker &lt;clemens.orthacker@iaik.tugraz.at&gt;
  */
 public interface FontProvider {
 
@@ -40,8 +40,7 @@ public interface FontProvider {
   /**
    *
    * @return
-   * @throws InterruptedException
-   * @throws FileNotFoundException if remote font file cannot be retrieved
+   * @throws FontProviderException if remote font file cannot be retrieved
    */
   Font getFont() throws FontProviderException;
 
diff --git a/BKUCommonGUI/src/main/java/at/gv/egiz/bku/gui/viewer/FontProviderException.java b/BKUCommonGUI/src/main/java/at/gv/egiz/bku/gui/viewer/FontProviderException.java
index b7d64ca5..1a0ba96b 100644
--- a/BKUCommonGUI/src/main/java/at/gv/egiz/bku/gui/viewer/FontProviderException.java
+++ b/BKUCommonGUI/src/main/java/at/gv/egiz/bku/gui/viewer/FontProviderException.java
@@ -27,7 +27,7 @@ package at.gv.egiz.bku.gui.viewer;
 
 /**
  * Encapsulates the reason why a font could not be loaded.
- * @author Clemens Orthacker <clemens.orthacker@iaik.tugraz.at>
+ * @author Clemens Orthacker &lt;clemens.orthacker@iaik.tugraz.at&gt;
  */
 public class FontProviderException extends Exception {
 
diff --git a/BKUCommonGUI/src/test/java/at/gv/egiz/bku/gui/DummyFontLoader.java b/BKUCommonGUI/src/test/java/at/gv/egiz/bku/gui/DummyFontLoader.java
index 11601878..b99d2e6d 100644
--- a/BKUCommonGUI/src/test/java/at/gv/egiz/bku/gui/DummyFontLoader.java
+++ b/BKUCommonGUI/src/test/java/at/gv/egiz/bku/gui/DummyFontLoader.java
@@ -34,7 +34,7 @@ import org.slf4j.LoggerFactory;
 
 /**
  *
- * @author Clemens Orthacker <clemens.orthacker@iaik.tugraz.at>
+ * @author Clemens Orthacker &lt;clemens.orthacker@iaik.tugraz.at&gt;
  */
 public class DummyFontLoader implements FontProvider {
 
diff --git a/BKUCommonGUI/src/test/java/at/gv/egiz/bku/gui/SimplePinInfo.java b/BKUCommonGUI/src/test/java/at/gv/egiz/bku/gui/SimplePinInfo.java
index 1d23d169..5cf392d4 100644
--- a/BKUCommonGUI/src/test/java/at/gv/egiz/bku/gui/SimplePinInfo.java
+++ b/BKUCommonGUI/src/test/java/at/gv/egiz/bku/gui/SimplePinInfo.java
@@ -30,7 +30,7 @@ import java.util.Locale;
 
 /**
  *
- * @author Clemens Orthacker <clemens.orthacker@iaik.tugraz.at>
+ * @author Clemens Orthacker &lt;clemens.orthacker@iaik.tugraz.at&gt;
  */
 public class SimplePinInfo extends PinInfo {