fix javadoc comment warnings (#170)

Author: byrnHDF

src/org.hdfgroup.hdfview/hdf/HDFVersions.java

@@ -21,15 +21,31 @@ public class HDFVersions {
         }
     }
 
-    /** @return the property to track the current versions of java */
+    /**
+     * Get the property to track the current versions of java
+     *
+     * @return the property to track the current versions of java
+     */
     public static String getPropertyVersionJava() { return props.getProperty("JAVA_VERSION"); }
 
-    /** @return the property to track the current versions of hdf4 */
+    /**
+     * Get the property to track the current versions of hdf4
+     *
+     * @return the property to track the current versions of hdf4
+     */
     public static String getPropertyVersionHDF4() { return props.getProperty("HDF4_VERSION"); }
 
-    /** @return the property to track the current versions of hdf5 */
+    /**
+     * Get the property to track the current versions of hdf5
+     *
+     * @return the property to track the current versions of hdf5
+     */
     public static String getPropertyVersionHDF5() { return props.getProperty("HDF5_VERSION"); }
 
-    /** @return the property to track the current versions of hdfview */
+    /**
+     * Get the property to track the current versions of hdfview
+     *
+     * @return the property to track the current versions of hdfview
+     */
     public static String getPropertyVersionView() { return props.getProperty("HDFVIEW_VERSION"); }
 }

src/org.hdfgroup.hdfview/hdf/view/DataView/DataView.java

@@ -32,6 +32,10 @@ public abstract interface DataView {
     /** The image view type */
     public static final int DATAVIEW_IMAGE = 2;
 
-    /** @return the data object displayed in this data viewer */
+    /**
+     * Get the data object displayed in this data viewer
+     *
+     * @return the data object displayed in this data viewer
+     */
     public abstract HObject getDataObject();
 }

src/org.hdfgroup.hdfview/hdf/view/DataView/DataViewManager.java

@@ -67,7 +67,11 @@ public abstract interface DataViewManager {
      */
     public abstract void showError(String errMsg);
 
-    /** @return the current TreeView */
+    /**
+     * Get the current TreeView
+     *
+     * @return the current TreeView
+     */
     public abstract TreeView getTreeView();
 
     /**

src/org.hdfgroup.hdfview/hdf/view/DefaultFileFilter.java

@@ -112,6 +112,8 @@ public DefaultFileFilter(String[] filters, String description)
     }
 
     /**
+     * Get the file extensions associated with this DefaultFileFilter
+     *
      * @return the file extensions associated with this DefaultFileFilter
      */
     public String getExtensions()
@@ -160,8 +162,10 @@ public void addExtension(String extension)
     }
 
     /**
-     * @return the human readable description of this filter. For example:
-     * "JPEG and GIF Image Files (*.jpg, *.gif)"
+     * Get the human readable description of this filter. For example: "JPEG and GIF Image Files (*.jpg,
+     * *.gif)"
+     *
+     * @return the human readable description of this filter.
      */
     public String getDescription()
     {
@@ -220,15 +224,19 @@ public void setExtensionListInDescription(boolean b)
     }
 
     /**
-     * @return whether the extension list (.jpg, .gif, etc) should show up in
-     * the human readable description.
+     * Check if the extension list (.jpg, .gif, etc) should show up in the human readable description.
      *
-     * Only relevent if a description was provided in the constructor or using
-     * setDescription();
+     * @return whether the extension list (.jpg, .gif, etc) should show up in the human readable description.
+     *
+     *         Only relevent if a description was provided in the constructor or using setDescription();
      */
     public boolean isExtensionListInDescription() { return useExtensionsInDescription; }
 
-    /** @return a file filter for HDF4/5 file. */
+    /**
+     * Get the file filter for HDF4/5 file
+     *
+     * @return a file filter for HDF4/5 file.
+     */
     public static DefaultFileFilter getFileFilter()
     {
         // update extensions
@@ -242,7 +250,11 @@ public static DefaultFileFilter getFileFilter()
         return filter;
     }
 
-    /** @return a file filter for NetCDF3 file. */
+    /**
+     * Get a file filter for NetCDF3 file
+     *
+     * @return a file filter for NetCDF3 file.
+     */
     public static DefaultFileFilter getFileFilterNetCDF3()
     {
         DefaultFileFilter filter = new DefaultFileFilter();
@@ -252,7 +264,11 @@ public static DefaultFileFilter getFileFilterNetCDF3()
         return filter;
     }
 
-    /** @return a file filter for HDF4 file. */
+    /**
+     * Get a file filter for HDF4 file
+     *
+     * @return a file filter for HDF4 file.
+     */
     public static DefaultFileFilter getFileFilterHDF4()
     {
         DefaultFileFilter filter = new DefaultFileFilter();
@@ -264,7 +280,11 @@ public static DefaultFileFilter getFileFilterHDF4()
         return filter;
     }
 
-    /** @return a file filter for HDF5 file. */
+    /**
+     * Get a file filter for HDF5 file
+     *
+     * @return a file filter for HDF5 file.
+     */
     public static DefaultFileFilter getFileFilterHDF5()
     {
         DefaultFileFilter filter = new DefaultFileFilter();
@@ -275,7 +295,11 @@ public static DefaultFileFilter getFileFilterHDF5()
         return filter;
     }
 
-    /** @return a file filter for JPEG image files. */
+    /**
+     * Get a file filter for JPEG image files
+     *
+     * @return a file filter for JPEG image files.
+     */
     public static DefaultFileFilter getFileFilterJPEG()
     {
         DefaultFileFilter filter = new DefaultFileFilter();
@@ -290,7 +314,11 @@ public static DefaultFileFilter getFileFilterJPEG()
         return filter;
     }
 
-    /** @return a file filter for TIFF image files. */
+    /**
+     * Get a file filter for TIFF image files
+     *
+     * @return a file filter for TIFF image files.
+     */
     public static DefaultFileFilter getFileFilterTIFF()
     {
         DefaultFileFilter filter = new DefaultFileFilter();
@@ -301,7 +329,11 @@ public static DefaultFileFilter getFileFilterTIFF()
         return filter;
     }
 
-    /** @return a file filter for PNG image files. */
+    /**
+     * Get a file filter for PNG image files
+     *
+     * @return a file filter for PNG image files.
+     */
     public static DefaultFileFilter getFileFilterPNG()
     {
         DefaultFileFilter filter = new DefaultFileFilter();
@@ -311,7 +343,11 @@ public static DefaultFileFilter getFileFilterPNG()
         return filter;
     }
 
-    /** @return a file filter for BMP image files. */
+    /**
+     * Get a file filter for BMP image files
+     *
+     * @return a file filter for BMP image files.
+     */
     public static DefaultFileFilter getFileFilterBMP()
     {
         DefaultFileFilter filter = new DefaultFileFilter();
@@ -322,7 +358,11 @@ public static DefaultFileFilter getFileFilterBMP()
         return filter;
     }
 
-    /** @return a file filter for GIF image files. */
+    /**
+     * Get a file filter for GIF image files
+     *
+     * @return a file filter for GIF image files.
+     */
     public static DefaultFileFilter getFileFilterGIF()
     {
         DefaultFileFilter filter = new DefaultFileFilter();
@@ -332,7 +372,11 @@ public static DefaultFileFilter getFileFilterGIF()
         return filter;
     }
 
-    /** @return a file filter for GIF, JPEG, BMP, or PNG image files. */
+    /**
+     * Get a file filter for GIF, JPEG, BMP, or PNG image files
+     *
+     * @return a file filter for GIF, JPEG, BMP, or PNG image files.
+     */
     public static DefaultFileFilter getImageFileFilter()
     {
         DefaultFileFilter filter = new DefaultFileFilter();
@@ -351,7 +395,11 @@ public static DefaultFileFilter getImageFileFilter()
         return filter;
     }
 
-    /** @return a file filter for text file. */
+    /**
+     * Get a file filter for text file
+     *
+     * @return a file filter for text file.
+     */
     public static DefaultFileFilter getFileFilterText()
     {
         DefaultFileFilter filter = new DefaultFileFilter();
@@ -362,7 +410,11 @@ public static DefaultFileFilter getFileFilterText()
         return filter;
     }
 
-    /** @return a file filter for binary file. */
+    /**
+     * Get a file filter for binary file
+     *
+     * @return a file filter for binary file.
+     */
     public static DefaultFileFilter getFileFilterBinary()
     {
         DefaultFileFilter filter = new DefaultFileFilter();

src/org.hdfgroup.hdfview/hdf/view/HelpView/HelpView.java

@@ -26,11 +26,16 @@ public abstract interface HelpView {
     public abstract void show();
 
     /**
-     * @return the HelpView's label, which is displayed in the HDFView
-     * help menu.
+     * Get the HelpView's label, which is displayed in the HDFView help menu.
+     *
+     * @return the HelpView's label
      */
     public abstract String getLabel();
 
-    /** @return the action command for this HelpView. */
+    /**
+     * Get the action command for this HelpView.
+     *
+     * @return the action command for this HelpView.
+     */
     public abstract String getActionCommand();
 }

src/org.hdfgroup.hdfview/hdf/view/ImageView/ImageView.java

@@ -33,16 +33,32 @@ public abstract interface ImageView extends DataView {
      */
     public abstract Rectangle getSelectedArea();
 
-    /** @return true if the image is a truecolor image. */
+    /**
+     * Check if the image is a truecolor image.
+     *
+     * @return true if the image is a truecolor image.
+     */
     public abstract boolean isTrueColor();
 
-    /** @return true if the image interlace is plane interlace. */
+    /**
+     * Check if the image interlace is plane interlace.
+     *
+     * @return true if the image interlace is plane interlace.
+     */
     public abstract boolean isPlaneInterlace();
 
-    /** @return array of selected data */
+    /**
+     * Get the array of selected data
+     *
+     * @return array of selected data
+     */
     public abstract Object getSelectedData();
 
-    /** @return the image displayed in this imageView */
+    /**
+     * Get the image displayed in this imageView
+     *
+     * @return the image displayed in this imageView
+     */
     public abstract Image getImage();
 
     /**
@@ -52,7 +68,11 @@ public abstract interface ImageView extends DataView {
      */
     public abstract void setImage(Image img);
 
-    /** @return the palette of the image */
+    /**
+     * Get the palette of the image
+     *
+     * @return the palette of the image
+     */
     public abstract byte[][] getPalette();
 
     /**
@@ -62,6 +82,10 @@ public abstract interface ImageView extends DataView {
      */
     public abstract void setPalette(byte[][] palette);
 
-    /** @return the byte array of the image data */
+    /**
+     * Get the byte array of the image data
+     *
+     * @return the byte array of the image data
+     */
     public abstract byte[] getImageByteData();
 }

src/org.hdfgroup.hdfview/hdf/view/TableView/DataProviderFactory.java

@@ -565,7 +565,9 @@ public int getRowCount()
         public final void setIsValueChanged(boolean isChanged) { isValueChanged = isChanged; }
 
         /**
-         * @return if the datavalue has chaged
+         * Check if the datavalue has changed
+         *
+         * @return if the datavalue has changed
          */
         public final boolean getIsValueChanged() { return isValueChanged; }
 

src/org.hdfgroup.hdfview/hdf/view/TableView/DefaultBaseTableView.java

@@ -1268,13 +1268,23 @@ public int getSelectedColumnCount()
         return selectionLayer.getSelectedColumnPositions().length;
     }
 
-    /** @return the selection layer */
+    /**
+     * Get the selection layer
+     *
+     * @return the selection layer
+     */
     public SelectionLayer getSelectionLayer() { return selectionLayer; }
 
-    /** @return the data layer */
+    /**
+     * Get the data layer
+     *
+     * @return the data layer
+     */
     public DataLayer getDataLayer() { return dataLayer; }
 
-    /** refresh the data table */
+    /**
+     * refresh the data table
+     */
     @Override
     public void refreshDataTable()
     {
@@ -2821,7 +2831,7 @@ public void open()
             colButton = new Button(content, SWT.RADIO);
             colButton.setFont(curFont);
             colButton.setText("Column");
-            colButton.setLayoutData(new GridData(SWT.CENTER, SWT.FILL, false, false));
+            colButton.setLayoutData(new GridData(SWT.FILL, SWT.FILL, false, false));
             colButton.addSelectionListener(new SelectionAdapter() {
                 @Override
                 public void widgetSelected(SelectionEvent e)
@@ -2834,7 +2844,7 @@ public void widgetSelected(SelectionEvent e)
             rowButton = new Button(content, SWT.RADIO);
             rowButton.setFont(curFont);
             rowButton.setText("Row");
-            rowButton.setLayoutData(new GridData(SWT.CENTER, SWT.FILL, false, false));
+            rowButton.setLayoutData(new GridData(SWT.FILL, SWT.FILL, false, false));
             rowButton.addSelectionListener(new SelectionAdapter() {
                 @Override
                 public void widgetSelected(SelectionEvent e)