Merge branch 'develop' into feature/coding_standardsfeature/coding_standards

1 files changed, 35 insertions, 12 deletions

diff --git a/java/src/hdf/hdf5lib/structs/H5F_info2_t.java b/java/src/hdf/hdf5lib/structs/H5F_info2_t.java
index 4664b5b..78e6d6c 100644
--- a/java/src/hdf/hdf5lib/structs/H5F_info2_t.java
+++ b/java/src/hdf/hdf5lib/structs/H5F_info2_t.java
@@ -1,12 +1,11 @@
 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
  * Copyright by The HDF Group.                                               *
- * Copyright by the Board of Trustees of the University of Illinois.         *
  * All rights reserved.                                                      *
  *                                                                           *
  * This file is part of HDF5.  The full HDF5 copyright notice, including     *
  * terms governing use, modification, and redistribution, is contained in    *
  * the COPYING file, which can be found at the root of the source code       *
- * distribution tree, or in https://support.hdfgroup.org/ftp/HDF5/releases.  *
+ * distribution tree, or in https://www.hdfgroup.org/licenses.               *
  * If you do not have access to either file, you may request a copy from     *
  * help@hdfgroup.org.                                                        *
  * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
@@ -15,19 +14,43 @@ package hdf.hdf5lib.structs;
 
 import java.io.Serializable;
 
-//Information struct for object (for H5Fget_info)
+/**
+ * Information struct for object (for H5Fget_info)
+ *
+ */
 public class H5F_info2_t implements Serializable{
     private static final long serialVersionUID = 4691681162544054518L;
-    public int         super_version;    // Superblock version #
-    public long        super_size;    // Superblock size
-    public long        super_ext_size;    // Superblock extension size
-    public int         free_version;    // Version # of file free space management
-    public long        free_meta_size;    // Free space manager metadata size
-    public long        free_tot_space;    // Amount of free space in the file
-    public int         sohm_version;    // Version # of shared object header info
-    public long        sohm_hdr_size;       // Shared object header message header size
-    public H5_ih_info_t    sohm_msgs_info;      // Shared object header message index & heap size
+    /** Superblock version number */
+    public int         super_version;
+    /** Superblock size */
+    public long        super_size;
+    /** Superblock extension size */
+    public long        super_ext_size;
+    /** Version number of file free space management */
+    public int         free_version;
+    /** Free space manager metadata size */
+    public long        free_meta_size;
+    /** Amount of free space in the file */
+    public long        free_tot_space;
+    /** Version number of shared object header info */
+    public int         sohm_version;
+    /** Shared object header message header size */
+    public long        sohm_hdr_size;
+    /** Shared object header message index and heap size */
+    public H5_ih_info_t    sohm_msgs_info;
 
+    /**
+     * Constructor for current "global" information about file
+     * @param super_version: Superblock version number
+     * @param super_size: Superblock size
+     * @param super_ext_size: Superblock extension size
+     * @param free_version: Version number of file free space management
+     * @param free_meta_size: Free space manager metadata size
+     * @param free_tot_space: Amount of free space in the file
+     * @param sohm_version: Version number of shared object header info
+     * @param sohm_hdr_size: Shared object header message header size
+     * @param sohm_msgs_info: Shared object header message index and heap size
+     */
     public H5F_info2_t (int super_version, long super_size, long super_ext_size,
         int free_version, long free_meta_size, long free_tot_space,
         int sohm_version, long sohm_hdr_size, H5_ih_info_t sohm_msgs_info)