From b8ebd93d28e1ffa3bd3f7e15377d634c9e19cb0f Mon Sep 17 00:00:00 2001
From: ampdes <abdullahm225@gmail.com>
Date: Tue, 9 Jul 2024 16:19:59 +0200
Subject: [PATCH] Update documentation

---
 cpp/dolfinx/io/ADIOS2_utils.h  |  3 +++
 cpp/dolfinx/io/checkpointing.h | 16 ++++++++++++++++
 2 files changed, 19 insertions(+)

diff --git a/cpp/dolfinx/io/ADIOS2_utils.h b/cpp/dolfinx/io/ADIOS2_utils.h
index 88069425007..8b5ac5f9c9c 100644
--- a/cpp/dolfinx/io/ADIOS2_utils.h
+++ b/cpp/dolfinx/io/ADIOS2_utils.h
@@ -18,6 +18,8 @@
 
 namespace dolfinx::io
 {
+
+/// ADIOS2-based writers/readers
 class ADIOS2Engine
 {
 public:
@@ -27,6 +29,7 @@ class ADIOS2Engine
   /// @param[in] tag The ADIOS2 object name
   /// @param[in] engine ADIOS2 engine type. See
   /// https://adios2.readthedocs.io/en/latest/engines/engines.html.
+  /// @param[in] mode ADIOS2 mode, default is Write or Read
   ADIOS2Engine(MPI_Comm comm, const std::filesystem::path& filename,
                std::string tag, std::string engine = "BP5",
                const adios2::Mode mode = adios2::Mode::Write);
diff --git a/cpp/dolfinx/io/checkpointing.h b/cpp/dolfinx/io/checkpointing.h
index 48437740031..1e363fe63f5 100644
--- a/cpp/dolfinx/io/checkpointing.h
+++ b/cpp/dolfinx/io/checkpointing.h
@@ -20,10 +20,26 @@
 namespace dolfinx::io::checkpointing
 {
 
+  /// @brief Write mesh to a file.
+  ///
+  /// @param[in] comm The MPI communicator to open the file on
+  /// @param[in] filename Name of output file
+  /// @param[in] tag ADIOS2 tag for IO
+  /// @param[in] mesh Mesh of type float to write to the file
+  /// @note This is experimental version. Expected would be to
+  /// pass ADIOS2Engine object.
 void write(MPI_Comm comm, std::string filename, std::string tag,
            //    adios2::IO io, adios2::Engine engine,
            std::shared_ptr<dolfinx::mesh::Mesh<float>> mesh);
 
+  /// @brief Write mesh to a file.
+  ///
+  /// @param[in] comm The MPI communicator to open the file on
+  /// @param[in] filename Name of output file
+  /// @param[in] tag ADIOS2 tag for IO
+  /// @param[in] mesh Mesh of type double to write to the file
+  /// @note This is experimental version. Expected would be to
+  /// pass ADIOS2Engine object.
 void write(MPI_Comm comm, std::string filename, std::string tag,
            //    adios2::IO io, adios2::Engine engine,
            std::shared_ptr<dolfinx::mesh::Mesh<double>> mesh);