[skip-ci] document memory management in streamerinfoactions

Author: ferdymercury

io/io/src/TStreamerInfoActions.cxx

@@ -1514,6 +1514,9 @@ namespace TStreamerInfoActions
    template<typename Looper>
    struct CollectionLooper {
 
+      /// \param loopConfig pointer ownership stays at the caller, a copy is performed and transferred to the
+      /// TActionSequence class (stored as public fLoopConfig internally, will be deleted in destructor) \return unique
+      /// pointer of type TActionSequence
       static std::unique_ptr<TStreamerInfoActions::TActionSequence>
          CreateReadActionSquence(TStreamerInfo &info, TLoopConfiguration *loopConfig)
       {
@@ -1523,6 +1526,9 @@ namespace TStreamerInfoActions
          return actions;
       }
 
+      /// \param loopConfig pointer ownership stays at the caller, a copy is performed and transferred to the
+      /// TActionSequence class (stored as public fLoopConfig internally, will be deleted in destructor) \return unique
+      /// pointer of type TActionSequence
       static std::unique_ptr<TStreamerInfoActions::TActionSequence>
          CreateWriteActionSquence(TStreamerInfo &info, TLoopConfiguration *loopConfig)
       {
@@ -5309,7 +5315,10 @@ TStreamerInfoActions::TActionSequence *TStreamerInfoActions::TActionSequence::Cr
 }
 
 ////////////////////////////////////////////////////////////////////////////////
-/// Create the bundle of the actions necessary for the streaming memberwise of the content described by 'info' into the collection described by 'proxy'
+/// Create the bundle of the actions necessary for the streaming memberwise of the content described by 'info' into the
+/// collection described by 'proxy' \param loopConfig pointer ownership is taken from the caller and transferred to the
+/// TActionSequence class (stored as public fLoopConfig internally, will be deleted in destructor) \return new
+/// `sequence` pointer of type TActionSequence, the memory ownership is transferred to caller, must delete it later
 
 TStreamerInfoActions::TActionSequence *TStreamerInfoActions::TActionSequence::CreateWriteMemberWiseActions(TVirtualStreamerInfo &info, TLoopConfiguration *loopConfig)
 {