Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix javadoc comment warnings #170

Merged
merged 4 commits into from
Dec 4, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 20 additions & 4 deletions src/org.hdfgroup.hdfview/hdf/HDFVersions.java
Original file line number Diff line number Diff line change
Expand Up @@ -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"); }
}
6 changes: 5 additions & 1 deletion src/org.hdfgroup.hdfview/hdf/view/DataView/DataView.java
Original file line number Diff line number Diff line change
Expand Up @@ -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();
}
Original file line number Diff line number Diff line change
Expand Up @@ -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();

/**
Expand Down
88 changes: 70 additions & 18 deletions src/org.hdfgroup.hdfview/hdf/view/DefaultFileFilter.java
Original file line number Diff line number Diff line change
Expand Up @@ -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()
Expand Down Expand Up @@ -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()
{
Expand Down Expand Up @@ -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
Expand All @@ -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();
Expand All @@ -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();
Expand All @@ -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();
Expand All @@ -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();
Expand All @@ -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();
Expand All @@ -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();
Expand All @@ -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();
Expand All @@ -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();
Expand All @@ -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();
Expand All @@ -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();
Expand All @@ -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();
Expand Down
17 changes: 13 additions & 4 deletions src/org.hdfgroup.hdfview/hdf/view/HDFView.java
Original file line number Diff line number Diff line change
Expand Up @@ -295,7 +295,7 @@ public HDFView(String root, String start_dir)
}

if (FileFormat.getFileFormat(FileFormat.FILE_TYPE_HDF5) != null)
H5.H5PLappend(ViewProperties.getPluginDir());
ViewProperties.loadPluginPaths();

treeViews = ViewProperties.getTreeViewList();
metaDataViews = ViewProperties.getMetaDataViewList();
Expand Down Expand Up @@ -937,9 +937,6 @@ public void widgetSelected(SelectionEvent e)
// currentDir until isWorkDirChanged() is fixed
currentDir = ViewProperties.getWorkDir();

if (FileFormat.getFileFormat(FileFormat.FILE_TYPE_HDF5) != null)
H5.H5PLappend(ViewProperties.getPluginDir());

// if (userOptionDialog.isFontChanged()) {
Font font = null;

Expand Down Expand Up @@ -1381,26 +1378,36 @@ public void drop(DropTargetEvent e)
}

/**
* Get a list of treeview implementations.
*
* @return a list of treeview implementations.
*/
public static final List<String> getListOfTreeViews() { return treeViews; }

/**
* Get a list of imageview implementations.
*
* @return a list of imageview implementations.
*/
public static final List<String> getListOfImageViews() { return imageViews; }

/**
* Get a list of tableview implementations.
*
* @return a list of tableview implementations.
*/
public static final List<?> getListOfTableViews() { return tableViews; }

/**
* Get a list of metaDataview implementations.
*
* @return a list of metaDataview implementations.
*/
public static final List<?> getListOfMetaDataViews() { return metaDataViews; }

/**
* Get a list of paletteview implementations.
*
* @return a list of paletteview implementations.
*/
public static final List<?> getListOfPaletteViews() { return paletteViews; }
Expand All @@ -1412,6 +1419,8 @@ public TreeView getTreeView()
}

/**
* Get the combobox associated with a URL entry.
*
* @return the combobox associated with a URL entry.
*/
public Combo getUrlBar() { return urlBar; }
Expand Down
11 changes: 8 additions & 3 deletions src/org.hdfgroup.hdfview/hdf/view/HelpView/HelpView.java
Original file line number Diff line number Diff line change
Expand Up @@ -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();
}
36 changes: 30 additions & 6 deletions src/org.hdfgroup.hdfview/hdf/view/ImageView/ImageView.java
Original file line number Diff line number Diff line change
Expand Up @@ -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();

/**
Expand All @@ -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();

/**
Expand All @@ -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();
}
Loading