Skip to content

Commit d79640e

Browse files
committed
etc: Put reminders for changing pretty printers in CPP classes.
1 parent b92138d commit d79640e

File tree

4 files changed

+17
-2
lines changed

4 files changed

+17
-2
lines changed

libopenage/coord/coord.h.template

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// Copyright 2016-2023 the openage authors. See copying.md for legal info.
1+
// Copyright 2016-2024 the openage authors. See copying.md for legal info.
22

33
#pragma once
44

@@ -24,6 +24,9 @@ namespace coord {
2424
*
2525
* 'Absolute' and 'Relative' are the absolute and relative types of the
2626
* derived class (CRTP).
27+
*
28+
* If you change this class, remember to update the gdb pretty printers
29+
* in etc/gdb_pretty/printers.py.
2730
*/
2831
template<typename CoordType, typename Absolute, typename Relative>
2932
struct Coord${camelcase}Absolute {
@@ -87,6 +90,9 @@ struct Coord${camelcase}Absolute {
8790
*
8891
* 'Absolute' and 'Relative' are the absolute and relative types of the
8992
* derived class (CRTP).
93+
*
94+
* If you change this class, remember to update the gdb pretty printers
95+
* in etc/gdb_pretty/printers.py.
9096
*/
9197
template<typename CoordType, typename Absolute, typename Relative>
9298
struct Coord${camelcase}Relative {

libopenage/curve/keyframe.h

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// Copyright 2019-2023 the openage authors. See copying.md for legal info.
1+
// Copyright 2019-2024 the openage authors. See copying.md for legal info.
22

33
#pragma once
44

@@ -11,6 +11,9 @@ namespace openage::curve {
1111
/**
1212
* A element of the curvecontainer. This is especially used to keep track of
1313
* the value-timing.
14+
*
15+
* If you change this class, remember to update the gdb pretty printers
16+
* in etc/gdb_pretty/printers.py.
1417
*/
1518
template <typename T>
1619
class Keyframe {

libopenage/util/fixed_point.h

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,9 @@ constexpr static
8181
* For example,
8282
* FixedPoint<int64_t, 32>
8383
* can store values from -2**32 to +2**32 with a constant precision of 2**-32.
84+
*
85+
* If you change this class, remember to update the gdb pretty printers
86+
* in etc/gdb_pretty/printers.py.
8487
*/
8588
template <typename int_type, unsigned int fractional_bits>
8689
class FixedPoint {

libopenage/util/vector.h

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,9 @@ namespace openage::util {
2020
*
2121
* N = dimensions
2222
* T = underlying single value type (double, float, ...)
23+
*
24+
* If you change this class, remember to update the gdb pretty printers
25+
* in etc/gdb_pretty/printers.py.
2326
*/
2427
template <size_t N, typename T>
2528
class Vector : public std::array<T, N> {

0 commit comments

Comments
 (0)