Skip to content

Commit 6499db5

Browse files
Olivier Delauneguitargeek
authored andcommitted
Format comments
1 parent aca7362 commit 6499db5

2 files changed

Lines changed: 18 additions & 18 deletions

File tree

hist/hist/src/TH2.cxx

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1626,11 +1626,11 @@ TH2 *TH2::Rebin(Int_t ngroup, const char *newname, const Double_t *xbins)
16261626
////////////////////////////////////////////////////////////////////////////////
16271627
/// Rebin this histogram grouping nxgroup/nygroup bins along the xaxis/yaxis together.
16281628
///
1629-
/// #### case 1 xbins=0 || ybins=0
1629+
/// #### case 1 `xbins`=0 || `ybins`=0
16301630
///
1631-
/// if newname is not blank a new temporary histogram hnew is created.
1631+
/// if `newname` is not blank a new temporary histogram hnew is created.
16321632
/// else the current histogram is modified (default)
1633-
/// The parameter nxgroup/nygroup indicate how many bins along the xaxis/yaxis of this
1633+
/// The parameters `nxgroup`/`nygroup` indicate how many bins along the xaxis/yaxis of this
16341634
/// have to me merged into one bin of hnew
16351635
/// If the original histogram has errors stored (via Sumw2), the resulting
16361636
/// histograms has new errors correctly calculated.
@@ -1644,30 +1644,30 @@ TH2 *TH2::Rebin(Int_t ngroup, const char *newname, const Double_t *xbins)
16441644
/// // merging 5 bins of h1 along the yaxis in one bin
16451645
/// ~~~
16461646
///
1647-
/// NOTE : If nxgroup/nygroup is not an exact divider of the number of bins,
1647+
/// \note : If `nxgroup`/`nygroup` is not an exact divider of the number of bins,
16481648
/// along the xaxis/yaxis the top limit(s) of the rebinned histogram
16491649
/// is changed to the upper edge of the xbin=newxbins*nxgroup resp.
16501650
/// ybin=newybins*nygroup and the corresponding bins are added to
16511651
/// the overflow bin.
16521652
/// Statistics will be recomputed from the new bin contents.
16531653
///
1654-
/// #### case 2 xbins!=0 && ybins!=0
1654+
/// #### case 2 `xbins`!=0 && `ybins`!=0
16551655
///
1656-
/// A new histogram is created (you should specify newname).
1657-
/// The parameter nxgroup (nygroup) is the number of variable size bins for the x-axis
1656+
/// A new histogram is created (you should specify `newname`).
1657+
/// The parameter `nxgroup` (`nygroup`) is the number of variable size bins for the x-axis
16581658
/// (y-axis) in the created histogram.
1659-
/// The arrays xbins and ybins must contain nxgroup+1 and nygroups+1 elements
1659+
/// The arrays `xbins` and `ybins` must contain `nxgroup+1` and `nygroups+1` elements
16601660
/// that represent the low-edges of the x and y bins respectively.
16611661
/// If the original histogram has errors stored (via Sumw2), the resulting
16621662
/// histograms has new errors correctly calculated.
16631663
///
1664-
/// NOTE: The bin edges specified in xbins and ybins should correspond
1664+
/// \note The bin edges specified in xbins and ybins should correspond
16651665
/// to bin edges in the original histogram. If a bin edge in the new histogram
16661666
/// is in the middle of a bin in the original histogram, all entries in
16671667
/// the split bin in the original histogram will be transfered to the
16681668
/// lower of the two possible bins in the new histogram. This is
16691669
/// probably not what you want. A warning message is emitted in this
1670-
/// case
1670+
/// case.
16711671
///
16721672
/// examples: if h2 is an existing TH2F histogram with 100 bins on x-axis
16731673
/// and 100 bins y-axis

hist/hist/src/TProfile2D.cxx

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1522,11 +1522,11 @@ void TProfile2D::ExtendAxis(Double_t x, TAxis *axis)
15221522
////////////////////////////////////////////////////////////////////////////////
15231523
/// Rebin this histogram grouping nxgroup/nygroup bins along the xaxis/yaxis together.
15241524
///
1525-
/// ## case 1 xbins=0 || ybins=0
1525+
/// ## case 1 `xbins`=0 || `ybins`=0
15261526
///
1527-
/// if newname is not blank a new profile hnew is created.
1527+
/// if `newname` is not blank a new profile hnew is created.
15281528
/// else the current histogram is modified (default)
1529-
/// The parameter nxgroup/nygroup indicate how many bins along the xaxis/yaxis of this
1529+
/// The parameters `nxgroup`/`nygroup` indicate how many bins along the xaxis/yaxis of this
15301530
/// have to be merged into one bin of hnew
15311531
/// If the original profile has errors stored (via Sumw2), the resulting
15321532
/// profile has new errors correctly calculated.
@@ -1542,18 +1542,18 @@ void TProfile2D::ExtendAxis(Double_t x, TAxis *axis)
15421542
/// // merging 5 bins of hpxpy along the yaxis in one bin
15431543
/// ~~~
15441544
///
1545-
/// NOTE : If nxgroup/nygroup is not an exact divider of the number of bins,
1545+
/// \note : If `nxgroup`/`nygroup` is not an exact divider of the number of bins,
15461546
/// along the xaxis/yaxis the top limit(s) of the rebinned profile
15471547
/// is changed to the upper edge of the xbin=newxbins*nxgroup resp.
15481548
/// ybin=newybins*nygroup and the remaining bins are added to
15491549
/// the overflow bin.
15501550
/// Statistics will be recomputed from the new bin contents.
15511551
///
1552-
/// ## case 2 xbins!=0 && ybins!=0
1553-
/// a new profile is created (you should specify newname).
1554-
/// The parameter nxgroup (nygroup) is the number of variable size bins for the x-axis
1552+
/// ## case 2 `xbins`!=0 && `ybins`!=0
1553+
/// a new profile is created (you should specify `newname`).
1554+
/// The parameter `nxgroup` (`nygroup`) is the number of variable size bins for the x-axis
15551555
/// (y-axis) in the created profile.
1556-
/// The arrays xbins and ybins must contain nxgroup+1 and nygroup+1 elements that
1556+
/// The arrays `xbins` and `ybins` must contain `nxgroup+1` and `nygroup+1` elements that
15571557
/// represent the low-edge of the x and y bins respectively.
15581558
/// The data of the old bins are added to the new bin which contains the bin center
15591559
/// of the old bins. It is possible that information from the old binning are attached

0 commit comments

Comments
 (0)