Skip to content

Commit 61c9d54

Browse files
ferdymercurydpiparo
ferdymercury
authored and
dpiparo
committed
[skip-ci] convert old THtml class comments to doxygen format
1 parent 2361862 commit 61c9d54

23 files changed

+67
-304
lines changed

‎bindings/pyroot/pythonizations/inc/TPyDispatcher.h

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,6 @@
1212
#ifndef ROOT_TPyDispatcher
1313
#define ROOT_TPyDispatcher
1414

15-
//////////////////////////////////////////////////////////////////////////////
16-
// //
17-
// TPyDispatcher //
18-
// //
19-
// Dispatcher for C++ callbacks into Python code. //
20-
// //
21-
//////////////////////////////////////////////////////////////////////////////
22-
2315
// ROOT
2416
#include "TObject.h"
2517

@@ -51,6 +43,7 @@ struct Event_t;
5143
struct _object;
5244
typedef _object PyObject;
5345

46+
/// Dispatcher for C++ callbacks into Python code.
5447
class TPyDispatcher : public TObject {
5548
public:
5649
TPyDispatcher(PyObject *callable);

‎bindings/tpython/inc/TPyArg.h

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,6 @@
1212
#ifndef ROOT_TPyArg
1313
#define ROOT_TPyArg
1414

15-
//////////////////////////////////////////////////////////////////////////////
16-
// //
17-
// TPyArg //
18-
// //
19-
// Morphing argument type from evaluating python expressions. //
20-
// //
21-
//////////////////////////////////////////////////////////////////////////////
22-
2315
// ROOT
2416
#include "Rtypes.h"
2517

@@ -30,6 +22,7 @@ typedef _object PyObject;
3022
// Standard
3123
#include <vector>
3224

25+
/// Morphing argument type from evaluating python expressions.
3326
class TPyArg {
3427
public:
3528
// converting constructors

‎bindings/tpython/inc/TPyReturn.h

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,21 +12,14 @@
1212
#ifndef ROOT_TPyReturn
1313
#define ROOT_TPyReturn
1414

15-
//////////////////////////////////////////////////////////////////////////////
16-
// //
17-
// TPyReturn //
18-
// //
19-
// Morphing return type from evaluating python expressions. //
20-
// //
21-
//////////////////////////////////////////////////////////////////////////////
22-
2315
// ROOT
2416
#include "Rtypes.h"
2517

2618
// Python
2719
struct _object;
2820
typedef _object PyObject;
2921

22+
/// Morphing return type from evaluating python expressions.
3023
class TPyReturn {
3124
public:
3225
TPyReturn();

‎bindings/tpython/inc/TPython.h

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,6 @@
1212
#ifndef ROOT_TPython
1313
#define ROOT_TPython
1414

15-
//////////////////////////////////////////////////////////////////////////////
16-
// //
17-
// TPython //
18-
// //
19-
// Access to the python interpreter and API onto PyROOT. //
20-
// //
21-
//////////////////////////////////////////////////////////////////////////////
22-
2315
// ROOT
2416
#include "TObject.h"
2517

@@ -40,6 +32,7 @@ inline void SwapWithObjAtAddr(T &a, std::intptr_t b) { std::swap(a, *reinterpret
4032
}
4133
}
4234

35+
// Access to the python interpreter and API onto PyROOT.
4336
class TPython {
4437

4538
private:

‎core/gui/inc/TContextMenu.h

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -13,16 +13,6 @@
1313
#define ROOT_TContextMenu
1414

1515

16-
////////////////////////////////////////////////////////////////////////////////
17-
// //
18-
// TContextMenu //
19-
// //
20-
// This class provides an interface to context sensitive popup menus. //
21-
// These menus pop up when the user hits the right mouse button, and //
22-
// are destroyed when the menu pops downs. //
23-
// //
24-
////////////////////////////////////////////////////////////////////////////////
25-
2616
#include "TNamed.h"
2717

2818
#ifdef R__LESS_INCLUDES

‎core/gui/inc/TContextMenuImp.h

Lines changed: 1 addition & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -12,24 +12,14 @@
1212
#ifndef ROOT_TContextMenuImp
1313
#define ROOT_TContextMenuImp
1414

15-
16-
////////////////////////////////////////////////////////////////////////////////
17-
// //
18-
// TContextMenuImp //
19-
// //
20-
// This class provides an interface to GUI independent //
21-
// context sensitive popup menus. //
22-
// //
23-
////////////////////////////////////////////////////////////////////////////////
24-
2515
#include "Rtypes.h"
2616

2717
class TContextMenu;
2818
class TObject;
2919
class TMethod;
3020
class TFunction;
3121

32-
22+
// interface to GUI independent context sensitive popup menus.
3323
class TContextMenuImp {
3424

3525
protected:

‎core/gui/inc/TControlBarImp.h

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,20 +13,13 @@
1313
#define ROOT_TControlBarImp
1414

1515

16-
////////////////////////////////////////////////////////////////////////////////
17-
// //
18-
// TControlBarImp //
19-
// //
20-
// ABC describing GUI independent control bar (see TControlBar) //
21-
// //
22-
////////////////////////////////////////////////////////////////////////////////
23-
2416
#include "Rtypes.h"
2517

2618

2719
class TControlBar;
2820
class TControlBarButton;
2921

22+
/// @see TControlBar
3023
class TControlBarImp {
3124

3225
protected:

‎core/gui/inc/TInspectorImp.h

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -12,16 +12,6 @@
1212
#ifndef ROOT_TInspectorImp
1313
#define ROOT_TInspectorImp
1414

15-
16-
////////////////////////////////////////////////////////////////////////////////
17-
// //
18-
// TInspectorImp //
19-
// //
20-
// ABC describing GUI independent object inspector (abstration mainly needed //
21-
// for Win32. On X11 systems it currently uses a standard TCanvas). //
22-
// //
23-
////////////////////////////////////////////////////////////////////////////////
24-
2515
#include "Rtypes.h"
2616

2717
class TObject;

‎core/meta/inc/TInterpreterValue.h

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -9,17 +9,17 @@
99
* For the list of contributors see $ROOTSYS/README/CREDITS. *
1010
******************************************************************************/
1111

12-
////////////////////////////////////////////////////////////////////////////////
13-
// //
14-
// Class representing a value coming from the interpreter. Its main use case //
15-
// is to TCallFunc. When TCallFunc returns by-value, i.e. a temporary //
16-
// variable, its lifetime has to be extended. TInterpreterValue provides a //
17-
// way to extend the temporaries lifetime and gives the user to control it. //
18-
// //
19-
// The class needs to be derived from for the actual interpreter, //
20-
// see TClingValue. //
21-
// //
22-
////////////////////////////////////////////////////////////////////////////////
12+
/////////////////////////////////////////////////////////////////////////////////
13+
/// //
14+
/// Class representing a value coming from the interpreter. Its main use case //
15+
/// is to TCallFunc. When TCallFunc returns by-value, i.e. a temporary //
16+
/// variable, its lifetime has to be extended. TInterpreterValue provides a //
17+
/// way to extend the temporaries lifetime and gives the user to control it. //
18+
/// //
19+
/// The class needs to be derived from for the actual interpreter, //
20+
/// see TClingValue. //
21+
/// //
22+
/////////////////////////////////////////////////////////////////////////////////
2323

2424
#ifndef ROOT_TInterpreterValue
2525
#define ROOT_TInterpreterValue

‎core/meta/inc/TStreamerElement.h

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,6 @@
1212
#ifndef ROOT_TStreamerElement
1313
#define ROOT_TStreamerElement
1414

15-
//////////////////////////////////////////////////////////////////////////
16-
// //
17-
// TStreamerElement //
18-
// //
19-
// Describe one element (data member) to be Streamed //
20-
// //
21-
//////////////////////////////////////////////////////////////////////////
22-
2315
#include "TNamed.h"
2416

2517
#include "ESTLType.h"
@@ -29,6 +21,7 @@ class TClass;
2921
class TStreamerBasicType;
3022
class TVirtualStreamerInfo;
3123

24+
/// Describe one element (data member) to be Streamed
3225
class TStreamerElement : public TNamed {
3326

3427
private:

‎core/metacling/src/TClingValue.h

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -9,17 +9,17 @@
99
* For the list of contributors see $ROOTSYS/README/CREDITS. *
1010
******************************************************************************/
1111

12-
////////////////////////////////////////////////////////////////////////////////
13-
// //
14-
// Class representing a value coming from cling. Its main use case //
15-
// is to TCallFunc. When TCallFunc returns by-value, i.e. a temporary //
16-
// variable, its lifetime has to be extended. TClingValue provides a //
17-
// way to extend the temporaries lifetime and gives the user to control it. //
18-
// //
19-
// The class is used to hide the implementation details of //
20-
// cling::Value. //
21-
// //
22-
////////////////////////////////////////////////////////////////////////////////
12+
/////////////////////////////////////////////////////////////////////////////////
13+
/// //
14+
/// Class representing a value coming from cling. Its main use case //
15+
/// is to TCallFunc. When TCallFunc returns by-value, i.e. a temporary //
16+
/// variable, its lifetime has to be extended. TClingValue provides a //
17+
/// way to extend the temporaries lifetime and gives the user to control it. //
18+
/// //
19+
/// The class is used to hide the implementation details of //
20+
/// cling::Value. //
21+
/// //
22+
/////////////////////////////////////////////////////////////////////////////////
2323

2424
#ifndef ROOT_TClingValue
2525
#define ROOT_TClingValue

‎core/winnt/inc/TWinNTSystem.h

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -13,14 +13,6 @@
1313
#ifndef ROOT_TWinNTSystem
1414
#define ROOT_TWinNTSystem
1515

16-
//////////////////////////////////////////////////////////////////////////
17-
// //
18-
// TWinNTSystem //
19-
// //
20-
// Class providing an interface to the Windows NT Operating System. //
21-
// //
22-
//////////////////////////////////////////////////////////////////////////
23-
2416
#include "TSystem.h"
2517
#include <string>
2618

@@ -54,7 +46,7 @@ struct group {
5446
char **gr_mem; // group members
5547
};
5648

57-
49+
/// Class providing an interface to the Windows NT Operating System.
5850
class TWinNTSystem : public TSystem {
5951
public:
6052
// pointer to message handler func

‎geom/geom/inc/TGeoBoolNode.h

Lines changed: 3 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -92,12 +92,7 @@ class TGeoBoolNode : public TObject {
9292
ClassDefOverride(TGeoBoolNode, 1) // a boolean node
9393
};
9494

95-
//////////////////////////////////////////////////////////////////////////////
96-
// //
97-
// TGeoUnion - Boolean node representing a union between two components. //
98-
// //
99-
//////////////////////////////////////////////////////////////////////////////
100-
95+
/// Boolean node representing a union between two components.
10196
class TGeoUnion : public TGeoBoolNode {
10297
public:
10398
// constructors
@@ -128,13 +123,7 @@ class TGeoUnion : public TGeoBoolNode {
128123
ClassDefOverride(TGeoUnion, 1) // union node
129124
};
130125

131-
//////////////////////////////////////////////////////////////////////////////
132-
// //
133-
// TGeoIntersection - Boolean node representing an intersection between two //
134-
// components. //
135-
// //
136-
//////////////////////////////////////////////////////////////////////////////
137-
126+
/// Boolean node representing an intersection between two components.
138127
class TGeoIntersection : public TGeoBoolNode {
139128
public:
140129
// constructors
@@ -165,12 +154,7 @@ class TGeoIntersection : public TGeoBoolNode {
165154
ClassDefOverride(TGeoIntersection, 1) // intersection node
166155
};
167156

168-
//////////////////////////////////////////////////////////////////////////////
169-
// //
170-
// TGeoSubtraction - Boolean node representing a subtraction. //
171-
// //
172-
//////////////////////////////////////////////////////////////////////////////
173-
157+
/// Boolean node representing a subtraction
174158
class TGeoSubtraction : public TGeoBoolNode {
175159
public:
176160
// constructors

‎geom/geom/inc/TGeoCompositeShape.h

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -14,16 +14,11 @@
1414

1515
#include "TGeoBBox.h"
1616

17-
/////////////////////////////////////////////////////////////////////////////
18-
// //
19-
// TGeoCompositeShape - composite shape class. A composite shape contains //
20-
// a list of primitive shapes, the list of corresponding transformations //
21-
// and a boolean finder handling boolean operations among components. //
22-
// //
23-
/////////////////////////////////////////////////////////////////////////////
24-
2517
class TGeoBoolNode;
2618

19+
/// @details A composite shape contains
20+
/// a list of primitive shapes, the list of corresponding transformations
21+
/// and a boolean finder handling boolean operations among components.
2722
class TGeoCompositeShape : public TGeoBBox {
2823
private:
2924
// data members

0 commit comments

Comments
 (0)