diff options
author | Dana Robinson <43805+derobins@users.noreply.github.com> | 2023-05-02 05:25:48 (GMT) |
---|---|---|
committer | GitHub <noreply@github.com> | 2023-05-02 05:25:48 (GMT) |
commit | 6eb021b68a8b46bbc89844713f014e6ba729ca7d (patch) | |
tree | 25a971cb952841ac796db4f72a4be850ac2ce437 /doxygen | |
parent | da46fdbf50984636aeac936386068939a3760fe4 (diff) | |
download | hdf5-6eb021b68a8b46bbc89844713f014e6ba729ca7d.zip hdf5-6eb021b68a8b46bbc89844713f014e6ba729ca7d.tar.gz hdf5-6eb021b68a8b46bbc89844713f014e6ba729ca7d.tar.bz2 |
Sync with develop (#2871)
Diffstat (limited to 'doxygen')
-rw-r--r-- | doxygen/aliases | 1 | ||||
-rw-r--r-- | doxygen/dox/LearnBasics2.dox | 2 | ||||
-rw-r--r-- | doxygen/dox/LearnBasics3.dox | 2 | ||||
-rw-r--r-- | doxygen/dox/ViewTools.dox | 2 | ||||
-rw-r--r-- | doxygen/examples/H5.format.1.0.html | 2 | ||||
-rw-r--r-- | doxygen/examples/H5.format.1.1.html | 2 | ||||
-rw-r--r-- | doxygen/examples/ImageSpec.html | 12 | ||||
-rw-r--r-- | doxygen/examples/tables/propertyLists.dox | 15 | ||||
-rw-r--r-- | doxygen/hdf5_navtree_hacks.js | 2 |
9 files changed, 26 insertions, 14 deletions
diff --git a/doxygen/aliases b/doxygen/aliases index 27090e6..96977f3 100644 --- a/doxygen/aliases +++ b/doxygen/aliases @@ -383,4 +383,5 @@ ALIASES += fortran_obsolete="Obsolete API, use the Fortran 2003 version instead. ALIASES += fortran_file="Pointer to filename the async subroutine is being called from, filename must be null character terminated" ALIASES += fortran_func="Pointer to function name the async subroutine is being called in, func must be null character terminated" ALIASES += fortran_line="Line number the async subroutine is being called at" +ALIASES += fortran_plist_id="Property list identifier" diff --git a/doxygen/dox/LearnBasics2.dox b/doxygen/dox/LearnBasics2.dox index 6f94c7f..87bbe87 100644 --- a/doxygen/dox/LearnBasics2.dox +++ b/doxygen/dox/LearnBasics2.dox @@ -788,7 +788,7 @@ The function #H5Tarray_create creates a new array datatype object. Parameters sp \li the dimension permutation of the array, i.e., whether the elements of the array are listed in C or FORTRAN order. <h4>Working with existing array datatypes</h4> -When working with existing arrays, one must first determine the the rank, or number of dimensions, of the array. +When working with existing arrays, one must first determine the rank, or number of dimensions, of the array. The function #H5Tget_array_dims returns the rank of a specified array datatype. diff --git a/doxygen/dox/LearnBasics3.dox b/doxygen/dox/LearnBasics3.dox index 2fe0f52..06afacd 100644 --- a/doxygen/dox/LearnBasics3.dox +++ b/doxygen/dox/LearnBasics3.dox @@ -210,7 +210,7 @@ For details on compiling an HDF5 application: an extendible array dataset, pass in #H5P_DATASET_CREATE for the property list class. \li The #H5Pset_chunk call modifies a Dataset Creation Property List instance to store a chunked layout dataset and sets the size of the chunks used. -\li To extend an unlimited dimension dataset use the the #H5Dset_extent call. Please be aware that +\li To extend an unlimited dimension dataset use the #H5Dset_extent call. Please be aware that after this call, the dataset's dataspace must be refreshed with #H5Dget_space before more data can be accessed. \li The #H5Pget_chunk call retrieves the size of chunks for the raw data of a chunked layout dataset. \li Once there is no longer a need for a Property List instance, it should be closed with the #H5Pclose call. diff --git a/doxygen/dox/ViewTools.dox b/doxygen/dox/ViewTools.dox index 2212d4b..66b2def 100644 --- a/doxygen/dox/ViewTools.dox +++ b/doxygen/dox/ViewTools.dox @@ -465,7 +465,7 @@ example <code style="background-color:whitesmoke;">h5_crtgrpar.c</code>. To disp \endcode \subsubsection subsubsecViewToolsViewDset_h5dumpEx5 Example 5 -The <code style="background-color:whitesmoke;">-p</code> option is used to examine the the dataset filters, storage layout, and fill value properties of a dataset. +The <code style="background-color:whitesmoke;">-p</code> option is used to examine the dataset filters, storage layout, and fill value properties of a dataset. This option can be useful for checking how well compression works, or even for analyzing performance and dataset size issues related to chunking. (The smaller the chunk size, the more chunks that HDF5 diff --git a/doxygen/examples/H5.format.1.0.html b/doxygen/examples/H5.format.1.0.html index 4eb0548..26d0421 100644 --- a/doxygen/examples/H5.format.1.0.html +++ b/doxygen/examples/H5.format.1.0.html @@ -1488,7 +1488,7 @@ Elena> "Free-space object" </tr> <tr valign=top> - <td>Object Size</td> <td>This is the size of the the fields + <td>Object Size</td> <td>This is the size of the fields above plus the object data stored for the object. The actual storage size is rounded up to a multiple of eight.</td> diff --git a/doxygen/examples/H5.format.1.1.html b/doxygen/examples/H5.format.1.1.html index 9d03a76..3af50d6 100644 --- a/doxygen/examples/H5.format.1.1.html +++ b/doxygen/examples/H5.format.1.1.html @@ -6091,7 +6091,7 @@ TABLE.list TD { border:none; } <td>Used by the library before version 1.6.1. In this version, the Flags field is used to indicate whether the actual message is stored in the global heap (never implemented). The Pointer field - either contains the the header message address in the global heap + either contains the header message address in the global heap (never implemented) or the address of the shared object header.</td> </tr> </table> diff --git a/doxygen/examples/ImageSpec.html b/doxygen/examples/ImageSpec.html index 1b700ff..130d86e 100644 --- a/doxygen/examples/ImageSpec.html +++ b/doxygen/examples/ImageSpec.html @@ -851,7 +851,7 @@ This defines the color model that the entries in the palette data set represent. "RGB"</dt> <dd> -Each color index contains a triplet where the the first value defines the +Each color index contains a triplet where the first value defines the red component, second defines the green component, and the third the blue component.</dd> @@ -859,7 +859,7 @@ component.</dd> "CMY"</dt> <dd> -Each color index contains a triplet where the the first value defines the +Each color index contains a triplet where the first value defines the cyan component, second defines the magenta component, and the third the yellow component.</dd> @@ -867,7 +867,7 @@ yellow component.</dd> "CMYK"</dt> <dd> -Each color index contains a quadruplet where the the first value defines +Each color index contains a quadruplet where the first value defines the cyan component, second defines the magenta component, the third the yellow component, and the forth the black component.</dd> @@ -875,7 +875,7 @@ yellow component, and the forth the black component.</dd> "YCbCr"</dt> <dd> -Class Y encoding model. Each color index contains a triplet where the the +Class Y encoding model. Each color index contains a triplet where the first value defines the luminance, second defines the Cb Chromonance, and the third the Cr Chromonance.</dd> @@ -884,14 +884,14 @@ the third the Cr Chromonance.</dd> <dd> Composite encoding color model. Each color index contains a triplet where -the the first value defines the luminance component, second defines the +the first value defines the luminance component, second defines the chromonance component, and the third the value component.</dd> <dt> "HSV"</dt> <dd> -Each color index contains a triplet where the the first value defines the +Each color index contains a triplet where the first value defines the hue component, second defines the saturation component, and the third the value component. The hue component defines the hue spectrum with a low value representing magenta/red progressing to a high value which would diff --git a/doxygen/examples/tables/propertyLists.dox b/doxygen/examples/tables/propertyLists.dox index 375fd50..a260c9d 100644 --- a/doxygen/examples/tables/propertyLists.dox +++ b/doxygen/examples/tables/propertyLists.dox @@ -245,7 +245,7 @@ file access property list.</td> </tr> <tr> <td>#H5Pset_page_buffer_size/#H5Pget_page_buffer_size</td> -<td>Set/get the the maximum size for the page buffer.</td> +<td>Set/get the maximum size for the page buffer.</td> </tr> <tr> <td>#H5Pset_sieve_buf_size/#H5Pget_sieve_buf_size</td> @@ -694,6 +694,18 @@ of the library for reading or writing the actual data.</td> <td>Gets local and global causes that broke collective I/O on the last parallel I/O call.</td> </tr> <tr> +<td>#H5Pset_selection_io/#H5Pget_selection_io</td> +<td>Sets/gets the selection I/O mode.</td> +</tr> +<tr> +<td>#H5Pget_no_selection_io_cause</td> +<td>Gets the cause for not performing selection or vector I/O on the last parallel I/O call.</td> +</tr> +<tr> +<td>#H5Pset_modify_write_buf/#H5Pget_modify_write_buf</td> +<td>Sets/gets a flag allowing the library to modify the contents of the write buffer.</td> +</tr> +<tr> <td>H5Pset_preserve/H5Pget_preserve</td> <td>No longer available, deprecated as it no longer has any effect.</td> </tr> @@ -952,4 +964,3 @@ encoding for object names.</td> //! [acpl_table] * */ -
\ No newline at end of file diff --git a/doxygen/hdf5_navtree_hacks.js b/doxygen/hdf5_navtree_hacks.js index dda8984..804701f 100644 --- a/doxygen/hdf5_navtree_hacks.js +++ b/doxygen/hdf5_navtree_hacks.js @@ -141,7 +141,7 @@ function initNavTree(toroot,relpath) $(window).on("load", showRoot); } -// return false if the the node has no children at all, or has only section/subsection children +// return false if the node has no children at all, or has only section/subsection children function checkChildrenData(node) { if (!(typeof(node.childrenData)==='string')) { for (var i in node.childrenData) { |