From 3caf9885b0cbdbcee7e312dd6f1957eb41438873 Mon Sep 17 00:00:00 2001 From: Danilo Piparo <danilo.piparo@cern.ch> Date: Tue, 18 Sep 2018 13:20:18 +0200 Subject: [PATCH] [Doc] Clarify doc of TTree::Branch --- tree/tree/src/TTree.cxx | 28 ++++++++++++++-------------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/tree/tree/src/TTree.cxx b/tree/tree/src/TTree.cxx index 3c0f85ee236..cd59012b52c 100644 --- a/tree/tree/src/TTree.cxx +++ b/tree/tree/src/TTree.cxx @@ -1666,11 +1666,11 @@ Int_t TTree::Branch(TList* li, Int_t bufsize /* = 32000 */ , Int_t splitlevel /* /// identical branch names. By default collections have a name equal to /// the corresponding class name, e.g. the default name for a TList is "TList". /// -/// And in general in any cases two or more master branches contain subbranches +/// And in general, in case two or more master branches contain subbranches /// with identical names, one must add a "." (dot) character at the end -/// of the master branch name. This will force the name of the subbranch -/// to be master.subbranch instead of simply subbranch. -/// This situation happens when the top level object (say event) +/// of the master branch name. This will force the name of the subbranches +/// to be of the form `master.subbranch` instead of simply `subbranch`. +/// This situation happens when the top level object /// has two or more members referencing the same class. /// For example, if a Tree has two branches B1 and B2 corresponding /// to objects of the same class MyClass, one can do: @@ -1926,11 +1926,11 @@ TBranch* TTree::Branch(const char* name, const char* classname, void* addobj, In /// /// IMPORTANT NOTE about branch names: /// -/// In case two or more master branches contain subbranches with -/// identical names, one must add a "." (dot) character at the end -/// of the master branch name. This will force the name of the subbranch -/// to be master.subbranch instead of simply subbranch. -/// This situation happens when the top level object (say event) +/// And in general, in case two or more master branches contain subbranches +/// with identical names, one must add a "." (dot) character at the end +/// of the master branch name. This will force the name of the subbranches +/// to be of the form `master.subbranch` instead of simply `subbranch`. +/// This situation happens when the top level object /// has two or more members referencing the same class. /// For example, if a Tree has two branches B1 and B2 corresponding /// to objects of the same class MyClass, one can do: @@ -2250,11 +2250,11 @@ TBranch* TTree::BranchRef() /// /// IMPORTANT NOTE about branch names: /// -/// In case two or more master branches contain subbranches with -/// identical names, one must add a "." (dot) character at the end -/// of the master branch name. This will force the name of the subbranch -/// to be master.subbranch instead of simply subbranch. -/// This situation happens when the top level object (say event) +/// And in general, in case two or more master branches contain subbranches +/// with identical names, one must add a "." (dot) character at the end +/// of the master branch name. This will force the name of the subbranches +/// to be of the form `master.subbranch` instead of simply `subbranch`. +/// This situation happens when the top level object /// has two or more members referencing the same class. /// For example, if a Tree has two branches B1 and B2 corresponding /// to objects of the same class MyClass, one can do: -- GitLab