Skip to content

Commit 72569ad

Browse files
committed
Update
1 parent 7981331 commit 72569ad

2 files changed

Lines changed: 4 additions & 141 deletions

File tree

NEWS.rst

Lines changed: 3 additions & 140 deletions
Original file line numberDiff line numberDiff line change
@@ -1,146 +1,9 @@
1-
News for stub
2-
=============
1+
News for datarecorder
2+
=====================
33

44
This file lists the major changes between versions. For a more detailed list of
55
every change, see the Git log.
66

77
Latest
88
------
9-
* Major: Only builds with CMake
10-
11-
7.1.1
12-
-----
13-
* Patch: Changed the container type for storing return values in `return_handler`
14-
from `std::vector` to `std::deque` to avoid a specific issue with `std::vector<bool>`.
15-
This change ensures safer and more predictable behavior when using STL algorithms.
16-
17-
7.1.0
18-
-----
19-
* Minor: Added the check function to allow a user to check if a function has
20-
been called with specific arguments. If not the check function will throw an
21-
exception.
22-
* Minor: Added the side_effect function to allow a user to specify a function
23-
that will be called when a function is called.
24-
25-
7.0.0
26-
-----
27-
* Major: Use waf-tools 5.
28-
29-
6.5.0
30-
-----
31-
* Minor: Added CMake support.
32-
* Minor: Updated waf.
33-
34-
6.4.0
35-
-----
36-
* Minor: Updating how docs are built
37-
* Minor: Update waf build script
38-
39-
6.3.0
40-
-----
41-
* Minor: Adding documentation.
42-
43-
6.2.0
44-
-----
45-
* Minor: Added the ability to check if specific arguments are not null when
46-
comparing function calls in expect_calls().
47-
48-
6.1.0
49-
-----
50-
* Minor: Allow a user to clear only the function calls made.
51-
52-
6.0.0
53-
-----
54-
* Major: Upgrade to waf-tools 4
55-
* Minor: Upgrade to gtest 4
56-
57-
5.0.1
58-
-----
59-
* Patch: Fixed memory leak in compare_call due to missing virtual destructor.
60-
61-
5.0.0
62-
-----
63-
* Major: Renamed stub::call to stub::function as this better reflects its true
64-
purpose.
65-
* Major: Change the approach to providing custom comparisons of function
66-
arguments. This is now done by passing stub::compare to
67-
expect_calls().with(...).
68-
* Minor: Added the ability to ignore specific arguments when comparing function
69-
calls in expect_calls().
70-
* Minor: Added the ability to clear function objects
71-
* Major: Removed the need to use ``std::initializer_list`` when specifying
72-
multiple return values.
73-
74-
4.0.1
75-
-----
76-
* Patch: Fix printing of pointers. We rely on ``std::ostream::operator<<``
77-
for printing pointer values. This caused problems with raw binary data
78-
(char* or uint8_t*) since ``std::ostream::operator<<`` tries to print
79-
those as zero-terminated c-style strings. Instead we now always print the
80-
address pointed to rather than trying to print the actual data.
81-
82-
4.0.0
83-
-----
84-
* Major: Upgrade to waf-tools 3
85-
* Minor: Upgrade to gtest 3
86-
87-
3.0.0
88-
-----
89-
* Major: Removed the ``repeat`` member function as it does not have a proper use
90-
case.
91-
* Major: Removed the ``ignore`` member function as it does not have a proper use
92-
case.
93-
94-
2.3.0
95-
-----
96-
* Minor: Added the ``to_bool`` function - a more verbose version of converting
97-
* Patch: Added assert to ensure that expectations has been setup prior to
98-
the expectation to a boolean value.
99-
* Patch: Added ``assert`` to ensure that expectations has been setup prior to
100-
evaluation.
101-
102-
2.2.0
103-
-----
104-
* Minor: Added ``buildbot.py`` for coverage reports.
105-
* Minor: Added methods allowing a ``stub::function`` object to be printed to an
106-
``std::ostream``.
107-
108-
2.1.2
109-
-----
110-
* Patch: Fixed MSVC type conversion warnings.
111-
112-
2.1.1
113-
-----
114-
* Patch: Fix version define.
115-
116-
2.1.0
117-
-----
118-
* Minor: Added version define.
119-
120-
2.0.1
121-
-----
122-
* Bug: Added const modifier to the ``stub::function::expect_calls()``
123-
functions. They do not modify the object so they should be ``const``.
124-
* Bug: Updated documentation to specify in which order arguments are
125-
passed to a custom predicate function.
126-
127-
2.0.0
128-
-----
129-
* Major: Replaced the ``called_once_with(...)``, ``called_with(...)`` and
130-
``has_calls(...)`` functions with the ``expect_calls(...)`` functions. The
131-
``expect_calls(...)`` functions provide the same functionality as the
132-
replaced functions, but are more convenient to use.
133-
134-
1.1.0
135-
-----
136-
* Minor: Added the ``call_arguments(..)`` function to access a specific
137-
function's arguments
138-
139-
1.0.1
140-
-----
141-
* Bug: Add missing assert checking that the ``return_handler`` has actual
142-
values to return
143-
144-
1.0.0
145-
-----
146-
* Initial release of the stub library.
9+
* Major: Initial release.

src/datarecorder/datarecorder.hpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ namespace datarecorder
3232
/// Example:
3333
/// datarecorder recorder;
3434
/// recorder.set_recording_dir("test/recordings/mytest1.json");
35-
/// recorder.on_mismatch([](datarecorder::mismatch mismatch)
35+
/// recorder.on_mismatch([](datarecorder::mismatch_info mismatch)
3636
/// {
3737
/// std::cout << "Mismatch found!" << std::endl;
3838
/// std::cout << "Recording data: " << mismatch.recording_data

0 commit comments

Comments
 (0)