Skip to content

Commit 9fdfd5c

Browse files
committed
[skip-ci][docs] Rename top-level groups for uniformity
Also put TreePlayer library under TTree and REve under Graphics
1 parent f8e2799 commit 9fdfd5c

8 files changed

Lines changed: 10 additions & 8 deletions

File tree

geom/geom/doc/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
\defgroup Geometry The Geometry Package
1+
\defgroup Geometry Geometry
22

33

44
The %ROOT geometry package is a tool for building, browsing,

graf3d/eve7/src/REveTypes.cxx

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,8 @@ using namespace ROOT::Experimental;
1717
namespace REX = ROOT::Experimental;
1818

1919
/**
20-
* \defgroup REve Event display with ROOT7
20+
* \defgroup REve Event display (REve)
21+
* \ingroup Graphics
2122
* \brief Modern version of "Event display" using ROOT7
2223
*/
2324

hist/doc/Hist.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
\defgroup Hist Histogram Library
1+
\defgroup Hist Histograms
22
\brief A general description of the Histogram library is documented in the class TH1.
33

44
ROOT supports the following histogram types:

io/io/doc/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
\defgroup IO Input/Output Library
1+
\defgroup IO I/O
22

33
The library collecting the ROOT classes dedicated to data input and output.
44

tree/dataframe/inc/ROOT/RDataFrame.hxx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
*************************************************************************/
1010

1111
/**
12-
\defgroup dataframe Dataframe
12+
\defgroup dataframe RDataFrame
1313
ROOT's RDataFrame allows to analyse data stored in TTrees with a high level interface.
1414
*/
1515

tree/ntuple/doc/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
\defgroup NTuple RNTuple-related classes
1+
\defgroup NTuple RNTuple
22
\brief Classes designed for columnar data storage in modern ROOT
33

44
# RNTuple Introduction

tree/tree/src/TTree.cxx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
* For the list of contributors see $ROOTSYS/README/CREDITS. *
1010
*************************************************************************/
1111
/**
12-
\defgroup tree Tree Library
12+
\defgroup tree TTree
1313
1414
RNTuple is the modern way of storing columnar datasets: please consider to use it
1515
before starting new projects based on TTree and related classes.

tree/treeplayer/src/TTreePlayer.cxx

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,8 @@
1010
*************************************************************************/
1111

1212
/**
13-
* \defgroup treeplayer TreePlayer Library
13+
* \defgroup treeplayer TTreePlayer
14+
* \ingroup tree
1415
* \brief It contains utilities to plot data stored in a TTree.
1516
* \note See also Tree package documentation
1617
* \note See also Chapter about Trees and Selectors in the Users Guide

0 commit comments

Comments
 (0)