summaryrefslogtreecommitdiffstats
path: root/doxygen/dox
diff options
context:
space:
mode:
authorAllen Byrne <50328838+byrnHDF@users.noreply.github.com>2022-12-21 14:10:24 (GMT)
committerGitHub <noreply@github.com>2022-12-21 14:10:24 (GMT)
commit04bd873d77d64b3a2475e8fe63db51e03c13cb07 (patch)
tree0a86beec626b292d90ee0f2229c2b6ba4b000e6e /doxygen/dox
parent83c7f928f97b56a7a83f7f81b207cbe082136b1f (diff)
downloadhdf5-04bd873d77d64b3a2475e8fe63db51e03c13cb07.zip
hdf5-04bd873d77d64b3a2475e8fe63db51e03c13cb07.tar.gz
hdf5-04bd873d77d64b3a2475e8fe63db51e03c13cb07.tar.bz2
1.14 Fix some doxygen warnings (#2323)
* Fix some doxygen warnings * Remove javadocs * Fix spelling * Fix section format * Correct doxygen function name * Remove duplicate Co-authored-by: Dana Robinson <43805+derobins@users.noreply.github.com>
Diffstat (limited to 'doxygen/dox')
-rw-r--r--doxygen/dox/Overview.dox1
-rw-r--r--doxygen/dox/ViewTools.dox8
-rw-r--r--doxygen/dox/cookbook/Accessibility.dox2
-rw-r--r--doxygen/dox/cookbook/Attributes.dox2
-rw-r--r--doxygen/dox/cookbook/Files.dox2
-rw-r--r--doxygen/dox/cookbook/Performance.dox2
6 files changed, 8 insertions, 9 deletions
diff --git a/doxygen/dox/Overview.dox b/doxygen/dox/Overview.dox
index 040769c..3d171f7 100644
--- a/doxygen/dox/Overview.dox
+++ b/doxygen/dox/Overview.dox
@@ -24,6 +24,7 @@ documents cover a mix of tasks, concepts, and reference, to help a specific
Version-specific documentation (see the version in the title area) can be found
here:
- HDF5 <code>develop</code> branch (this site)
+ - <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_8/index.html">HDF5 1.8.x</a>
diff --git a/doxygen/dox/ViewTools.dox b/doxygen/dox/ViewTools.dox
index 0b685a0..2212d4b 100644
--- a/doxygen/dox/ViewTools.dox
+++ b/doxygen/dox/ViewTools.dox
@@ -829,6 +829,7 @@ by simply viewing the specified dataset with the <code style="background-color:w
\code
h5dump -d "HDFEOS/GRIDS/OMI Column Amount O3/Data Fields/SolarZenithAngle" OMI-Aura.he5
\endcode
+
Subsetting narrows down the output that is displayed. In the following example, the first
15x10 elements (-c "15,10") are specified, beginning with position (0,0) (-s "0,0"):
\code
@@ -840,11 +841,8 @@ If using the shorthand method, specify:
h5dump -A 0 -d "HDFEOS/GRIDS/OMI Column Amount O3/Data Fields/SolarZenithAngle[0,0;;15,10;]" -w 0 OMI-Aura.he5
\endcode
-Where,
-\par The <code style="background-color:whitesmoke;">-d</code> option must be specified
-
-before
-\par subsetting options (if not using the shorthand method).
+Where, the <code style="background-color:whitesmoke;">-d</code> option must be specified
+before subsetting options (if not using the shorthand method).
The <code style="background-color:whitesmoke;">-A 0</code> option suppresses the printing of attributes.
diff --git a/doxygen/dox/cookbook/Accessibility.dox b/doxygen/dox/cookbook/Accessibility.dox
index f100283..28009be 100644
--- a/doxygen/dox/cookbook/Accessibility.dox
+++ b/doxygen/dox/cookbook/Accessibility.dox
@@ -1,6 +1,6 @@
/** \page Accessibility
-\section Accessibility
+\section secAccessibility Accessibility
\subsection CB_MaintainCompat Maintaining Compatibility with other HDF5 Library Versions
diff --git a/doxygen/dox/cookbook/Attributes.dox b/doxygen/dox/cookbook/Attributes.dox
index 68fd159..5914909 100644
--- a/doxygen/dox/cookbook/Attributes.dox
+++ b/doxygen/dox/cookbook/Attributes.dox
@@ -1,6 +1,6 @@
/** \page Attributes
-\section Attributes
+\section secAttributes Attributes
\subsection CB_LargeAttributes Creating "Large" HDF5 Attributes
diff --git a/doxygen/dox/cookbook/Files.dox b/doxygen/dox/cookbook/Files.dox
index 169d638..4893771 100644
--- a/doxygen/dox/cookbook/Files.dox
+++ b/doxygen/dox/cookbook/Files.dox
@@ -1,6 +1,6 @@
/** \page Files
-\section Files
+\section secFiles Files
\subsection CB_FreeSpace Tracking Free Space in HDF5 Files
diff --git a/doxygen/dox/cookbook/Performance.dox b/doxygen/dox/cookbook/Performance.dox
index 7ac3a18..5e945b2 100644
--- a/doxygen/dox/cookbook/Performance.dox
+++ b/doxygen/dox/cookbook/Performance.dox
@@ -1,6 +1,6 @@
/** \page Performance
-\section Performance
+\section secPerformance Performance
\subsection CB_MDCPerf Assessing HDF5 Metadata Cache Performance