Skip to content

Commit

Permalink
Remove most unused options which are defaulted #2998 (#3047)
Browse files Browse the repository at this point in the history
  • Loading branch information
byrnHDF authored Jun 5, 2023
1 parent 36a2a8d commit 2b278e2
Show file tree
Hide file tree
Showing 13 changed files with 21 additions and 915 deletions.
6 changes: 4 additions & 2 deletions configure.ac
Original file line number Diff line number Diff line change
Expand Up @@ -1225,9 +1225,11 @@ if test "X$HDF5_DOXYGEN" = "Xyes"; then
DOXYGEN_PACKAGE=${PACKAGE_NAME}
DOXYGEN_VERSION_STRING=${PACKAGE_VERSION}
DOXYGEN_DIR='$(SRCDIR)/doxygen'
DOXYGEN_INCLUDE_ALIASES_PATH='$(SRCDIR)/doxygen'
DOXYGEN_INCLUDE_ALIASES='$(SRCDIR)/doxygen/aliases'
DOXYGEN_VERBATIM_VARS='DOXYGEN_INCLUDE_ALIASES'
DOXYGEN_PROJECT_LOGO='$(SRCDIR)/doxygen/img/HDFG-logo.png'
DOXYGEN_PROJECT_BRIEF=''
DOXYGEN_PROJECT_BRIEF='API Reference'
DOXYGEN_INPUT_DIRECTORY='$(SRCDIR) $(SRCDIR)/doxygen/dox'
DOXYGEN_OPTIMIZE_OUTPUT_FOR_C=YES
DOXYGEN_MACRO_EXPANSION=YES
Expand All @@ -1244,7 +1246,7 @@ if test "X$HDF5_DOXYGEN" = "Xyes"; then
DOXYGEN_SEARCHENGINE_URL=
DOXYGEN_STRIP_FROM_PATH='$(SRCDIR)'
DOXYGEN_STRIP_FROM_INC_PATH='$(SRCDIR)'
DOXYGEN_PREDEFINED='H5_HAVE_DIRECT H5_HAVE_LIBHDFS H5_HAVE_MAP_API H5_HAVE_PARALLEL H5_HAVE_ROS3_VFD H5_DOXYGEN_FORTRAN'
DOXYGEN_PREDEFINED='H5_HAVE_DIRECT H5_HAVE_LIBHDFS H5_HAVE_MAP_API H5_HAVE_PARALLEL H5_HAVE_ROS3_VFD H5_DOXYGEN_FORTRAN H5_HAVE_MIRROR_VFD'

DX_INIT_DOXYGEN([HDF5], [./doxygen/Doxyfile], [hdf5lib_docs])
fi
Expand Down
2 changes: 1 addition & 1 deletion doxygen/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ if (DOXYGEN_FOUND)
set (DOXYGEN_SEARCHENGINE_URL)
set (DOXYGEN_STRIP_FROM_PATH ${HDF5_SOURCE_DIR})
set (DOXYGEN_STRIP_FROM_INC_PATH ${HDF5_SOURCE_DIR})
set (DOXYGEN_PREDEFINED "H5_HAVE_DIRECT H5_HAVE_LIBHDFS H5_HAVE_MAP_API H5_HAVE_PARALLEL H5_HAVE_ROS3_VFD H5_DOXYGEN_FORTRAN")
set (DOXYGEN_PREDEFINED "H5_HAVE_DIRECT H5_HAVE_LIBHDFS H5_HAVE_MAP_API H5_HAVE_PARALLEL H5_HAVE_ROS3_VFD H5_DOXYGEN_FORTRAN H5_HAVE_MIRROR_VFD")

# This configure and individual custom targets work together
# Replace variables inside @@ with the current values
Expand Down
896 changes: 0 additions & 896 deletions doxygen/Doxyfile.in

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion doxygen/aliases
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ ALIASES += space_id="\param[in] space_id Dataspace identifier"
ALIASES += space_id{1}="\param[in] \1 Dataspace identifier"

################################################################################
# Dataypes
# Datatypes
################################################################################

ALIASES += type_id="\param[in] type_id Datatype identifier"
Expand Down
2 changes: 1 addition & 1 deletion doxygen/dox/LearnBasics2.dox
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion doxygen/dox/LearnBasics3.dox
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
4 changes: 2 additions & 2 deletions doxygen/dox/Overview.dox
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,10 @@ documents cover a mix of tasks, concepts, and reference, to help a specific
\par Versions
Version-specific documentation (see the version in the title area) can be found
here:
- HDF5 <code>1.10</code> branch (this site)
- <a href="https://docs.hdfgroup.org/hdf5/develop/index.html">HDF5 <code>develop</code> branch</a>
- <a href="https://docs.hdfgroup.org/hdf5/v1_14/index.html">HDF5 1.14.x</a>
- <a href="https://docs.hdfgroup.org/hdf5/v1_12/index.html">HDF5 1.12.x</a>
- <a href="https://docs.hdfgroup.org/hdf5/v1_10/index.html">HDF5 1.10.x</a>
- <a href="https://docs.hdfgroup.org/hdf5/v1_10/index.html">HDF5 1.10.x (this site)</a>
- <a href="https://docs.hdfgroup.org/hdf5/v1_8/index.html">HDF5 1.8.x</a>

\par Search
Expand Down
2 changes: 1 addition & 1 deletion doxygen/dox/ViewTools.dox
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion doxygen/examples/H5.format.1.0.html
Original file line number Diff line number Diff line change
Expand Up @@ -1488,7 +1488,7 @@ <h3><a name="GlobalHeap">Disk Format: Level 1E - Global Heap</a></h3>
</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>
Expand Down
2 changes: 1 addition & 1 deletion doxygen/examples/H5.format.1.1.html
Original file line number Diff line number Diff line change
Expand Up @@ -6091,7 +6091,7 @@ <h4><a name="SharedMessage">Name: Shared Object Message</a></h4>
<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>
Expand Down
12 changes: 6 additions & 6 deletions doxygen/examples/ImageSpec.html
Original file line number Diff line number Diff line change
Expand Up @@ -851,31 +851,31 @@ <h3>
"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>

<dt>
"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>

<dt>
"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>

<dt>
"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>

Expand All @@ -884,14 +884,14 @@ <h3>

<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
Expand Down
2 changes: 1 addition & 1 deletion doxygen/examples/tables/propertyLists.dox
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
2 changes: 1 addition & 1 deletion doxygen/hdf5_navtree_hacks.js
Original file line number Diff line number Diff line change
Expand Up @@ -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) {
Expand Down

0 comments on commit 2b278e2

Please sign in to comment.