Fix Javadoc issues

Author: ksugar

src/main/java/au/id/mcc/adapted/swing/SVGIcon.java

@@ -53,6 +53,7 @@ public class SVGIcon extends UserAgentAdapter implements Icon {
     /**
      * Create a new SVGIcon object.
      * @param uri The URI to read the SVG document from.
+     * @throws TranscoderException if an error occurred while transcoding the SVG document
      */
     public SVGIcon(String uri) throws TranscoderException {
         this(uri, 0, 0);
@@ -63,6 +64,7 @@ public SVGIcon(String uri) throws TranscoderException {
      * @param uri The URI to read the SVG document from.
      * @param w The width of the icon.
      * @param h The height of the icon.
+     * @throws TranscoderException if an error occurred while transcoding the SVG document
      */
     public SVGIcon(String uri, int w, int h) throws TranscoderException {
         generateBufferedImage(new TranscoderInput(uri), w, h);
@@ -71,6 +73,7 @@ public SVGIcon(String uri, int w, int h) throws TranscoderException {
     /**
      * Create a new SVGIcon object.
      * @param doc The SVG document.
+     * @throws TranscoderException if an error occurred while transcoding the SVG document
      */
     public SVGIcon(Document doc) throws TranscoderException {
         this(doc, 0, 0);
@@ -81,13 +84,18 @@ public SVGIcon(Document doc) throws TranscoderException {
      * @param doc The SVG document.
      * @param w The width of the icon.
      * @param h The height of the icon.
+     * @throws TranscoderException if an error occurred while transcoding the SVG document
      */
     public SVGIcon(Document doc, int w, int h) throws TranscoderException {
         generateBufferedImage(new TranscoderInput(doc), w, h);
     }
 
     /**
      * Generate the BufferedImage.
+     * @param in the TranscoderInput to read the SVG document from
+     * @param w the width of the icon
+     * @param h the height of the icon
+     * @throws TranscoderException if an error occurred while transcoding the SVG document
      */
     protected void generateBufferedImage(TranscoderInput in, int w, int h)
             throws TranscoderException {
@@ -133,13 +141,16 @@ public void writeImage(BufferedImage img, TranscoderOutput output)
 
         /**
          * Returns the BufferedImage generated from the SVG document.
+         * @return the BufferedImage generated from the SVG document
          */
         public BufferedImage getBufferedImage() {
             return bufferedImage;
         }
 
         /**
          * Set the dimensions to be used for the image.
+         * @param w the width of the image
+         * @param h the height of the image
          */
         public void setDimensions(int w, int h) {
             hints.put(KEY_WIDTH, new Float(w));

src/main/java/org/elephant/Elephant.java

@@ -577,6 +577,8 @@ public void setExitOnClose()
 
 	/**
 	 * Main method
+	 * @param args
+	 * @throws Exception
 	 */
 	public static void main( final String[] args ) throws Exception
 	{

src/main/java/org/elephant/actions/ChangeTagDialog.java

@@ -70,6 +70,14 @@ public class ChangeTagDialog extends JDialog implements ElephantConstantsMixin
 
 	/**
 	 * Create a dialog.
+	 * @param tagSetNames the names of tag sets to be shown in the combo boxes for tag set selection
+	 * @param tagNamesDetection the names of tags in the detection tag set to be shown in the combo boxes for tag selection when the detection tag set is selected
+	 * @param tagNamesTracking the names of tags in the tracking tag set to be shown in the combo boxes for tag selection when the tracking tag set is selected
+	 * @param tagNamesProgenitor the names of tags in the
+	 * @param tagNamesStatus the names of tags in the status tag set to be shown in the combo boxes for tag selection when the status tag set is selected
+	 * progenitor tag set to be shown in the combo boxes for tag selection when the progenitor tag set is selected
+	 * @param tagNamesProliferator the names of tags in the proliferator tag set to be shown in the combo boxes for tag selection when the proliferator tag set is selected
+	 * @param tagNamesDivision the names of tags in the division tag
 	 */
 	public ChangeTagDialog( final String[] tagSetNames, final String[] tagNamesDetection, final String[] tagNamesTracking,
 			final String[] tagNamesProgenitor, final String[] tagNamesStatus, final String[] tagNamesProliferator, final String[] tagNamesDivision )

src/main/java/org/elephant/actions/RecordSnapshotMovieDialog.java

@@ -88,6 +88,8 @@ void put( String value )
 
 	/**
 	 * Create the dialog.
+	 * @param windowNames the names of windows to be shown in the combo box for window selection
+	 * @param maxTimepoint the maximum timepoint to be set as the maximum value of
 	 */
 	public RecordSnapshotMovieDialog( final String[] windowNames, final int maxTimepoint )
 	{

src/main/java/org/elephant/actions/SelectSingleTagDialog.java

@@ -66,6 +66,13 @@ public class SelectSingleTagDialog extends JDialog implements ElephantConstantsM
 
 	/**
 	 * Create a dialog.
+	 * @param tagSetNames the names of tag sets to be shown in the combo boxes for tag set selection
+	 * @param tagNamesDetection the names of tags in the detection tag set to be shown in the combo boxes for tag selection when the detection tag set is selected
+	 * @param tagNamesTracking the names of tags in the tracking tag set to be shown in the combo boxes for tag selection when the tracking tag set is selected
+	 * @param tagNamesProgenitor the names of tags in the progenitor tag set to be shown in the combo boxes for tag selection when the progenitor tag set is selected
+	 * @param tagNamesStatus the names of tags in the status tag set to be shown in the combo boxes for tag selection when the status tag set is selected
+	 * @param tagNamesProliferator the names of tags in the proliferator tag set to be shown in the combo boxes for tag selection when the proliferator tag set is selected
+	 * @param tagNamesDivision the names of tags in the division tag set to be shown in the combo boxes for tag selection when the division tag set is selected
 	 */
 	public SelectSingleTagDialog( final String[] tagSetNames, final String[] tagNamesDetection, final String[] tagNamesTracking,
 			final String[] tagNamesProgenitor, final String[] tagNamesStatus, final String[] tagNamesProliferator, final String[] tagNamesDivision )

src/main/java/org/elephant/actions/SnapshotDialog.java

@@ -82,6 +82,7 @@ void put( String value )
 
 	/**
 	 * Create the dialog.
+	 * @param windowNames the names of windows to be shown in the combo box for window selection
 	 */
 	public SnapshotDialog( final String[] windowNames )
 	{

src/main/java/org/elephant/actions/mixins/SpatioTemporalIndexActionMinxin.java

@@ -30,7 +30,7 @@
 import org.mastodon.spatial.SpatioTemporalIndex;
 
 /**
- * Provide {@link SpatioTemporalIndex< Spot >}.
+ * Provide access to {@link SpatioTemporalIndex}.
  * 
  * @author Ko Sugawara
  */