Skip to content

Commit 1b90857

Browse files
committed
[hist] Escape "ROOT" in Doxygen comments
Otherwise it links to the ROOT namespace.
1 parent c98113e commit 1b90857

File tree

6 files changed

+25
-25
lines changed

6 files changed

+25
-25
lines changed

hist/histv7/inc/ROOT/RAxes.hxx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
/// \file
2-
/// \warning This is part of the ROOT 7 prototype! It will change without notice. It might trigger earthquakes. Feedback
3-
/// is welcome!
2+
/// \warning This is part of the %ROOT 7 prototype! It will change without notice. It might trigger earthquakes.
3+
/// Feedback is welcome!
44

55
#ifndef ROOT_RAxes
66
#define ROOT_RAxes
@@ -139,7 +139,7 @@ public:
139139
return {globalIndex, true};
140140
}
141141

142-
/// ROOT Streamer function to throw when trying to store an object of this class.
142+
/// %ROOT Streamer function to throw when trying to store an object of this class.
143143
void Streamer(TBuffer &) { throw std::runtime_error("unable to store RAxes"); }
144144
};
145145

hist/histv7/inc/ROOT/RBinIndex.hxx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
/// \file
2-
/// \warning This is part of the ROOT 7 prototype! It will change without notice. It might trigger earthquakes. Feedback
3-
/// is welcome!
2+
/// \warning This is part of the %ROOT 7 prototype! It will change without notice. It might trigger earthquakes.
3+
/// Feedback is welcome!
44

55
#ifndef ROOT_RBinIndex
66
#define ROOT_RBinIndex
@@ -16,8 +16,8 @@ A bin index with special values for underflow and overflow bins.
1616
1717
Objects of this type should be passed by value.
1818
19-
\warning This is part of the ROOT 7 prototype! It will change without notice. It might trigger earthquakes. Feedback is
20-
welcome!
19+
\warning This is part of the %ROOT 7 prototype! It will change without notice. It might trigger earthquakes.
20+
Feedback is welcome!
2121
*/
2222
class RBinIndex final {
2323
static constexpr std::size_t UnderflowIndex = -3;

hist/histv7/inc/ROOT/RBinIndexRange.hxx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
/// \file
2-
/// \warning This is part of the ROOT 7 prototype! It will change without notice. It might trigger earthquakes. Feedback
3-
/// is welcome!
2+
/// \warning This is part of the %ROOT 7 prototype! It will change without notice. It might trigger earthquakes.
3+
/// Feedback is welcome!
44

55
#ifndef ROOT_RBinIndexRange
66
#define ROOT_RBinIndexRange
@@ -36,8 +36,8 @@ for (auto index : axis.GetFullRange()) {
3636
}
3737
\endcode
3838
39-
\warning This is part of the ROOT 7 prototype! It will change without notice. It might trigger earthquakes. Feedback is
40-
welcome!
39+
\warning This is part of the %ROOT 7 prototype! It will change without notice. It might trigger earthquakes.
40+
Feedback is welcome!
4141
*/
4242
class RBinIndexRange final {
4343
friend RBinIndexRange Internal::CreateBinIndexRange(RBinIndex, RBinIndex, std::size_t);

hist/histv7/inc/ROOT/RLinearizedIndex.hxx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
/// \file
2-
/// \warning This is part of the ROOT 7 prototype! It will change without notice. It might trigger earthquakes. Feedback
3-
/// is welcome!
2+
/// \warning This is part of the %ROOT 7 prototype! It will change without notice. It might trigger earthquakes.
3+
/// Feedback is welcome!
44

55
#ifndef ROOT_RLinearizedIndex
66
#define ROOT_RLinearizedIndex
@@ -15,8 +15,8 @@ A linearized index that can be invalid.
1515
1616
For example, when an argument is outside the axis and underflow / overflow bins are disabled.
1717
18-
\warning This is part of the ROOT 7 prototype! It will change without notice. It might trigger earthquakes. Feedback is
19-
welcome!
18+
\warning This is part of the %ROOT 7 prototype! It will change without notice. It might trigger earthquakes.
19+
Feedback is welcome!
2020
*/
2121
struct RLinearizedIndex final {
2222
std::size_t fIndex = 0;

hist/histv7/inc/ROOT/RRegularAxis.hxx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
/// \file
2-
/// \warning This is part of the ROOT 7 prototype! It will change without notice. It might trigger earthquakes. Feedback
3-
/// is welcome!
2+
/// \warning This is part of the %ROOT 7 prototype! It will change without notice. It might trigger earthquakes.
3+
/// Feedback is welcome!
44

55
#ifndef ROOT_RRegularAxis
66
#define ROOT_RRegularAxis
@@ -30,8 +30,8 @@ ROOT::Experimental::RRegularAxis axis(10, 5, 15);
3030
It is possible to disable underflow and overflow bins by passing `enableFlowBins = false`. In that case, arguments
3131
outside the axis will be silently discarded.
3232
33-
\warning This is part of the ROOT 7 prototype! It will change without notice. It might trigger earthquakes. Feedback is
34-
welcome!
33+
\warning This is part of the %ROOT 7 prototype! It will change without notice. It might trigger earthquakes.
34+
Feedback is welcome!
3535
*/
3636
class RRegularAxis final {
3737
/// The number of normal bins
@@ -165,7 +165,7 @@ public:
165165
: GetNormalRange();
166166
}
167167

168-
/// ROOT Streamer function to throw when trying to store an object of this class.
168+
/// %ROOT Streamer function to throw when trying to store an object of this class.
169169
void Streamer(TBuffer &) { throw std::runtime_error("unable to store RRegularAxis"); }
170170
};
171171

hist/histv7/inc/ROOT/RVariableBinAxis.hxx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
/// \file
2-
/// \warning This is part of the ROOT 7 prototype! It will change without notice. It might trigger earthquakes. Feedback
3-
/// is welcome!
2+
/// \warning This is part of the %ROOT 7 prototype! It will change without notice. It might trigger earthquakes.
3+
/// Feedback is welcome!
44

55
#ifndef ROOT_RVariableBinAxis
66
#define ROOT_RVariableBinAxis
@@ -33,8 +33,8 @@ ROOT::Experimental::RVariableBinAxis axis(binEdges);
3333
It is possible to disable underflow and overflow bins by passing `enableFlowBins = false`. In that case, arguments
3434
outside the axis will be silently discarded.
3535
36-
\warning This is part of the ROOT 7 prototype! It will change without notice. It might trigger earthquakes. Feedback is
37-
welcome!
36+
\warning This is part of the %ROOT 7 prototype! It will change without notice. It might trigger earthquakes.
37+
Feedback is welcome!
3838
*/
3939
class RVariableBinAxis final {
4040
/// The (ordered) edges of the normal bins
@@ -166,7 +166,7 @@ public:
166166
: GetNormalRange();
167167
}
168168

169-
/// ROOT Streamer function to throw when trying to store an object of this class.
169+
/// %ROOT Streamer function to throw when trying to store an object of this class.
170170
void Streamer(TBuffer &) { throw std::runtime_error("unable to store RVariableBinAxis"); }
171171
};
172172

0 commit comments

Comments
 (0)