Fix a few wrong @params (#675)

Co-authored-by: jmcarcell <jmcarcell@users.noreply.github.com>
AIDASoft · Sep 16, 2024 · 27c1635 · 27c1635
1 parent 95a8fa5
commit 27c1635
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 4 deletions.
diff --git a/include/podio/DataSource.h b/include/podio/DataSource.h
@@ -133,8 +133,7 @@ class DataSource : public ROOT::RDF::RDataSource {
   ///
   /// @brief Setup input for the podio::DataSource.
   ///
-  /// @param[in]  Number of events.
-  /// @return     void.
+  /// @param[in] nEvents Number of events.
   ///
   void SetupInput(int nEvents);
 };

diff --git a/include/podio/Writer.h b/include/podio/Writer.h
@@ -89,7 +89,7 @@ class Writer {
   /// @param frame        The Frame to store
   /// @param category     The category name under which this Frame should be
   ///                     stored
-  /// @param collsToWrite The collection names that should be written
+  /// @param collections  The collection names that should be written
   void writeFrame(const podio::Frame& frame, const std::string& category, const std::vector<std::string>& collections) {
     return m_self->writeFrame(frame, category, collections);
   }
@@ -108,7 +108,7 @@ class Writer {
   /// This stores only the desired collections and not the complete frame.
   ///
   /// @param frame        The Frame to store
-  /// @param collsToWrite The collection names that should be written
+  /// @param collections  The collection names that should be written
   void writeEvent(const podio::Frame& frame, const std::vector<std::string>& collections) {
     writeFrame(frame, podio::Category::Event, collections);
   }