add function comments

Author: Marcellocosti

PWGHF/D2H/Tasks/taskDplus.cxx

@@ -250,16 +250,15 @@ struct HfTaskDplus {
   /// \param candidate is a particle candidate
   /// \param ptbhad transverse momentum of beauty mother for nonprompt candidates
   /// \param flagBHad transverse momentum of beauty mother for nonprompt candidates
-  /// \param occupancy collision occupancy
   /// \param centrality collision centrality
+  /// \param occupancy collision occupancy
   template <bool isMc, bool isMatched, typename T1>
   void fillSparseML(const T1& candidate,
                     float& ptbhad,
                     int& flagBHad,
                     float& centrality,
                     float& occupancy)
   {
-    LOG(info) << "info " << centrality << " " << occupancy << " " << ptbhad;
     std::vector<float> outputMl = {-999., -999., -999.};
     for (unsigned int iclass = 0; iclass < classMl->size(); iclass++) {
       outputMl[iclass] = candidate.mlProbDplusToPiKPi()[classMl->at(iclass)];
@@ -399,16 +398,15 @@ struct HfTaskDplus {
   /// \param particle is a particle with MC information
   /// \param ptGenB transverse momentum of beauty mother for nonprompt candidates
   /// \param flagGenB transverse momentum of beauty mother for nonprompt candidates
-  /// \param occupancy collision occupancy
   /// \param centrality collision centrality
+  /// \param occupancy collision occupancy
   template <typename T1>
   void fillSparseMCGen(const T1& particle,
                        float& ptGenB,
                        int& flagGenB,
                        float& centrality,
                        float& occupancy)
   {
-    LOG(info) << "Filling sparse MC gen: " << " " << centrality << " " << occupancy;
     auto yGen = RecoDecay::y(particle.pVector(), o2::constants::physics::MassDPlus);
     if (particle.originMcGen() == RecoDecay::OriginType::Prompt) {
       if (storeCentrality && storeOccupancy) {
@@ -436,7 +434,7 @@ struct HfTaskDplus {
   // Run analysis for the reconstructed Dplus candidates from data
   /// \param candidates are reconstructed candidates
   template <bool fillMl, typename T1>
-  void runDataAnalysis(const T1& /*candidates*/, CollisionsCent const&)
+  void runDataAnalysis(const T1& /*candidates*/, CollisionsCent const& /*colls*/)
   {
     float cent{-1.f};
     float occ{-1.f};
@@ -472,9 +470,10 @@ struct HfTaskDplus {
   }
 
   // Run analysis for the reconstructed Dplus candidates with MC matching
-  /// \param candidates are reconstructed candidates
+  /// \param recoCandidates are reconstructed candidates
+  /// \param recoColls are reconstructed collisions
   template <bool fillMl, typename T1>
-  void runMCRecoAnalysis(const T1& /*recoCandidates*/, McRecoCollisionsCent const&)
+  void runMCRecoAnalysis(const T1& /*recoCandidates*/, McRecoCollisionsCent const& /*recoColls*/)
   {
     float cent{-1};
     float occ{-1};
@@ -539,9 +538,10 @@ struct HfTaskDplus {
     }
   }
 
-  // Run analysis for the reconstructed Dplus candidates with MC matching
-  /// \param candidates are reconstructed candidates
-  /// \param mcParticles are particles with MC information
+  // Run analysis for the generated Dplus candidates
+  /// \param mcGenCollisions are the generated MC collisions
+  /// \param mcRecoCollisions are the reconstructed MC collisions
+  /// \param mcGenParticles are the generated MC particle candidates
   template <bool fillMl, typename Cand>
   void runMCGenAnalysis(aod::McCollisions const& mcGenCollisions,
                         McRecoCollisionsCent const& mcRecoCollisions, 
@@ -585,6 +585,7 @@ struct HfTaskDplus {
 
   /// Get the occupancy
   /// \param collision is the collision with the occupancy information
+  /// \return collision occupancy
   template <typename Coll>
   float getOccupancy(Coll const& collision)
   {
@@ -605,8 +606,8 @@ struct HfTaskDplus {
   }
 
   /// \brief Function to get MC collision occupancy
-  /// \param collSlice collection of reconstructed collisions
-  /// \return collision occupancy
+  /// \param collSlice collection of reconstructed collisions associated to a generated one
+  /// \return generated MC collision occupancy
   template <typename CCs>
   int getMcGenCollOccupancy(CCs const& collSlice)
   {
@@ -626,6 +627,7 @@ struct HfTaskDplus {
 
   /// Get the centrality
   /// \param collision is the collision with the centrality information
+  /// \return collision centrality
   template <typename Coll>
   float getCentrality(Coll const& collision)
   {
@@ -645,8 +647,9 @@ struct HfTaskDplus {
     return cent;
   }
 
-  /// Get the centrality
-  /// \param collision is the collision with the centrality information
+  /// \brief Function to get MC collision centrality
+  /// \param collSlice collection of reconstructed collisions associated to a generated one
+  /// \return generated MC collision centrality
   template <typename CCs>
   float getMcGenCollCentrality(CCs const& collSlice) {
     float centrality{-1};
@@ -663,6 +666,7 @@ struct HfTaskDplus {
 
   /// Convert the B hadron mother PDG for non prompt candidates to a flag
   /// \param pdg of the b hadron mother
+  /// \return integer map to specific mothers' PDG codes
   int getBHadMotherFlag(const int& flagBHad)
   {
     if (abs(flagBHad) == o2::constants::physics::kBPlus) {