Skip to content

Commit de152a9

Browse files
committed
[doc][nfc] Avoid Doxygen documentation errors without disturbing transient I/O mark
1 parent 9b705ab commit de152a9

3 files changed

Lines changed: 13 additions & 13 deletions

File tree

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: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -602,7 +602,7 @@ class SClass : public TObject {
602602
private:
603603
Float_t fX; //x position in centimeters
604604
Float_t fY; //y position in centimeters
605-
Int_t fTempValue; //! temporary state value
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 & 6 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;
@@ -1234,7 +1234,7 @@ and its contents into the buffer `R__b`. The `Streamer `calls
12341234
method reads the information from buffer `R__b` into the `Event`
12351235
object.
12361236

1237-
### Transient Data Members (//!)
1237+
### Transient Data Members (///<!)
12381238

12391239

12401240
To prevent a data member from being written to the file, insert a "`!`"
@@ -1246,8 +1246,8 @@ not persistent.
12461246
``` {.cpp}
12471247
class Event : public TObject {
12481248
private:
1249-
TDirectory *fTransient; //! current directory
1250-
Float_t fPt; //! transient value
1249+
TDirectory *fTransient; ///<! current directory
1250+
Float_t fPt; ///<! transient value
12511251
...
12521252
```
12531253

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

18971897
``` {.cpp}
1898-
TVirtualHistPainter* fPainter //!pointer to histogram painter
1898+
TVirtualHistPainter* fPainter ///<!pointer to histogram painter
18991899
```
19001900

19011901
### The TStreamerElement Class

0 commit comments

Comments
 (0)