Feature/awesome (HDFGroup#4604)

* Added Doxygen Awesome and fixed a few quirks.

* Fixed unterminated strings.

* Added Doxygen Awesome by copy.

Author: gheber

configure.ac

@@ -1594,7 +1594,7 @@ if test "X$HDF5_DOXYGEN" = "Xyes"; then
   DOXYGEN_LAYOUT_FILE='$(SRCDIR)/doxygen/hdf5doxy_layout.xml'
   DOXYGEN_HTML_HEADER='$(SRCDIR)/doxygen/hdf5_header.html'
   DOXYGEN_HTML_FOOTER='$(SRCDIR)/doxygen/hdf5_footer.html'
-  DOXYGEN_HTML_EXTRA_STYLESHEET='$(SRCDIR)/doxygen/hdf5doxy.css'
+  DOXYGEN_HTML_EXTRA_STYLESHEET='$(SRCDIR)/doxygen/hdf5doxy.css $(SRCDIR)/doxygen/doxygen-awesome.css'
   DOXYGEN_HTML_EXTRA_FILES='$(SRCDIR)/doxygen/hdf5_navtree_hacks.js'
   DOXYGEN_TAG_FILE=hdf5.tag
   DOXYGEN_SERVER_BASED_SEARCH=NO

doxygen/CMakeLists.txt

@@ -21,7 +21,7 @@ if (DOXYGEN_FOUND)
   set (DOXYGEN_LAYOUT_FILE ${HDF5_DOXYGEN_DIR}/hdf5doxy_layout.xml)
   set (DOXYGEN_HTML_HEADER ${HDF5_DOXYGEN_DIR}/hdf5_header.html)
   set (DOXYGEN_HTML_FOOTER ${HDF5_DOXYGEN_DIR}/hdf5_footer.html)
-  set (DOXYGEN_HTML_EXTRA_STYLESHEET ${HDF5_DOXYGEN_DIR}/hdf5doxy.css)
+  set (DOXYGEN_HTML_EXTRA_STYLESHEET "${HDF5_DOXYGEN_DIR}/hdf5doxy.css ${HDF5_DOXYGEN_DIR}/doxygen-awesome.css")
   set (DOXYGEN_HTML_EXTRA_FILES "${HDF5_DOXYGEN_DIR}/hdf5_navtree_hacks.js")
   set (DOXYGEN_TAG_FILE ${HDF5_BINARY_DIR}/hdf5.tag)
   set (DOXYGEN_SERVER_BASED_SEARCH NO)

doxygen/Doxyfile.in

@@ -1283,7 +1283,7 @@ ECLIPSE_DOC_ID         = org.doxygen.Project
 # The default value is: NO.
 # This tag requires that the tag GENERATE_HTML is set to YES.
 
-DISABLE_INDEX          = YES
+DISABLE_INDEX          = NO
 
 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
 # structure should be generated to display hierarchical information. If the tag

doxygen/aliases

@@ -387,8 +387,8 @@ ALIASES += str_pad_type="<table><tr><td>#H5T_STR_NULLTERM</td><td>0</td><td>Null
 ALIASES += see_virtual=" \see Supporting Functions: H5Pget_layout(), H5Pset_layout(), H5Sget_regular_hyperslab(), H5Sis_regular_hyperslab(), H5Sselect_hyperslab() \see VDS Functions: H5Pget_virtual_count(), H5Pget_virtual_dsetname(), H5Pget_virtual_filename(), H5Pget_virtual_prefix(), H5Pget_virtual_printf_gap(), H5Pget_virtual_srcspace(), H5Pget_virtual_view(), H5Pget_virtual_vspace(), H5Pset_virtual(), H5Pset_virtual_prefix(), H5Pset_virtual_printf_gap(), H5Pset_virtual_view()"
 ALIASES += obj_info_fields="<table><tr><th>Flag</th><th>Purpose</th></tr><tr><td>#H5O_INFO_BASIC</td><td>Fill in the fileno, addr, type, and rc fields</td></tr><tr> <td>#H5O_INFO_TIME</td><td>Fill in the atime, mtime, ctime, and btime fields</td></tr><tr> <td>#H5O_INFO_NUM_ATTRS</td> <td>Fill in the num_attrs field</td></tr><tr><td>#H5O_INFO_HDR</td><td>Fill in the num_attrs field</td></tr><tr><td>#H5O_INFO_META_SIZE</td><td>Fill in the meta_size field</td></tr><tr><td>#H5O_INFO_ALL</td><td>#H5O_INFO_BASIC | #H5O_INFO_TIME | #H5O_INFO_NUM_ATTRS | #H5O_INFO_HDR | #H5O_INFO_META_SIZE</td></tr></table>"
 
-ALIASES += details_namelen{2}="Up to \p size characters of the \1 name are returned in \p name; additional characters, if any, are not returned to the user application.\n\n If the length of the \1 name, which determines the required value of \p size, is unknown, a preliminary call to \2() with the last two parameters set to NULL and zero respectively can be made. The return value of this call will be the size in bytes of the \1 name. That value, plus 1 for a NULL terminator, must then be assigned to \p size for a second \2() call, which will retrieve the actual \1 name.
-ALIASES += details_namelen_plusone{2}="Up to \p size characters of the \1 name are returned in \p name; additional characters, if any, are not returned to the user application.\n\n If the length of the \1 name, which determines the required value of \p size, is unknown, a preliminary call to \2() with the last two parameters set to NULL and zero respectively can be made. The return value of this call will be the size in bytes of the \1 name plus 1 for a NULL terminator. That value must then be assigned to \p size for a second \2() call, which will retrieve the actual \1 name.
+ALIASES += details_namelen{2}="Up to \p size characters of the \1 name are returned in \p name; additional characters, if any, are not returned to the user application.\n\n If the length of the \1 name, which determines the required value of \p size, is unknown, a preliminary call to \2() with the last two parameters set to NULL and zero respectively can be made. The return value of this call will be the size in bytes of the \1 name. That value, plus 1 for a NULL terminator, must then be assigned to \p size for a second \2() call, which will retrieve the actual \1 name."
+ALIASES += details_namelen_plusone{2}="Up to \p size characters of the \1 name are returned in \p name; additional characters, if any, are not returned to the user application.\n\n If the length of the \1 name, which determines the required value of \p size, is unknown, a preliminary call to \2() with the last two parameters set to NULL and zero respectively can be made. The return value of this call will be the size in bytes of the \1 name plus 1 for a NULL terminator. That value must then be assigned to \p size for a second \2() call, which will retrieve the actual \1 name."
 
 
 ################################################################################

doxygen/dox/About.dox

@@ -8,7 +8,9 @@ Please refer to their <a href="https://gitlab.com/libeigen/eigen">GitLab reposit
 and the online version of their
 <a href="http://eigen.tuxfamily.org/dox/">Doxygen-based documentation</a>.
 Not only does Eigen set a standard as a piece of software, but also as an example
-of <em>documentation done right</em>.
+of <em>documentation done right</em>. And kudos to the
+<a href="https://github.com/jothepro/doxygen-awesome-css">Doxygen Awesome project</a>
+for their style sheets.
 
 \section about_documentation Documentation about Documentation
 
@@ -114,14 +116,4 @@ be
 https://\RFCURL/my_great_rfc_name.pdf
 \endverbatim
 
-\subsection hosting How Do Updates and Changes Get Published?
-
-Currently, the files underlying this documentation website are stored in an
-bucket on AWS S3. The top-level bucket is <pre>s3://docs.hdfgroup.org/hdf5/</pre>
-There are folders for the <tt>development</tt> branch and all supported release
-version.
-
-Talk to your friendly IT-team if you need write access, or you need someone to
-push an updated version for you!
-
 */

doxygen/dox/Overview.dox

@@ -20,20 +20,6 @@ while the \link Cookbook \endlink is focused on tasks. The different guide-type
 documents cover a mix of tasks, concepts, and reference, to help a specific
 <em>audience</em> succeed.
 
-\par Versions
-     Version-specific documentation (see the version in the title area) can be found
-     here:
-     - <a href="https://\DOXURL/index.html">HDF5 <code>develop</code> branch (this site)</a>
-     - <a href="https://hdfgroup.github.io/hdf5/v1_14/index.html">HDF5 1.14.x</a>
-     - <a href="https://\HDFURL/v1_12/index.html">HDF5 1.12.x</a>
-     - <a href="https://\HDFURL/v1_10/index.html">HDF5 1.10.x</a>
-     - <a href="https://\HDFURL/v1_8/index.html">HDF5 1.8.x</a>
-
-\par Search
-     If you are looking for a specific function, constant, type, etc., use the
-     search box in the top right-hand corner!\n Otherwise, check out the
-     \link FTS full-text search\endlink.
-
 \par Offline reading
      You can <a href="https://github.com/HDFGroup/hdf5/releases/download/snapshot/snapshot.doxygen.zip">download</a> it as an archive for offline reading.
 

doxygen/dox/TechnicalNotes.dox

@@ -12,6 +12,8 @@
 \li \ref VDS
 \li \ref RELVERSION
 \li \ref VFL
+\li <a href="https://github.com/HDFGroup/arch-doc/blob/main/An_Overview_of_the_HDF5_Library_Architecture.v2.pdf">HDF5 Library Architecture Overview</a>
+\li \ref VOL_Connector
 
  */
 

doxygen/dox/UsersGuide.dox

@@ -1,12 +1,5 @@
 /** \page UG HDF5 User Guide
 
-<center>
-HDF5 Release 1.14
-
-\image html HDFG-logo.png "The HDF Group"
-
-</center>
-
 \ref sec_data_model
 \li \ref subsec_data_model_intro
 \li \ref subsec_data_model_abstract