summaryrefslogtreecommitdiffstats
path: root/doxygen
diff options
context:
space:
mode:
Diffstat (limited to 'doxygen')
-rw-r--r--doxygen/aliases6
-rw-r--r--doxygen/dox/Overview.dox4
-rw-r--r--doxygen/examples/H5Pget_metadata_read_attempts.2.c4
-rw-r--r--doxygen/examples/H5Pget_metadata_read_attempts.3.c4
-rw-r--r--doxygen/examples/H5Pset_metadata_read_attempts.c4
5 files changed, 11 insertions, 11 deletions
diff --git a/doxygen/aliases b/doxygen/aliases
index 3fc7e10..27090e6 100644
--- a/doxygen/aliases
+++ b/doxygen/aliases
@@ -15,7 +15,7 @@ ALIASES += Code{1}="<tt>\1</tt>"
ALIASES += success{1}="\Bold{Success:} \1"
ALIASES += failure{1}="\Bold{Failure:} \1"
-ALIASES += herr_t="Returns a non-negative value if successful; otherwise returns a negative value."
+ALIASES += herr_t="Returns a non-negative value if successful; otherwise, returns a negative value."
ALIASES += herr_t_iter="\li Zero causes the iterator to continue, returning zero when the iteration is complete. \li A positive value causes the iterator to immediately return that positive value, indicating short-circuit success. \li A negative value causes the iterator to immediately return that value, indicating failure."
ALIASES += hid_t{1}="Returns a \1 identifier if successful; otherwise returns #H5I_INVALID_HID. "
ALIASES += hid_ti{1}="Returns an \1 identifier if successful; otherwise returns #H5I_INVALID_HID. "
@@ -380,3 +380,7 @@ ALIASES += obj_info_fields="<table><tr><th>Flag</th><th>Purpose</th></tr><tr><td
ALIASES += fortran_error="Returns 0 if successful and -1 if it fails."
ALIASES += fortran_approved="The preferred API, Fortran 2003 version."
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"
+
diff --git a/doxygen/dox/Overview.dox b/doxygen/dox/Overview.dox
index 36e6622..70974ec 100644
--- a/doxygen/dox/Overview.dox
+++ b/doxygen/dox/Overview.dox
@@ -37,10 +37,6 @@ documents cover a mix of tasks, concepts, and reference, to help a specific
\par Offline reading
You can <a href="hdf5-doc.tgz">download</a> it as a tgz archive for offline reading.
-\par History
- A snapshot (~April 2017) of the pre-Doxygen HDF5 documentation can be found
- <a href="https://docs.hdfgroup.org/archive/support/HDF5/doc/index.html">here</a>.
-
\par ToDo List
There is plenty of <a href="./todo.html">unfinished business</a>.
diff --git a/doxygen/examples/H5Pget_metadata_read_attempts.2.c b/doxygen/examples/H5Pget_metadata_read_attempts.2.c
index 2cd12db..44b26e9 100644
--- a/doxygen/examples/H5Pget_metadata_read_attempts.2.c
+++ b/doxygen/examples/H5Pget_metadata_read_attempts.2.c
@@ -1,7 +1,7 @@
/* Open the file with SWMR access and default file access property list */
fid = H5Fopen(FILE, (H5F_ACC_RDONLY | H5F_ACC_SWMR_READ), H5P_DEFAULT);
-/* Get the file's file access roperty list */
+/* Get the file's file access property list */
file_fapl = H5Fget_access_plist(fid);
/* Retrieve the # of read attempts from the file's file access property list */
@@ -26,7 +26,7 @@ H5Pset_metadata_read_attempts(fapl, 20);
/* Open the file with SWMR access and the non-default file access property list */
fid = H5Fopen(FILE, (H5F_ACC_RDONLY | H5F_ACC_SWMR_READ), fapl);
-/* Get the file's file access roperty list */
+/* Get the file's file access property list */
file_fapl = H5Fget_access_plist(fid);
/* Retrieve the # of read attempts from the file's file access property list */
diff --git a/doxygen/examples/H5Pget_metadata_read_attempts.3.c b/doxygen/examples/H5Pget_metadata_read_attempts.3.c
index 4b5ea3a..8edda9f 100644
--- a/doxygen/examples/H5Pget_metadata_read_attempts.3.c
+++ b/doxygen/examples/H5Pget_metadata_read_attempts.3.c
@@ -1,7 +1,7 @@
/* Open the file with non-SWMR access and default file access property list */
fid = H5Fopen(FILE, H5F_ACC_RDONLY, H5P_DEFAULT);
-/* Get the file's file access roperty list */
+/* Get the file's file access property list */
file_fapl = H5Fget_access_plist(fid);
/* Retrieve the # of read attempts from the file's file access property list */
@@ -26,7 +26,7 @@ H5Pset_metadata_read_attempts(fapl, 20);
/* Open the file with non-SWMR access and the non-default file access property list */
fid = H5Fopen(FILE, H5F_ACC_RDONLY, fapl);
-/* Get the file's file access roperty list */
+/* Get the file's file access property list */
file_fapl = H5Fget_access_plist(fid);
/* Retrieve the # of read attempts from the file's file access property list */
diff --git a/doxygen/examples/H5Pset_metadata_read_attempts.c b/doxygen/examples/H5Pset_metadata_read_attempts.c
index 7c2f65d..db3573b 100644
--- a/doxygen/examples/H5Pset_metadata_read_attempts.c
+++ b/doxygen/examples/H5Pset_metadata_read_attempts.c
@@ -8,7 +8,7 @@ H5Pset_metadata_read_attempts(fapl, 20);
/* Open the file with SWMR access and the non-default file access property list */
fid = H5Fopen(FILE, (H5F_ACC_RDONLY | H5F_ACC_SWMR_READ), fapl);
-/* Get the file's file access roperty list */
+/* Get the file's file access property list */
file_fapl = H5Fget_access_plist(fid);
/* Retrieve the # of read attempts from the file's file access property list */
@@ -38,7 +38,7 @@ H5Pset_metadata_read_attempts(fapl, 20);
/* Open the file with SWMR access and the non-default file access property list */
fid = H5Fopen(FILE, H5F_ACC_RDONLY, fapl);
-/* Get the file's file access roperty list */
+/* Get the file's file access property list */
file_fapl = H5Fget_access_plist(fid);
/* Retrieve the # of read attempts from the file's file access property list */