Add docstrings

AIDASoft · Jul 31, 2024 · 2d55bd8 · 2d55bd8
1 parent b483649
commit 2d55bd8
Show file tree

Hide file tree

Showing 4 changed files with 28 additions and 0 deletions.
diff --git a/include/podio/RNTupleReader.h b/include/podio/RNTupleReader.h
@@ -97,6 +97,13 @@ class RNTupleReader {
     return m_fileVersion;
   }
 
+  /// Get the (build) version of a datamodel that has been used to write the
+  /// current file
+  ///
+  /// @param name The name of the datamodel
+  ///
+  /// @returns The (build) version of the datamodel if available or an empty
+  ///          optional
   std::optional<podio::version::Version> currentFileVersion(const std::string& name) const {
     return m_datamodelHolder.getDatamodelVersion(name);
   }

diff --git a/include/podio/ROOTReader.h b/include/podio/ROOTReader.h
@@ -104,6 +104,13 @@ class ROOTReader {
     return m_fileVersion;
   }
 
+  /// Get the (build) version of a datamodel that has been used to write the
+  /// current file
+  ///
+  /// @param name The name of the datamodel
+  ///
+  /// @returns The (build) version of the datamodel if available or an empty
+  ///          optional
   std::optional<podio::version::Version> currentFileVersion(const std::string& name) const {
     return m_datamodelHolder.getDatamodelVersion(name);
   }

diff --git a/include/podio/Reader.h b/include/podio/Reader.h
@@ -171,6 +171,13 @@ class Reader {
     return m_self->currentFileVersion();
   }
 
+  /// Get the (build) version of a datamodel that has been used to write the
+  /// current file
+  ///
+  /// @param name The name of the datamodel
+  ///
+  /// @returns The (build) version of the datamodel if available or an empty
+  ///          optional
   std::optional<podio::version::Version> currentFileVersion(const std::string& name) const {
     return m_self->currentFileVersion(name);
   }

diff --git a/include/podio/SIOReader.h b/include/podio/SIOReader.h
@@ -73,6 +73,13 @@ class SIOReader {
     return m_fileVersion;
   }
 
+  /// Get the (build) version of a datamodel that has been used to write the
+  /// current file
+  ///
+  /// @param name The name of the datamodel
+  ///
+  /// @returns The (build) version of the datamodel if available or an empty
+  ///          optional
   std::optional<podio::version::Version> currentFileVersion(const std::string& name) const {
     return m_datamodelHolder.getDatamodelVersion(name);
   }