Fixing link to Doxygen

docs/CMakeLists.txt

@@ -4,10 +4,16 @@
 #
 # SPDX-License-Identifier: (MIT)
 ##############################################################################
-if (DOXYGEN_FOUND)
-  add_subdirectory(doxygen)
-endif ()
+  if (SPHINX_FOUND)
+    blt_add_sphinx_target( umpire_docs )
+    add_subdirectory(sphinx)
+  endif()
 
-if (SPHINX_FOUND)
-  add_subdirectory(sphinx)
-endif ()
+  if (DOXYGEN_FOUND)
+    add_subdirectory(doxygen)
+  endif ()
+
+  if ( NOT SPHINX_FOUND AND NOT DOXGEN_FOUND)
+    message(WARNING "UMPIRE_ENABLE_DOCS=On, but Sphinx or Doxygen not found. \
+      Documentation won't be built.")
+  endif ()

docs/conf.py

@@ -92,9 +92,9 @@
 # built documents.
 #
 # The short X.Y version.
-version = u'6.0'
+version = u'2024.07'
 # The full version, including alpha/beta/rc tags.
-release = u'6.0.0'
+release = u'2024.07.0'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

docs/doxygen/CMakeLists.txt

@@ -5,3 +5,14 @@
 # SPDX-License-Identifier: (MIT)
 ##############################################################################
 blt_add_doxygen_target( umpire_doxygen )
+
+# Required directory for doxygen to generate output to
+add_custom_target( build_doxygen_output_dir
+                   ALL
+                   COMMAND ${CMAKE_COMMAND} -E make_directory ${CMAKE_BINARY_DIR}/html
+                 )
+
+add_dependencies( umpire_doxygen build_doxygen_output_dir )
+
+add_dependencies(umpire_docs
+  umpire_doxygen)

src/umpire/alloc/SyclMallocAllocator.hpp

@@ -20,7 +20,7 @@ namespace alloc {
  */
 struct SyclMallocAllocator {
   /*!
-   * \Brief Allocate bytes of memory using SYCL malloc
+   * \brief Allocate bytes of memory using SYCL malloc
    *
    * \param size Number of bytes to allocate.
    * \param queue_t SYCL queue for providing information on device and context

src/umpire/alloc/SyclPinnedAllocator.hpp

@@ -20,7 +20,7 @@ namespace alloc {
  */
 struct SyclPinnedAllocator {
   /*!
-   * \Brief Allocate bytes of memory using SYCL malloc_host
+   * \brief Allocate bytes of memory using SYCL malloc_host
    *
    * \param size Number of bytes to allocate.
    * \param queue_t SYCL queue for providing information on device and context