From 53a59b781f2e98efbabcfa69b391b05ecf6a96e2 Mon Sep 17 00:00:00 2001
From: Olivier Couet <olivier.couet@cern.ch>
Date: Fri, 21 Aug 2015 11:24:34 +0200
Subject: [PATCH] Doxygen
---
tree/treeplayer/src/TSelectorDraw.cxx | 49 +++++++++++---------
tree/treeplayer/src/TSelectorEntries.cxx | 57 +++++++++++-------------
2 files changed, 54 insertions(+), 52 deletions(-)
diff --git a/tree/treeplayer/src/TSelectorDraw.cxx b/tree/treeplayer/src/TSelectorDraw.cxx
index b907f0c1b77..9fbe907731b 100644
--- a/tree/treeplayer/src/TSelectorDraw.cxx
+++ b/tree/treeplayer/src/TSelectorDraw.cxx
@@ -9,13 +9,9 @@
* For the list of contributors see $ROOTSYS/README/CREDITS. *
*************************************************************************/
-//////////////////////////////////////////////////////////////////////////
-// //
-// TSelectorDraw //
-// //
-// A specialized TSelector for TTree::Draw. //
-// //
-//////////////////////////////////////////////////////////////////////////
+/** \class TSelectorDraw
+A specialized TSelector for TTree::Draw.
+*/
#include "TSelectorDraw.h"
#include "TROOT.h"
@@ -935,20 +931,25 @@ void TSelectorDraw::ClearFormula()
////////////////////////////////////////////////////////////////////////////////
/// Compile input variables and selection expression.
///
-/// varexp is an expression of the general form e1:e2:e3
-/// where e1,etc is a formula referencing a combination of the columns
-/// Example:
+/// varexp is an expression of the general form e1:e2:e3
+/// where e1,etc is a formula referencing a combination of the columns
+///
+/// Example:
+///
/// varexp = x simplest case: draw a 1-Dim distribution of column named x
/// = sqrt(x) : draw distribution of sqrt(x)
/// = x*y/z
/// = y:sqrt(x) 2-Dim dsitribution of y versus sqrt(x)
///
-/// selection is an expression with a combination of the columns
-/// Example:
-/// selection = "x<y && sqrt(z)>3.2"
-/// in a selection all the C++ operators are authorized
+/// selection is an expression with a combination of the columns
+///
+/// Example:
///
-/// Return kFALSE if any of the variable is not compilable.
+/// selection = "x<y && sqrt(z)>3.2"
+///
+/// in a selection all the C++ operators are authorized
+///
+/// Return kFALSE if any of the variable is not compilable.
Bool_t TSelectorDraw::CompileVariables(const char *varexp, const char *selection)
{
@@ -1021,17 +1022,23 @@ Bool_t TSelectorDraw::CompileVariables(const char *varexp, const char *selection
/// Return the last values corresponding to the i-th component
/// of the formula being processed (where the component are ':' separated).
/// The actual number of entries is:
+///
/// GetSelectedRows() % tree->GetEstimate()
+///
/// Note GetSelectedRows currently returns the actual number of values plotted
/// and thus if the formula contains arrays, this number might be greater than
/// the number of entries in the trees.
+///
/// By default TTree::Draw creates the arrays obtained
-/// with all GetVal and GetW with a length corresponding to the
-/// parameter fEstimate. By default fEstimate=10000 and can be modified
-/// via TTree::SetEstimate. A possible recipee is to do
-/// tree->SetEstimate(tree->GetEntries());
-/// You must call SetEstimate if the expected number of selected rows
-/// is greater than 10000.
+/// with all GetVal and GetW with a length corresponding to the
+/// parameter fEstimate. By default fEstimate=10000 and can be modified
+/// via TTree::SetEstimate. A possible recipee is to do
+///
+/// tree->SetEstimate(tree->GetEntries());
+///
+/// You must call SetEstimate if the expected number of selected rows
+/// is greater than 10000.
+///
/// See TTree::Draw for additional details.
Double_t* TSelectorDraw::GetVal(Int_t i) const
diff --git a/tree/treeplayer/src/TSelectorEntries.cxx b/tree/treeplayer/src/TSelectorEntries.cxx
index 0f82404ee79..946a72d1289 100644
--- a/tree/treeplayer/src/TSelectorEntries.cxx
+++ b/tree/treeplayer/src/TSelectorEntries.cxx
@@ -9,35 +9,30 @@
* For the list of contributors see $ROOTSYS/README/CREDITS. *
*************************************************************************/
-//////////////////////////////////////////////////////////////////////////
-// //
-// TSelectorEntries //
-// //
-// //
-//////////////////////////////////////////////////////////////////////////
-
-// The class is derived from the ROOT class TSelector. For more
-// information on the TSelector framework see
-// $ROOTSYS/README/README.SELECTOR or the ROOT User Manual.
-
-// The following methods are defined in this file:
-// Begin(): called everytime a loop on the tree starts,
-// a convenient place to create your histograms.
-// SlaveBegin(): called after Begin(), when on PROOF called only on the
-// slave servers.
-// Process(): called for each event, in this function you decide what
-// to read and fill your histograms.
-// SlaveTerminate: called at the end of the loop on the tree, when on PROOF
-// called only on the slave servers.
-// Terminate(): called at the end of the loop on the tree,
-// a convenient place to draw/fit your histograms.
-//
-// To use this file, try the following session on your Tree T:
-//
-// Root > T->Process("TSelectorEntries.C")
-// Root > T->Process("TSelectorEntries.C","some options")
-// Root > T->Process("TSelectorEntries.C+")
-//
+/** \class TSelectorEntries
+The class is derived from the ROOT class TSelector. For more
+information on the TSelector framework see
+$ROOTSYS/README/README.SELECTOR or the ROOT User Manual.
+
+The following methods are defined in this file:
+
+ - Begin(): called everytime a loop on the tree starts,
+ a convenient place to create your histograms.
+ - SlaveBegin(): called after Begin(), when on PROOF called only on the
+ slave servers.
+ - Process(): called for each event, in this function you decide what
+ to read and fill your histograms.
+ - SlaveTerminate: called at the end of the loop on the tree, when on PROOF
+ called only on the slave servers.
+ - Terminate(): called at the end of the loop on the tree,
+ a convenient place to draw/fit your histograms.
+
+To use this file, try the following session on your Tree T:
+
+ Root > T->Process("TSelectorEntries.C")
+ Root > T->Process("TSelectorEntries.C","some options")
+ Root > T->Process("TSelectorEntries.C+")
+*/
#include "TSelectorEntries.h"
#include "TTree.h"
@@ -109,7 +104,7 @@ void TSelectorEntries::SlaveBegin(TTree *tree)
}
////////////////////////////////////////////////////////////////////////////////
-///read entry
+/// Read entry.
Int_t TSelectorEntries::GetEntry(Long64_t entry, Int_t getall)
{
@@ -192,7 +187,7 @@ Bool_t TSelectorEntries::Process(Long64_t /* entry */)
}
////////////////////////////////////////////////////////////////////////////////
-///set the selection expression
+/// Set the selection expression.
void TSelectorEntries::SetSelection(const char *selection)
{
--
GitLab