Skip to content

Commit 07cfe1b

Browse files
authored
[nfc] Make the documentation doxygen compliant
by dpiparo
1 parent 2742c91 commit 07cfe1b

File tree

1 file changed

+16
-21
lines changed

1 file changed

+16
-21
lines changed

core/meta/inc/TFileMergeInfo.h

Lines changed: 16 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -8,25 +8,20 @@
88
* For the list of contributors see $ROOTSYS/README/CREDITS. *
99
*************************************************************************/
1010

11+
/** \class TFileMergeInfo
12+
A class to pass information from the TFileMerger to the objects being merged.
13+
*/
14+
1115
#ifndef ROOT_TFileMergeInfo
1216
#define ROOT_TFileMergeInfo
1317

14-
//////////////////////////////////////////////////////////////////////////
15-
// //
16-
// TFileMergeInfo //
17-
// //
18-
// This class helps passing information from the TFileMerger to //
19-
// the objects being merged. //
20-
// //
21-
// It provides access to the output directory pointer (fOutputDirectory)//
22-
// to whether or not this is the first time Merge is being called in the//
23-
// serie (for example for TTree, the first time we also need to Clone //
24-
// the object on which Merge is called), and provides for a User Data //
25-
// object to be passed along to each of the calls to Merge. //
26-
// The fUserData object is owned by the TFileMergeInfo and will be //
27-
// deleted when the TFileMerger moves on to the next set of objects. //
28-
// //
29-
//////////////////////////////////////////////////////////////////////////
18+
/// This class provides access to the output directory pointer (fOutputDirectory)
19+
/// whether or not this is the first time Merge is being called in the
20+
/// series (for example for TTree, the first time we also need to Clone
21+
/// the object on which Merge is called), and provides for a User Data
22+
/// object to be passed along to each of the calls to Merge.
23+
/// The fUserData object is owned by the TFileMergeInfo and will be
24+
/// deleted when the TFileMerger moves on to the next set of objects.
3025

3126
#include "TObject.h"
3227

@@ -47,11 +42,11 @@ class TFileMergeInfo {
4742
TFileMergeInfo& operator=(const TFileMergeInfo&) = delete;
4843

4944
public:
50-
TDirectory *fOutputDirectory{nullptr}; // Target directory where the merged object will be written.
51-
Bool_t fIsFirst{kTRUE}; // True if this is the first call to Merge for this series of object.
52-
TString fOptions; // Additional text based option being passed down to customize the merge.
53-
TObject *fUserData{nullptr}; // Place holder to pass extra information. This object will be deleted at the end of each series of objects.
54-
TIOFeatures *fIOFeatures{nullptr}; // Any ROOT IO features that should be explicitly enabled.
45+
TDirectory *fOutputDirectory{nullptr}; ///< Target directory where the merged object will be written.
46+
Bool_t fIsFirst{kTRUE}; ///< True if this is the first call to Merge for this series of object.
47+
TString fOptions; ///< Additional text based option being passed down to customize the merge.
48+
TObject *fUserData{nullptr}; ///< Place holder to pass extra information. This object will be deleted at the end of each series of objects.
49+
TIOFeatures *fIOFeatures{nullptr}; ///< Any ROOT IO features that should be explicitly enabled.
5550

5651
TFileMergeInfo(TDirectory *outputfile) : fOutputDirectory(outputfile) {}
5752
virtual ~TFileMergeInfo() { delete fUserData; } ;

0 commit comments

Comments
 (0)