#371: docs: misc fixes

DARMA-tasking · Nov 12, 2024 · c00e30c · c00e30c
1 parent 8407184
commit c00e30c
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 18 deletions.
diff --git a/cmake/load_doxygen.cmake b/cmake/load_doxygen.cmake
@@ -5,7 +5,7 @@ if (${magistrate_doxygen_enabled})
     set(doxygen_in ${CMAKE_CURRENT_SOURCE_DIR}/docs/Doxyfile.in)
     set(doxygen_out ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile)
 
-    set(DOXYGEN_PROJECT_NAME "checkpoint")
+    set(DOXYGEN_PROJECT_NAME "magistrate")
     set(VERSION_MAJOR "1")
     set(VERSION_MINOR "0")
     set(VERSION_PATCH "0")
@@ -18,13 +18,13 @@ if (${magistrate_doxygen_enabled})
 
     configure_file(${doxygen_in} ${doxygen_out} @ONLY)
     configure_file(${doxygen_in}-mcss ${doxygen_out}-mcss @ONLY)
-    message(STATUS "checkpoint doxygen build started")
+    message(STATUS "magistrate doxygen build started")
 
     add_custom_target(
       docs ALL
       COMMAND ${DOXYGEN_EXECUTABLE} ${doxygen_out}
       WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
-      COMMENT "checkpoint generating API documentation with Doxygen"
+      COMMENT "magistrate generating API documentation with Doxygen"
       VERBATIM
     )
 

diff --git a/docs/Doxyfile.in-mcss b/docs/Doxyfile.in-mcss
@@ -16,14 +16,14 @@ XML_NS_MEMB_FILE_SCOPE  = YES
 ##!   "files" \
 ##!   "<a href=\"https://github.com/\">GitHub</a> <a href=\"https://github.com/DARMA-tasking/magistrate\">magistrate</a> <a href=\"https://github.com/DARMA-tasking/checkpoint-member-analyzer\">Serialization Sanitizer</a>"
 
-##! ALIASES += \
-##!     "m_div{1}=@xmlonly<mcss:div xmlns:mcss=\"http://mcss.mosra.cz/doxygen/\" mcss:class=\"\1\">@endxmlonly" \
-##!     "m_enddiv=@xmlonly</mcss:div>@endxmlonly" \
-##!     "m_span{1}=@xmlonly<mcss:span xmlns:mcss=\"http://mcss.mosra.cz/doxygen/\" mcss:class=\"\1\">@endxmlonly" \
-##!     "m_endspan=@xmlonly</mcss:span>@endxmlonly" \
-##!     "m_class{1}=@xmlonly<mcss:class xmlns:mcss=\"http://mcss.mosra.cz/doxygen/\" mcss:class=\"\1\" />@endxmlonly" \
-##!     "m_footernavigation=@xmlonly<mcss:footernavigation xmlns:mcss=\"http://mcss.mosra.cz/doxygen/\" />@endxmlonly" \
-##!     "m_examplenavigation{2}=@xmlonly<mcss:examplenavigation xmlns:mcss=\"http://mcss.mosra.cz/doxygen/\" mcss:page=\"\1\" mcss:prefix=\"\2\" />@endxmlonly" \
-##!     "m_keywords{1}=@xmlonly<mcss:search xmlns:mcss=\"http://mcss.mosra.cz/doxygen/\" mcss:keywords=\"\1\" />@endxmlonly" \
-##!     "m_keyword{3}=@xmlonly<mcss:search xmlns:mcss=\"http://mcss.mosra.cz/doxygen/\" mcss:keyword=\"\1\" mcss:title=\"\2\" mcss:suffix-length=\"\3\" />@endxmlonly" \
-##!     "m_enum_values_as_keywords=@xmlonly<mcss:search xmlns:mcss=\"http://mcss.mosra.cz/doxygen/\" mcss:enum-values-as-keywords=\"true\" />@endxmlonly"
+ALIASES += \
+    "m_div{1}=@xmlonly<mcss:div xmlns:mcss=\"http://mcss.mosra.cz/doxygen/\" mcss:class=\"\1\">@endxmlonly" \
+    "m_enddiv=@xmlonly</mcss:div>@endxmlonly" \
+    "m_span{1}=@xmlonly<mcss:span xmlns:mcss=\"http://mcss.mosra.cz/doxygen/\" mcss:class=\"\1\">@endxmlonly" \
+    "m_endspan=@xmlonly</mcss:span>@endxmlonly" \
+    "m_class{1}=@xmlonly<mcss:class xmlns:mcss=\"http://mcss.mosra.cz/doxygen/\" mcss:class=\"\1\" />@endxmlonly" \
+    "m_footernavigation=@xmlonly<mcss:footernavigation xmlns:mcss=\"http://mcss.mosra.cz/doxygen/\" />@endxmlonly" \
+    "m_examplenavigation{2}=@xmlonly<mcss:examplenavigation xmlns:mcss=\"http://mcss.mosra.cz/doxygen/\" mcss:page=\"\1\" mcss:prefix=\"\2\" />@endxmlonly" \
+    "m_keywords{1}=@xmlonly<mcss:search xmlns:mcss=\"http://mcss.mosra.cz/doxygen/\" mcss:keywords=\"\1\" />@endxmlonly" \
+    "m_keyword{3}=@xmlonly<mcss:search xmlns:mcss=\"http://mcss.mosra.cz/doxygen/\" mcss:keyword=\"\1\" mcss:title=\"\2\" mcss:suffix-length=\"\3\" />@endxmlonly" \
+    "m_enum_values_as_keywords=@xmlonly<mcss:search xmlns:mcss=\"http://mcss.mosra.cz/doxygen/\" mcss:enum-values-as-keywords=\"true\" />@endxmlonly"
diff --git a/docs/md/mainpage.md b/docs/md/mainpage.md
@@ -1,4 +1,4 @@
-\mainpage Introduction
+\mainpage DARMA/magistrate => serialization and checkpointing library
 
 \section ckpt_what_is What is magistrate?
 
@@ -12,9 +12,7 @@ snapshots of objects to disk.
 
 \section License
 
-@m_class{m-note m-dim}
-
-@parblock
+@m_class{m-note m-dim} @parblock
 Copyright 2021 National Technology & Engineering Solutions of Sandia, LLC
 (NTESS). Under the terms of Contract DE-NA0003525 with NTESS, the U.S.
 Government retains certain rights in this software.