Skip to content

Commit 2d47cab

Browse files
silverweedsilverweed
committed
[NFC][skip-ci][net] add deprecation comment to TGrid* classes
1 parent 0647282 commit 2d47cab

13 files changed

Lines changed: 69 additions & 133 deletions

‎net/net/inc/TGrid.h‎

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

15-
//////////////////////////////////////////////////////////////////////////
16-
// //
17-
// TGrid //
18-
// //
19-
// Abstract base class defining interface to common GRID services. //
20-
// //
21-
// To open a connection to a GRID use the static method Connect(). //
22-
// The argument of Connect() is of the form: //
23-
// <grid>://<host>[:<port>], e.g. alien://alice.cern.ch //
24-
// Depending on the <grid> specified an appropriate plugin library //
25-
// will be loaded which will provide the real interface. //
26-
// //
27-
// Related classes are TGridResult. //
28-
// //
29-
//////////////////////////////////////////////////////////////////////////
30-
3115
#include "TObject.h"
3216

3317
#include "TString.h"
@@ -41,6 +25,24 @@ class TGridCollection;
4125
class TGridJobStatusList;
4226

4327

28+
///////////////////////////////////////////////////////////////////////////
29+
///
30+
/// Abstract base class defining interface to common GRID services.
31+
///
32+
/// \note This class is deprecated. It is kept for backward compatibility
33+
/// but it should not be used in new code.
34+
///
35+
/// To open a connection to a GRID use the static method Connect().
36+
/// The argument of Connect() is of the form:
37+
/// ~~~
38+
/// <grid>://<host>[:<port>], e.g. alien://alice.cern.ch
39+
/// ~~~
40+
/// Depending on the <grid> specified an appropriate plugin library
41+
/// will be loaded which will provide the real interface.
42+
///
43+
/// Related classes are TGridResult.
44+
///
45+
///////////////////////////////////////////////////////////////////////////
4446
class TGrid : public TObject {
4547

4648
protected:

‎net/net/inc/TGridCollection.h‎

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

15-
//////////////////////////////////////////////////////////////////////////
16-
// //
17-
// TGridCollection //
18-
// //
19-
// Class which manages collection files on the Grid. //
20-
// //
21-
//////////////////////////////////////////////////////////////////////////
22-
2315
#include "TObject.h"
2416

2517
class TMap;
@@ -31,6 +23,14 @@ class TGridResult;
3123
class TFileCollection;
3224

3325

26+
//////////////////////////////////////////////////////////////////////////
27+
///
28+
/// \note This class is deprecated. It is kept for backward compatibility
29+
/// but it should not be used in new code.
30+
///
31+
/// Class which manages collection files on the Grid.
32+
///
33+
//////////////////////////////////////////////////////////////////////////
3434
class TGridCollection : public TObject {
3535
public:
3636
TGridCollection() { }

‎net/net/inc/TGridJDL.h‎

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,12 @@
1414
#define ROOT_TGridJDL
1515

1616
//////////////////////////////////////////////////////////////////////////
17-
// //
18-
// TGridJDL //
19-
// //
20-
// Abstract base class to generate JDL files for job submission to the //
21-
// Grid. //
22-
// //
23-
// Related classes are TGLiteJDL //
24-
// . //
17+
///
18+
/// \note This class is deprecated. It is kept for backward compatibility
19+
/// but it should not be used in new code.
20+
///
21+
/// Related classes are TGLiteJDL
22+
/// .
2523
//////////////////////////////////////////////////////////////////////////
2624

2725
#include "TObject.h"

‎net/net/inc/TGridJob.h‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -12,22 +12,22 @@
1212
#ifndef ROOT_TGridJob
1313
#define ROOT_TGridJob
1414

15-
//////////////////////////////////////////////////////////////////////////
16-
// //
17-
// TGridJob //
18-
// //
19-
// Abstract base class defining interface to a GRID job. //
20-
// //
21-
// Related classes are TGridJobStatus. //
22-
// //
23-
//////////////////////////////////////////////////////////////////////////
24-
2515
#include "TObject.h"
2616
#include "TString.h"
2717

2818

2919
class TGridJobStatus;
3020

21+
//////////////////////////////////////////////////////////////////////////
22+
///
23+
/// Abstract base class defining interface to a GRID job.
24+
///
25+
/// \note This class is deprecated. It is kept for backward compatibility
26+
/// but it should not be used in new code.
27+
///
28+
/// Related classes are TGridJobStatus.
29+
///
30+
//////////////////////////////////////////////////////////////////////////
3131
class TGridJob : public TObject {
3232

3333
protected:

‎net/net/inc/TGridJobStatus.h‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,17 +12,17 @@
1212
#ifndef ROOT_TGridJobStatus
1313
#define ROOT_TGridJobStatus
1414

15-
//////////////////////////////////////////////////////////////////////////
16-
// //
17-
// TGridJobStatus //
18-
// //
19-
// Abstract base class containing the status of a Grid job. //
20-
// //
21-
//////////////////////////////////////////////////////////////////////////
22-
2315
#include "TNamed.h"
2416

2517

18+
//////////////////////////////////////////////////////////////////////////
19+
///
20+
/// \note This class is deprecated. It is kept for backward compatibility
21+
/// but it should not be used in new code.
22+
///
23+
/// Abstract base class containing the status of a Grid job.
24+
///
25+
//////////////////////////////////////////////////////////////////////////
2626
class TGridJobStatus : public TNamed {
2727

2828
public:

‎net/net/inc/TGridJobStatusList.h‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,21 +12,21 @@
1212
#ifndef ROOT_TGridJobStatusList
1313
#define ROOT_TGridJobStatusList
1414

15-
//////////////////////////////////////////////////////////////////////////
16-
// //
17-
// TGridJobStatusList //
18-
// //
19-
// Abstract base class defining a list of GRID job status //
20-
// //
21-
//////////////////////////////////////////////////////////////////////////
22-
2315
#include "TList.h"
2416

2517
#include "TGridJob.h"
2618

2719

2820
class TGridJob;
2921

22+
//////////////////////////////////////////////////////////////////////////
23+
///
24+
/// \note This class is deprecated. It is kept for backward compatibility
25+
/// but it should not be used in new code.
26+
///
27+
/// Abstract base class defining a list of GRID job status
28+
///
29+
//////////////////////////////////////////////////////////////////////////
3030
class TGridJobStatusList : public TList {
3131

3232
protected:

‎net/net/inc/TGridResult.h‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -12,22 +12,22 @@
1212
#ifndef ROOT_TGridResult
1313
#define ROOT_TGridResult
1414

15-
//////////////////////////////////////////////////////////////////////////
16-
// //
17-
// TGridResult //
18-
// //
19-
// Abstract base class defining interface to a GRID result. //
20-
// Objects of this class are created by TGrid methods. //
21-
// //
22-
// Related classes are TGrid. //
23-
// //
24-
//////////////////////////////////////////////////////////////////////////
25-
2615
#include "TList.h"
2716

2817
class TEntryList;
2918

3019

20+
//////////////////////////////////////////////////////////////////////////
21+
///
22+
/// \note This class is deprecated. It is kept for backward compatibility
23+
/// but it should not be used in new code.
24+
///
25+
/// Abstract base class defining interface to a GRID result.
26+
/// Objects of this class are created by TGrid methods.
27+
///
28+
/// Related classes are TGrid.
29+
///
30+
//////////////////////////////////////////////////////////////////////////
3131
class TGridResult : public TList {
3232

3333
public:

‎net/net/src/TGrid.cxx‎

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

12-
//////////////////////////////////////////////////////////////////////////
13-
// //
14-
// TGrid //
15-
// //
16-
// Abstract base class defining interface to common GRID services. //
17-
// //
18-
// To open a connection to a GRID use the static method Connect(). //
19-
// The argument of Connect() is of the form: //
20-
// <grid>[://<host>][:<port>], e.g. alien://alice.cern.ch //
21-
// Depending on the <grid> specified an appropriate plugin library //
22-
// will be loaded which will provide the real interface. //
23-
// //
24-
// Related classes are TGridResult. //
25-
// //
26-
//////////////////////////////////////////////////////////////////////////
27-
2812
#include "TGrid.h"
2913
#include "TROOT.h"
3014
#include "TPluginManager.h"

‎net/net/src/TGridJDL.cxx‎

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

13-
//////////////////////////////////////////////////////////////////////////
14-
// //
15-
// TGridJDL //
16-
// //
17-
// Abstract base class to generate JDL files for job submission to the //
18-
// Grid. //
19-
// //
20-
// Related classes are TGLiteJDL. //
21-
// //
22-
//////////////////////////////////////////////////////////////////////////
23-
2413
#include "TGridJDL.h"
2514
#include "TObjString.h"
2615
#include "Riostream.h"

‎net/net/src/TGridJob.cxx‎

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

12-
//////////////////////////////////////////////////////////////////////////
13-
// //
14-
// TGridJob //
15-
// //
16-
// Abstract base class defining interface to a GRID job. //
17-
// //
18-
// Related classes are TGridJobStatus. //
19-
// //
20-
//////////////////////////////////////////////////////////////////////////
21-
2212
#include "TGridJob.h"
2313

2414

0 commit comments

Comments
 (0)