Fix a few more typos and param argument name mismatches

AIDASoft · Apr 3, 2024 · 5a9ae8f · 5a9ae8f
1 parent 298902f
commit 5a9ae8f
Show file tree

Hide file tree

Showing 4 changed files with 7 additions and 7 deletions.
diff --git a/include/podio/Frame.h b/include/podio/Frame.h
@@ -248,8 +248,8 @@ class Frame {
   /// This is a dedicated overload for enabling on-the-fly conversion from
   /// an initializer_list of string literals
   ///
-  /// @param key   The name under which this parameter should be stored
-  /// @param value The value of the parameter. A copy will be put into the Frame
+  /// @param key    The name under which this parameter should be stored
+  /// @param values The values of the parameter. A copy will be put into the Frame
   inline void putParameter(const std::string& key, std::vector<std::string> values) {
     putParameter<std::vector<std::string>>(key, std::move(values));
   }
@@ -262,8 +262,8 @@ class Frame {
   ///
   /// @tparam T    The type of the parameter. Has to be one of the types that
   ///              is supported by GenericParameters
-  /// @param key   The name under which this parameter should be stored
-  /// @param value The value of the parameter. A copy will be put into the Frame
+  /// @param key    The name under which this parameter should be stored
+  /// @param values The values of the parameter. A copy will be put into the Frame
   template <typename T, typename = std::enable_if_t<detail::isInTuple<T, SupportedGenericDataTypes>>>
   inline void putParameter(const std::string& key, std::initializer_list<T>&& values) {
     putParameter<std::vector<T>>(key, std::move(values));

diff --git a/include/podio/RNTupleReader.h b/include/podio/RNTupleReader.h
@@ -55,7 +55,7 @@ class RNTupleReader {
   ///   "settings", e.g. they are outputs of a batched process.
   ///
   /// @param filenames The filenames of all input files that should be read
-  void openFiles(const std::vector<std::string>& filename);
+  void openFiles(const std::vector<std::string>& filenames);
 
   /// Read the next data entry for a given category.
   ///

diff --git a/include/podio/ROOTLegacyReader.h b/include/podio/ROOTLegacyReader.h
@@ -71,7 +71,7 @@ class ROOTLegacyReader {
   /// "settings", e.g. they are outputs of a batched process.
   ///
   /// @param filenames The filenames of all input files that should be read
-  void openFiles(const std::vector<std::string>& filename);
+  void openFiles(const std::vector<std::string>& filenames);
 
   /// Read the next data entry from which a Frame can be constructed.
   ///

diff --git a/include/podio/SIOReader.h b/include/podio/SIOReader.h
@@ -62,7 +62,7 @@ class SIOReader {
 
   /// Open the passed file for reading.
   ///
-  /// @parame filename The path to the file to read from
+  /// @param filename The path to the file to read from
   void openFile(const std::string& filename);
 
   /// Get the build version of podio that has been used to write the current