Transfer doxygen H5O RM blocks from doxygen branch to develop. (#174)

Co-authored-by: vchoi <vchoi@jelly.ad.hdfgroup.org>

4 files changed, 32 insertions, 0 deletions

diff --git a/test/links.c b/test/links.c
index 11b760c..784a8eb 100644
--- a/test/links.c
+++ b/test/links.c
@@ -631,6 +631,8 @@ cklinks(hid_t fapl, hbool_t new_format)
     if ((file = H5Fopen(filename, H5F_ACC_RDONLY, fapl)) < 0)
         FAIL_STACK_ERROR
 
+//! [H5Otoken_cmp_snip]
+
     /* Hard link */
     if (H5Oget_info_by_name3(file, "d1", &oinfo1, H5O_INFO_BASIC, H5P_DEFAULT) < 0)
         FAIL_STACK_ERROR
@@ -641,6 +643,9 @@ cklinks(hid_t fapl, hbool_t new_format)
         HDprintf("    %d: Unexpected object type should have been a dataset\n", __LINE__);
         TEST_ERROR
     } /* end if */
+
+//! [H5Otoken_cmp_snip]
+
     if (H5Otoken_cmp(file, &oinfo1.token, &oinfo2.token, &token_cmp) < 0)
         FAIL_STACK_ERROR
     if (token_cmp) {
@@ -15794,12 +15799,16 @@ obj_visit(hid_t fapl, hbool_t new_format)
     if ((fid = build_visit_file(fapl)) < 0)
         TEST_ERROR
 
+//! [H5Ovisit3_snip]
+
     /* Visit all the objects reachable from the root group (with file ID) */
     udata.idx  = 0;
     udata.info = new_format ? ovisit0_new : ovisit0_old;
     if (H5Ovisit3(fid, H5_INDEX_NAME, H5_ITER_INC, visit_obj_cb, &udata, H5O_INFO_BASIC) < 0)
         FAIL_STACK_ERROR
 
+//! [H5Ovisit3_snip]
+
     /* Visit all the objects reachable from the root group (with group ID) */
     if ((gid = H5Gopen2(fid, "/", H5P_DEFAULT)) < 0)
         FAIL_STACK_ERROR
@@ -15871,6 +15880,8 @@ obj_visit_by_name(hid_t fapl, hbool_t new_format)
     if ((fid = build_visit_file(fapl)) < 0)
         TEST_ERROR
 
+//! [H5Ovisit_by_name3_snip]
+
     /* Visit all the objects reachable from the root group (with file ID) */
     udata.idx  = 0;
     udata.info = new_format ? ovisit0_new : ovisit0_old;
@@ -15878,6 +15889,8 @@ obj_visit_by_name(hid_t fapl, hbool_t new_format)
                           H5P_DEFAULT) < 0)
         FAIL_STACK_ERROR
 
+//! [H5Ovisit_by_name3_snip]
+
     /* Visit all the objects reachable from the root group (with group ID) */
     if ((gid = H5Gopen2(fid, "/", H5P_DEFAULT)) < 0)
         FAIL_STACK_ERROR
diff --git a/test/tfile.c b/test/tfile.c
index 1b334f2..9a94a7d 100644
--- a/test/tfile.c
+++ b/test/tfile.c
@@ -5182,7 +5182,12 @@ test_libver_bounds_real(H5F_libver_t libver_create, unsigned oh_vers_create, H5F
     group = H5Gcreate2(file, "/G1", H5P_DEFAULT, H5P_DEFAULT, H5P_DEFAULT);
     CHECK(group, FAIL, "H5Gcreate");
 
+//! [H5Oget_native_info_snip]
+
     ret = H5Oget_native_info(group, &ninfo, H5O_NATIVE_INFO_HDR);
+
+//! [H5Oget_native_info_snip]
+
     CHECK(ret, FAIL, "H5Oget_native)info");
     VERIFY(ninfo.hdr.version, oh_vers_mod, "H5Oget_native_info");
 
@@ -5203,10 +5208,15 @@ test_libver_bounds_real(H5F_libver_t libver_create, unsigned oh_vers_create, H5F
     ret = H5Gclose(group);
     CHECK(ret, FAIL, "H5Gclose");
 
+//! [H5Oget_native_info_by_name_snip]
+
     /*
      * Make sure the root group still has the correct object header version
      */
     ret = H5Oget_native_info_by_name(file, "/", &ninfo, H5O_NATIVE_INFO_HDR, H5P_DEFAULT);
+
+//! [H5Oget_native_info_by_name_snip]
+
     CHECK(ret, FAIL, "H5Oget_native_info_by_name");
     VERIFY(ninfo.hdr.version, oh_vers_create, "H5Oget_native_info_by_name");
 
diff --git a/test/titerate.c b/test/titerate.c
index 050dcec..0b20d8d 100644
--- a/test/titerate.c
+++ b/test/titerate.c
@@ -218,9 +218,14 @@ test_iter_group(hid_t fapl, hbool_t new_format)
                                          dataset_name, (size_t)NAMELEN, H5P_DEFAULT);
         CHECK(ret, FAIL, "H5Lget_name_by_idx");
 
+//! [H5Oget_info_by_idx3_snip]
+
         ret = H5Oget_info_by_idx3(root_group, ".", H5_INDEX_NAME, H5_ITER_INC, (hsize_t)i, &oinfo,
                                   H5O_INFO_BASIC, H5P_DEFAULT);
         CHECK(ret, FAIL, "H5Oget_info_by_idx");
+
+//! [H5Oget_info_by_idx3_snip]
+
     } /* end for */
 
     H5E_BEGIN_TRY
diff --git a/test/vol.c b/test/vol.c
index b08f112..53c760c 100644
--- a/test/vol.c
+++ b/test/vol.c
@@ -950,10 +950,14 @@ test_basic_object_operation(void)
     if (H5Oget_info3(fid, &object_info, H5O_INFO_ALL) < 0)
         TEST_ERROR;
 
+//! [H5Oget_info_by_name3_snip]
+
     /* H5Oget_info_by_name */
     if (H5Oget_info_by_name3(fid, NATIVE_VOL_TEST_GROUP_NAME, &object_info, H5O_INFO_ALL, H5P_DEFAULT) < 0)
         TEST_ERROR;
 
+//! [H5Oget_info_by_name3_snip]
+
     /* H5Oexists_by_name */
     if (H5Oexists_by_name(fid, NATIVE_VOL_TEST_GROUP_NAME, H5P_DEFAULT) != TRUE)
         TEST_ERROR;