Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions documentation/primer/macros/MySelector.h
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@

class MySelector : public TSelector {
public :
TTree *fChain; //!pointer to the analyzed TTree or TChain
TTree *fChain; ///<!pointer to the analyzed TTree or TChain

// Fixed size dimensions of array or collections stored in the TTree if any.

Expand All @@ -28,10 +28,10 @@ public :
Float_t Pressure;

// List of branches
TBranch *b_Potential; //!
TBranch *b_Current; //!
TBranch *b_Temperature; //!
TBranch *b_Pressure; //!
TBranch *b_Potential; ///<!
TBranch *b_Current; ///<!
TBranch *b_Temperature; ///<!
TBranch *b_Pressure; ///<!

MySelector(TTree * /*tree*/ =0) : fChain(0) { }
virtual ~MySelector() { }
Expand Down
8 changes: 4 additions & 4 deletions documentation/users-guide/AddingaClass.md
Original file line number Diff line number Diff line change
Expand Up @@ -600,9 +600,9 @@ in this chapter.
#include "TObject.h"
class SClass : public TObject {
private:
Float_t fX; //x position in centimeters
Float_t fY; //y position in centimeters
Int_t fTempValue; //! temporary state value
Float_t fX; ///<x position in centimeters
Float_t fY; ///<y position in centimeters
Int_t fTempValue; ///<! temporary state value
public:
SClass() { fX = fY = -1; }
void Print() const;
Expand Down Expand Up @@ -637,7 +637,7 @@ Interpreter". The `ShowMembers` and `Streamer` method, as well as the
add a `!` as the first character in the comments of the field:

``` {.cpp}
Int_t fTempValue; //! temporary state value
Int_t fTempValue; ///<! temporary state value
```

### The LinkDef.h File
Expand Down
11 changes: 6 additions & 5 deletions documentation/users-guide/InputOutput.md
Original file line number Diff line number Diff line change
Expand Up @@ -1188,8 +1188,8 @@ simple example of a class with diverse data members.
``` {.cpp}
class Event : public TObject {
private:
TDirectory *fTransient; //! current directory
Float_t fPt; //! transient value
TDirectory *fTransient; ///<! current directory
Float_t fPt; ///<! transient value
char fType[20];
Int_t fNtrack;
Int_t fNseg;
Expand Down Expand Up @@ -1238,6 +1238,7 @@ object.


To prevent a data member from being written to the file, insert a "`!`"
To make it compatible with Doxygen, write `///<!` instead of `//!`.
as the first character after the comment marks. It tells ROOT not to
save that data member in a root file when saving the class. For example,
in this version of Event, the `fPt` and `fTransient` data members are
Expand All @@ -1246,8 +1247,8 @@ not persistent.
``` {.cpp}
class Event : public TObject {
private:
TDirectory *fTransient; //! current directory
Float_t fPt; //! transient value
TDirectory *fTransient; ///<! current directory
Float_t fPt; ///<! transient value
...
```

Expand Down Expand Up @@ -1895,7 +1896,7 @@ a "`!`" after the comment marks. For example the pointer \*`fPainter` of
a **`TH1`** is not persistent:

``` {.cpp}
TVirtualHistPainter* fPainter //!pointer to histogram painter
TVirtualHistPainter* fPainter ///<!pointer to histogram painter
```

### The TStreamerElement Class
Expand Down
2 changes: 1 addition & 1 deletion graf2d/cocoa/inc/TGCocoa.h
Original file line number Diff line number Diff line change
Expand Up @@ -441,7 +441,7 @@ class TGCocoa : public TVirtualX {

Drawable_t fSelectedDrawable;

std::unique_ptr<ROOT::MacOSX::Details::CocoaPrivate> fPimpl; //!
std::unique_ptr<ROOT::MacOSX::Details::CocoaPrivate> fPimpl; ///<!
Int_t fCocoaDraw;

EDrawMode fDrawMode;
Expand Down
4 changes: 2 additions & 2 deletions graf2d/gpad/src/TInspectCanvas.cxx
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,8 @@ class TInspectorObject : public TObject
TClass *IsA() const override { return fClass; }

private:
void *fObj{nullptr}; //! pointer to the foreign object
TClass *fClass{nullptr}; //! pointer to class of the foreign object
void *fObj{nullptr}; ///<! pointer to the foreign object
TClass *fClass{nullptr}; ///<! pointer to class of the foreign object

};

Expand Down
2 changes: 1 addition & 1 deletion graf2d/graf/inc/TMathText.h
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ class TMathText : public TText, public TAttFill {

friend class TMathTextRenderer;

TMathTextRenderer *fRenderer{nullptr}; //!TMathText Painter
TMathTextRenderer *fRenderer{nullptr}; ///<!TMathText Painter
TMathText &operator=(const TMathText &);

void Render(const Double_t x, const Double_t y,
Expand Down
2 changes: 1 addition & 1 deletion graf3d/eve/inc/TEveCaloLegoOverlay.h
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ class TEveCaloLegoOverlay : public TGLCameraOverlay
Char_t fFrameBgTransp;

// move of scales
Int_t fMouseX, fMouseY; //! last mouse position
Int_t fMouseX, fMouseY; ///<! last mouse position
Bool_t fInDrag;

// text top right corner
Expand Down
8 changes: 4 additions & 4 deletions graf3d/eve/inc/TEveDigitSet.h
Original file line number Diff line number Diff line change
Expand Up @@ -63,8 +63,8 @@ class TEveDigitSet : public TEveElement,
Bool_t fAntiFlick; // Make extra render pass to avoid flickering when quads are too small.
Bool_t fOwnIds; // Flag specifying if id-objects are owned by the TEveDigitSet.
TEveChunkManager fPlex; // Container of digit data.
DigitBase_t* fLastDigit; //! The last / current digit added to collection.
Int_t fLastIdx; //! The last / current idx added to collection.
DigitBase_t* fLastDigit; ///<! The last / current digit added to collection.
Int_t fLastIdx; ///<! The last / current idx added to collection.

Color_t fColor; // Color used for frame (or all digis with single-color).
TEveFrameBox* fFrame; // Pointer to frame structure.
Expand All @@ -76,8 +76,8 @@ class TEveDigitSet : public TEveElement,
Bool_t fHistoButtons; // Show histogram buttons in object editor.

Bool_t fEmitSignals; // Emit signals on secondary-select.
Callback_foo fCallbackFoo; //! Additional function to call on secondary-select.
TooltipCB_foo fTooltipCBFoo; //! Function providing highlight tooltips when always-sec-select is active.
Callback_foo fCallbackFoo; ///<! Additional function to call on secondary-select.
TooltipCB_foo fTooltipCBFoo; ///<! Function providing highlight tooltips when always-sec-select is active.

DigitBase_t* NewDigit();
void ReleaseIds();
Expand Down
26 changes: 13 additions & 13 deletions graf3d/eve/inc/TEveElement.h
Original file line number Diff line number Diff line change
Expand Up @@ -80,13 +80,13 @@ class TEveElement
List_t fParents; // List of parents.
List_t fChildren; // List of children.
TEveCompound *fCompound; // Compound this object belongs to.
TEveElement *fVizModel; //! Element used as model from VizDB.
TEveElement *fVizModel; ///<! Element used as model from VizDB.
TString fVizTag; // Tag used to query VizDB for model element.

Int_t fNumChildren; //!
Int_t fParentIgnoreCnt; //! Counter for parents that are ignored in ref-counting.
Int_t fTopItemCnt; //! Counter for top-level list-tree items that prevent automatic destruction.
Int_t fDenyDestroy; //! Deny-destroy count.
Int_t fNumChildren; ///<!
Int_t fParentIgnoreCnt; ///<! Counter for parents that are ignored in ref-counting.
Int_t fTopItemCnt; ///<! Counter for top-level list-tree items that prevent automatic destruction.
Int_t fDenyDestroy; ///<! Deny-destroy count.
Bool_t fDestroyOnZeroRefCnt; // Auto-destruct when ref-count reaches zero.

Bool_t fRnrSelf; // Render this element.
Expand All @@ -99,10 +99,10 @@ class TEveElement
Color_t *fMainColorPtr; // Pointer to main-color variable.
TEveTrans *fMainTrans; // Pointer to main transformation matrix.

sLTI_t fItems; //! Set of list-tree-items.
sLTI_t fItems; ///<! Set of list-tree-items.

TRef fSource; // External object that is represented by this element.
void *fUserData; //! Externally assigned and controlled user data.
void *fUserData; ///<! Externally assigned and controlled user data.

virtual void PreDeleteElement();
virtual void RemoveElementsInternal();
Expand Down Expand Up @@ -310,10 +310,10 @@ class TEveElement

protected:
Bool_t fPickable;
Bool_t fSelected; //!
Bool_t fHighlighted; //!
Short_t fImpliedSelected; //!
Short_t fImpliedHighlighted; //!
Bool_t fSelected; ///<!
Bool_t fHighlighted; ///<!
Short_t fImpliedSelected; ///<!
Short_t fImpliedHighlighted; ///<!

enum ECompoundSelectionColorBits
{
Expand Down Expand Up @@ -398,8 +398,8 @@ class TEveElement
};

protected:
UChar_t fChangeBits; //!
Char_t fDestructing; //!
UChar_t fChangeBits; ///<!
Char_t fDestructing; ///<!

public:
void StampColorSelection() { AddStamp(kCBColorSelection); }
Expand Down
4 changes: 2 additions & 2 deletions graf3d/eve/inc/TEveGeoNode.h
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,8 @@ class TEveGeoNode : public TEveElement,
TGeoNode *fNode;
TEveGeoShapeExtract* DumpShapeTree(TEveGeoNode* geon, TEveGeoShapeExtract* parent=nullptr, Bool_t leafs_only=kFALSE);

static Int_t fgCSGExportNSeg; //!
static std::list<TGeoShape*> fgTemporaryStore; //!
static Int_t fgCSGExportNSeg; ///<!
static std::list<TGeoShape*> fgTemporaryStore; ///<!

public:
TEveGeoNode(TGeoNode* node);
Expand Down
2 changes: 1 addition & 1 deletion graf3d/eve/inc/TEveGeoShape.h
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ class TEveGeoShape : public TEveShape
protected:
Int_t fNSegments;
TGeoShape *fShape;
TGeoCompositeShape *fCompositeShape; //! Temporary holder (if passed shape is composite shape).
TGeoCompositeShape *fCompositeShape; ///<! Temporary holder (if passed shape is composite shape).

static TGeoManager *fgGeoMangeur;

Expand Down
2 changes: 1 addition & 1 deletion graf3d/eve/inc/TEveGridStepper.h
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ class TEveGridStepper : public TObject
friend class TEveGridStepperSubEditor;

private:
Int_t *fLimitArr[3], *fValueArr[3]; //! Internal traversal variables.
Int_t *fLimitArr[3], *fValueArr[3]; ///<! Internal traversal variables.

TEveGridStepper(const TEveGridStepper&); // Not implemented
TEveGridStepper& operator=(const TEveGridStepper&); // Not implemented
Expand Down
2 changes: 1 addition & 1 deletion graf3d/eve/inc/TEvePointSet.h
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ class TEvePointSetArray : public TEveElement,
TEvePointSet **fBins; // Pointers to subjugated TEvePointSet's.
Int_t fDefPointSetCapacity; // Default capacity of subjugated TEvePointSet's.
Int_t fNBins; // Number of subjugated TEvePointSet's.
Int_t fLastBin; //! Index of the last filled TEvePointSet.
Int_t fLastBin; ///<! Index of the last filled TEvePointSet.
Double_t fMin, fCurMin; // Overall and current minimum value of the separating quantity.
Double_t fMax, fCurMax; // Overall and current maximum value of the separating quantity.
Double_t fBinWidth; // Separating quantity bin-width.
Expand Down
2 changes: 1 addition & 1 deletion graf3d/eve/inc/TEveStraightLineSet.h
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ class TEveStraightLineSet : public TEveElement,

Bool_t fDepthTest;

Line_t* fLastLine; //!
Line_t* fLastLine; ///<!

public:
TEveStraightLineSet(const char* n="StraightLineSet", const char* t="");
Expand Down
2 changes: 1 addition & 1 deletion graf3d/eve/inc/TEveTrack.h
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ class TEveTrack : public TEveLine
Int_t fStatus; // Status-word, user-defined.
Bool_t fLockPoints; // Lock points that are currently in - do nothing in MakeTrack().
vPathMark_t fPathMarks; // TEveVector of known points along the track
Int_t fLastPMIdx; //!Last path-mark index tried in track-propagation.
Int_t fLastPMIdx; ///<!Last path-mark index tried in track-propagation.

TEveTrackPropagator *fPropagator; // Pointer to shared render-style

Expand Down
8 changes: 4 additions & 4 deletions graf3d/eve/inc/TEveTrans.h
Original file line number Diff line number Diff line change
Expand Up @@ -31,10 +31,10 @@ class TEveTrans : public TObject
protected:
Double32_t fM[16];

mutable Float_t fA1; //!
mutable Float_t fA2; //!
mutable Float_t fA3; //!
mutable Bool_t fAsOK; //!
mutable Float_t fA1; ///<!
mutable Float_t fA2; ///<!
mutable Float_t fA3; ///<!
mutable Bool_t fAsOK; ///<!

// TEveUtil
Bool_t fUseTrans; // use transformation matrix
Expand Down
42 changes: 21 additions & 21 deletions graf3d/eve/inc/TEveVSD.h
Original file line number Diff line number Diff line change
Expand Up @@ -22,30 +22,30 @@ class TEveVSD : public TObject
TEveVSD& operator=(const TEveVSD&); // Not implemented

protected:
TFile *fFile; //!
TDirectory *fDirectory; //!
TFile *fFile; ///<!
TDirectory *fDirectory; ///<!

Int_t fBuffSize; //!
Int_t fVerbose; //!
Int_t fBuffSize; ///<!
Int_t fVerbose; ///<!

public:
TTree* fTreeK; //! Kinematics.
TTree* fTreeH; //! Hits.
TTree* fTreeC; //! Clusters.
TTree* fTreeR; //! Reconstructed tracks.
TTree* fTreeKK; //! Kinks.
TTree* fTreeV0; //! VO's.
TTree* fTreeCC; //! Cascades.
TTree* fTreeGI; //! Sim-Rec cross references.

TEveMCTrack fK, *fpK; //!
TEveHit fH, *fpH; //!
TEveCluster fC, *fpC; //!
TEveRecTrack fR, *fpR; //!
TEveRecKink fKK, *fpKK; //!
TEveRecV0 fV0, *fpV0; //!
TEveRecCascade fCC, *fpCC; //!
TEveMCRecCrossRef fGI, *fpGI; //!
TTree* fTreeK; ///<! Kinematics.
TTree* fTreeH; ///<! Hits.
TTree* fTreeC; ///<! Clusters.
TTree* fTreeR; ///<! Reconstructed tracks.
TTree* fTreeKK; ///<! Kinks.
TTree* fTreeV0; ///<! VO's.
TTree* fTreeCC; ///<! Cascades.
TTree* fTreeGI; ///<! Sim-Rec cross references.

TEveMCTrack fK, *fpK; ///<!
TEveHit fH, *fpH; ///<!
TEveCluster fC, *fpC; ///<!
TEveRecTrack fR, *fpR; ///<!
TEveRecKink fKK, *fpKK; ///<!
TEveRecV0 fV0, *fpV0; ///<!
TEveRecCascade fCC, *fpCC; ///<!
TEveMCRecCrossRef fGI, *fpGI; ///<!

public:
TEveVSD(const char* name="TEveVSD", const char* title="");
Expand Down
8 changes: 4 additions & 4 deletions graf3d/eve7/inc/ROOT/REveDigitSet.hxx
Original file line number Diff line number Diff line change
Expand Up @@ -66,8 +66,8 @@ protected:
Bool_t fOwnIds{false}; // Flag specifying if id-objects are owned by the TEveDigitSet.
Bool_t fDetIdsAsSecondaryIndices; // Flag specifying if id-objects are owned by the REveDigitSet.
REveChunkManager fPlex; // Container of digit data.
DigitBase_t* fLastDigit; //! The last / current digit added to collection.
Int_t fLastIdx; //! The last / current idx added to collection.
DigitBase_t* fLastDigit; ///<! The last / current digit added to collection.
Int_t fLastIdx; ///<! The last / current idx added to collection.

Color_t fColor; // Color used for frame (or all digis with single-color).
REveFrameBox* fFrame; // Pointer to frame structure.
Expand All @@ -79,8 +79,8 @@ protected:
Bool_t fHistoButtons; // Show histogram buttons in object editor.

Bool_t fEmitSignals; // Emit signals on secondary-select.
Callback_foo fCallbackFoo; //! Additional function to call on secondary-select.
TooltipCB_foo fTooltipCBFoo; //! Function providing highlight tooltips when always-sec-select is active.
Callback_foo fCallbackFoo; ///<! Additional function to call on secondary-select.
TooltipCB_foo fTooltipCBFoo; ///<! Function providing highlight tooltips when always-sec-select is active.

DigitBase_t* NewDigit();
void ReleaseIds();
Expand Down
12 changes: 6 additions & 6 deletions graf3d/eve7/inc/ROOT/REveElement.hxx
Original file line number Diff line number Diff line change
Expand Up @@ -77,10 +77,10 @@ protected:
List_t fChildren; // List of children.
TClass *fChildClass {nullptr}; // Class of acceptable children, others are rejected.
REveCompound *fCompound {nullptr}; // Compound this object belongs to.
REveElement *fVizModel {nullptr}; //! Element used as model from VizDB.
REveElement *fVizModel {nullptr}; ///<! Element used as model from VizDB.
TString fVizTag; // Tag used to query VizDB for model element.

Int_t fDenyDestroy{0}; //! Deny-destroy count.
Int_t fDenyDestroy{0}; ///<! Deny-destroy count.
Bool_t fDestroyOnZeroRefCnt{kTRUE}; // Auto-destruct when ref-count reaches zero.

Bool_t fRnrSelf{kTRUE}; // Render this element.
Expand All @@ -94,9 +94,9 @@ protected:
Color_t *fMainColorPtr{nullptr};// Pointer to main-color variable.
std::unique_ptr<REveTrans> fMainTrans; // Pointer to main transformation matrix.

void *fUserData{nullptr}; //! Externally assigned and controlled user data.
void *fUserData{nullptr}; ///<! Externally assigned and controlled user data.

std::unique_ptr<REveRenderData> fRenderData;//! Vertex / normal / triangle index information for rendering.
std::unique_ptr<REveRenderData> fRenderData;///<! Vertex / normal / triangle index information for rendering.

virtual void PreDeleteElement();
virtual void RemoveElementsInternal();
Expand Down Expand Up @@ -337,8 +337,8 @@ public:
};

protected:
UChar_t fChangeBits{0}; //!
Char_t fDestructing{kNone}; //!
UChar_t fChangeBits{0}; ///<!
Char_t fDestructing{kNone}; ///<!

static thread_local REveElement *stlMirAlpha;
static thread_local int stlMirError;
Expand Down
Loading
Loading