From 8e964d4622d655514d5494e9e45ebd06031099c8 Mon Sep 17 00:00:00 2001
From: jhendersonHDF <jhenderson@hdfgroup.org>
Date: Tue, 26 Sep 2023 15:47:13 -0500
Subject: Clean up Subfiling VFD header doxygen formatting (#3601)

---
 src/H5FDsubfiling/H5FDsubfiling.h | 42 ++++++++++++++++++++++++---------------
 1 file changed, 26 insertions(+), 16 deletions(-)

diff --git a/src/H5FDsubfiling/H5FDsubfiling.h b/src/H5FDsubfiling/H5FDsubfiling.h
index 5a520ce..d6d2ffd 100644
--- a/src/H5FDsubfiling/H5FDsubfiling.h
+++ b/src/H5FDsubfiling/H5FDsubfiling.h
@@ -61,32 +61,42 @@
 
 /**
  * \def H5FD_SUBFILING_FILENAME_TEMPLATE
- * The basic template for a subfile filename. The format specifiers
- * correspond to:
+ * The basic printf-style template for a #H5FD_SUBFILING driver
+ * subfile filename. The format specifiers correspond to:
  *
- * %s      -> base filename, e.g. "file.h5"
- * %PRIu64 -> file inode, e.g. 11273556
- * %0*d    -> number (starting at 1) signifying the Nth (out of total
- *            number of subfiles) subfile. Zero-padded according
- *            to the number of digits in the number of subfiles
- *            (calculated by log10(num_subfiles) + 1)
- * %d      -> number of subfiles
+ * \par \%s
+ *   base filename, e.g. "file.h5"
+ *
+ * \par \%PRIu64
+ *   file inode, e.g. 11273556
+ *
+ * \par \%0*d
+ *   number (starting at 1) signifying the Nth (out of
+ *   total number of subfiles) subfile. Zero-padded
+ *   according to the number of digits in the number of
+ *   subfiles (calculated by <tt>log10(num_subfiles) + 1)</tt>
+ *
+ * \par \%d
+ *   number of subfiles
  *
  * yielding filenames such as:
  *
- * file.h5.subfile_11273556_01_of_10
- * file.h5.subfile_11273556_02_of_10
- * file.h5.subfile_11273556_10_of_10
+ * file.h5.subfile_11273556_01_of_10 \n
+ * file.h5.subfile_11273556_02_of_10 \n
+ * file.h5.subfile_11273556_10_of_10 \n
  */
 #define H5FD_SUBFILING_FILENAME_TEMPLATE "%s.subfile_%" PRIu64 "_%0*d_of_%d"
 
 /**
  * \def H5FD_SUBFILING_CONFIG_FILENAME_TEMPLATE
- * The basic template for a #H5FD_SUBFILING driver configuration filename.
- * The format specifiers correspond to:
+ * The basic printf-style template for a #H5FD_SUBFILING driver
+ * configuration filename. The format specifiers correspond to:
+ *
+ * \par \%s
+ *   base filename, e.g. "file.h5"
  *
- * %s      -> base filename, e.g. "file.h5"
- * %PRIu64 -> file inode, e.g. 11273556
+ * \par \%PRIu64
+ *   file inode, e.g. 11273556
  *
  * yielding a filename such as:
  *
-- 
cgit v0.12