Skip to content

Commit 4b82f3b

Browse files
authored
[gui,graf] fix off-by-one docu mistakes (#21460)
Avoid Doxygen documentation errors without disturbing transient I/O mark
1 parent 43a7dc3 commit 4b82f3b

50 files changed

Lines changed: 287 additions & 286 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

documentation/primer/macros/MySelector.h

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717

1818
class MySelector : public TSelector {
1919
public :
20-
TTree *fChain; //!pointer to the analyzed TTree or TChain
20+
TTree *fChain; ///<!pointer to the analyzed TTree or TChain
2121

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

@@ -28,10 +28,10 @@ public :
2828
Float_t Pressure;
2929

3030
// List of branches
31-
TBranch *b_Potential; //!
32-
TBranch *b_Current; //!
33-
TBranch *b_Temperature; //!
34-
TBranch *b_Pressure; //!
31+
TBranch *b_Potential; ///<!
32+
TBranch *b_Current; ///<!
33+
TBranch *b_Temperature; ///<!
34+
TBranch *b_Pressure; ///<!
3535

3636
MySelector(TTree * /*tree*/ =0) : fChain(0) { }
3737
virtual ~MySelector() { }

documentation/users-guide/AddingaClass.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -600,9 +600,9 @@ in this chapter.
600600
#include "TObject.h"
601601
class SClass : public TObject {
602602
private:
603-
Float_t fX; //x position in centimeters
604-
Float_t fY; //y position in centimeters
605-
Int_t fTempValue; //! temporary state value
603+
Float_t fX; ///<x position in centimeters
604+
Float_t fY; ///<y position in centimeters
605+
Int_t fTempValue; ///<! temporary state value
606606
public:
607607
SClass() { fX = fY = -1; }
608608
void Print() const;
@@ -637,7 +637,7 @@ Interpreter". The `ShowMembers` and `Streamer` method, as well as the
637637
add a `!` as the first character in the comments of the field:
638638

639639
``` {.cpp}
640-
Int_t fTempValue; //! temporary state value
640+
Int_t fTempValue; ///<! temporary state value
641641
```
642642

643643
### The LinkDef.h File

documentation/users-guide/InputOutput.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1188,8 +1188,8 @@ simple example of a class with diverse data members.
11881188
``` {.cpp}
11891189
class Event : public TObject {
11901190
private:
1191-
TDirectory *fTransient; //! current directory
1192-
Float_t fPt; //! transient value
1191+
TDirectory *fTransient; ///<! current directory
1192+
Float_t fPt; ///<! transient value
11931193
char fType[20];
11941194
Int_t fNtrack;
11951195
Int_t fNseg;
@@ -1238,6 +1238,7 @@ object.
12381238

12391239

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

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

18971898
``` {.cpp}
1898-
TVirtualHistPainter* fPainter //!pointer to histogram painter
1899+
TVirtualHistPainter* fPainter ///<!pointer to histogram painter
18991900
```
19001901

19011902
### The TStreamerElement Class

graf2d/cocoa/inc/TGCocoa.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -441,7 +441,7 @@ class TGCocoa : public TVirtualX {
441441

442442
Drawable_t fSelectedDrawable;
443443

444-
std::unique_ptr<ROOT::MacOSX::Details::CocoaPrivate> fPimpl; //!
444+
std::unique_ptr<ROOT::MacOSX::Details::CocoaPrivate> fPimpl; ///<!
445445
Int_t fCocoaDraw;
446446

447447
EDrawMode fDrawMode;

graf2d/gpad/src/TInspectCanvas.cxx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,8 +47,8 @@ class TInspectorObject : public TObject
4747
TClass *IsA() const override { return fClass; }
4848

4949
private:
50-
void *fObj{nullptr}; //! pointer to the foreign object
51-
TClass *fClass{nullptr}; //! pointer to class of the foreign object
50+
void *fObj{nullptr}; ///<! pointer to the foreign object
51+
TClass *fClass{nullptr}; ///<! pointer to class of the foreign object
5252

5353
};
5454

graf2d/graf/inc/TMathText.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ class TMathText : public TText, public TAttFill {
2121

2222
friend class TMathTextRenderer;
2323

24-
TMathTextRenderer *fRenderer{nullptr}; //!TMathText Painter
24+
TMathTextRenderer *fRenderer{nullptr}; ///<!TMathText Painter
2525
TMathText &operator=(const TMathText &);
2626

2727
void Render(const Double_t x, const Double_t y,

graf3d/eve/inc/TEveCaloLegoOverlay.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ class TEveCaloLegoOverlay : public TGLCameraOverlay
5050
Char_t fFrameBgTransp;
5151

5252
// move of scales
53-
Int_t fMouseX, fMouseY; //! last mouse position
53+
Int_t fMouseX, fMouseY; ///<! last mouse position
5454
Bool_t fInDrag;
5555

5656
// text top right corner

graf3d/eve/inc/TEveDigitSet.h

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -63,8 +63,8 @@ class TEveDigitSet : public TEveElement,
6363
Bool_t fAntiFlick; // Make extra render pass to avoid flickering when quads are too small.
6464
Bool_t fOwnIds; // Flag specifying if id-objects are owned by the TEveDigitSet.
6565
TEveChunkManager fPlex; // Container of digit data.
66-
DigitBase_t* fLastDigit; //! The last / current digit added to collection.
67-
Int_t fLastIdx; //! The last / current idx added to collection.
66+
DigitBase_t* fLastDigit; ///<! The last / current digit added to collection.
67+
Int_t fLastIdx; ///<! The last / current idx added to collection.
6868

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

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

8282
DigitBase_t* NewDigit();
8383
void ReleaseIds();

graf3d/eve/inc/TEveElement.h

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -80,13 +80,13 @@ class TEveElement
8080
List_t fParents; // List of parents.
8181
List_t fChildren; // List of children.
8282
TEveCompound *fCompound; // Compound this object belongs to.
83-
TEveElement *fVizModel; //! Element used as model from VizDB.
83+
TEveElement *fVizModel; ///<! Element used as model from VizDB.
8484
TString fVizTag; // Tag used to query VizDB for model element.
8585

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

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

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

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

107107
virtual void PreDeleteElement();
108108
virtual void RemoveElementsInternal();
@@ -310,10 +310,10 @@ class TEveElement
310310

311311
protected:
312312
Bool_t fPickable;
313-
Bool_t fSelected; //!
314-
Bool_t fHighlighted; //!
315-
Short_t fImpliedSelected; //!
316-
Short_t fImpliedHighlighted; //!
313+
Bool_t fSelected; ///<!
314+
Bool_t fHighlighted; ///<!
315+
Short_t fImpliedSelected; ///<!
316+
Short_t fImpliedHighlighted; ///<!
317317

318318
enum ECompoundSelectionColorBits
319319
{
@@ -398,8 +398,8 @@ class TEveElement
398398
};
399399

400400
protected:
401-
UChar_t fChangeBits; //!
402-
Char_t fDestructing; //!
401+
UChar_t fChangeBits; ///<!
402+
Char_t fDestructing; ///<!
403403

404404
public:
405405
void StampColorSelection() { AddStamp(kCBColorSelection); }

graf3d/eve/inc/TEveGeoNode.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,8 @@ class TEveGeoNode : public TEveElement,
3737
TGeoNode *fNode;
3838
TEveGeoShapeExtract* DumpShapeTree(TEveGeoNode* geon, TEveGeoShapeExtract* parent=nullptr, Bool_t leafs_only=kFALSE);
3939

40-
static Int_t fgCSGExportNSeg; //!
41-
static std::list<TGeoShape*> fgTemporaryStore; //!
40+
static Int_t fgCSGExportNSeg; ///<!
41+
static std::list<TGeoShape*> fgTemporaryStore; ///<!
4242

4343
public:
4444
TEveGeoNode(TGeoNode* node);

0 commit comments

Comments
 (0)