mirror of
https://github.com/mat007/turtle.git
synced 2026-06-22 12:13:43 +00:00
Tweaked documentation
git-svn-id: https://svn.code.sf.net/p/turtle/code/trunk@656 860be788-9bd5-4423-9f1e-828f051e677b
This commit is contained in:
parent
415cece00e
commit
0592148204
3 changed files with 8 additions and 12 deletions
|
|
@ -99,7 +99,7 @@ See [link turtle.reference.expectation.constraints constraints] for an explanati
|
||||||
|
|
||||||
For more information about the serialization operator and the use of mock::format, refer to [link turtle.customization.logging loggin].
|
For more information about the serialization operator and the use of mock::format, refer to [link turtle.customization.logging loggin].
|
||||||
|
|
||||||
[note The [link turtle.reference.helpers.mock_unary_constraint MOCK_UNARY_CONSTRAINT] and [link turtle.reference.helpers.mock_binary_constraint MOCK_BINARY_CONSTRAINT] macros replace the need to write the constraints explicitly for the most trivial cases]
|
[note The [link turtle.reference.helpers.mock_unary_constraint MOCK_UNARY_CONSTRAINT] and [link turtle.reference.helpers.mock_binary_constraint MOCK_BINARY_CONSTRAINT] macros replace the need to write the constraints explicitly for the most trivial cases.]
|
||||||
|
|
||||||
[endsect]
|
[endsect]
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -14,10 +14,6 @@
|
||||||
[/
|
[/
|
||||||
[section:introduction Introduction]
|
[section:introduction Introduction]
|
||||||
|
|
||||||
Turtle is a C++ [@http://en.wikipedia.org/wiki/Mock_object Mock object] library written for [@http://www.boost.org Boost] with a focus on usability, simplicity and flexibility.
|
|
||||||
|
|
||||||
[note Boost.Mock is not an official Boost library]
|
|
||||||
|
|
||||||
[endsect]
|
[endsect]
|
||||||
]
|
]
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -26,7 +26,7 @@ Creating a mock object involves two parts under the hood :
|
||||||
|
|
||||||
Most of the time the identifier will be identical to the object name, but in case of ambiguity (for instance overloaded methods) a different identifier will have to be specified.
|
Most of the time the identifier will be identical to the object name, but in case of ambiguity (for instance overloaded methods) a different identifier will have to be specified.
|
||||||
|
|
||||||
[warning Creating a mock object creates a new object and does not magically replace existing ones, for instance creating a mock function will not replace an already existing function with the same name and signature]
|
[warning Creating a mock object creates a new object and does not magically replace existing ones, for instance creating a mock function will not replace an already existing function with the same name and signature.]
|
||||||
|
|
||||||
[section Class]
|
[section Class]
|
||||||
|
|
||||||
|
|
@ -148,7 +148,7 @@ Synopsis :
|
||||||
|
|
||||||
MOCK_STATIC_METHOD_TPL( name, arity, signature[, identifier] ) // must be used if the signature uses a template parameter of the class, if 'identifier' is omitted it will default to 'name'
|
MOCK_STATIC_METHOD_TPL( name, arity, signature[, identifier] ) // must be used if the signature uses a template parameter of the class, if 'identifier' is omitted it will default to 'name'
|
||||||
|
|
||||||
[note A static object is used behind the scene in order to keep track of the expectations of a mock static method, therefore to ensure all tests run in isolation it is strongly suggested to manually [link turtle.reference.verification verify] and [link turtle.reference.reset reset] the static method at the end of each test]
|
[note A static object is used behind the scene in order to keep track of the expectations of a mock static method, therefore to ensure all tests run in isolation it is strongly suggested to manually [link turtle.reference.verification verify] and [link turtle.reference.reset reset] the static method at the end of each test.]
|
||||||
|
|
||||||
[warning With a compiler without support for variadic macros the identifier cannot be ommitted and must be given explicitly.]
|
[warning With a compiler without support for variadic macros the identifier cannot be ommitted and must be given explicitly.]
|
||||||
|
|
||||||
|
|
@ -170,7 +170,7 @@ Synopsis :
|
||||||
|
|
||||||
MOCK_CONSTRUCTOR_TPL( name, arity, parameters, identifier ) // must be used if the signature uses a template parameter of the class
|
MOCK_CONSTRUCTOR_TPL( name, arity, parameters, identifier ) // must be used if the signature uses a template parameter of the class
|
||||||
|
|
||||||
[note As constructors do not have a return type, the usual signature gets restricted here to just the parameters]
|
[note As constructors do not have a return type, the usual signature gets restricted here to just the parameters.]
|
||||||
|
|
||||||
Example :
|
Example :
|
||||||
|
|
||||||
|
|
@ -188,7 +188,7 @@ Synopsis :
|
||||||
|
|
||||||
MOCK_DESTRUCTOR( name, identifier )
|
MOCK_DESTRUCTOR( name, identifier )
|
||||||
|
|
||||||
[note When mocking a destructor it is strongly suggested to manually [link turtle.reference.verification verify] the expectation at the end of the test, because the automatic verification will not be triggered if the mock object is not destroyed]
|
[note When mocking a destructor it is strongly suggested to manually [link turtle.reference.verification verify] the expectation at the end of the test, because the automatic verification will not be triggered if the mock object is not destroyed.]
|
||||||
|
|
||||||
Example :
|
Example :
|
||||||
|
|
||||||
|
|
@ -242,7 +242,7 @@ Synopsis :
|
||||||
|
|
||||||
MOCK_FUNCTION( name, arity, signature[, identifier] ) // if 'identifier' is omitted it will default to 'name'
|
MOCK_FUNCTION( name, arity, signature[, identifier] ) // if 'identifier' is omitted it will default to 'name'
|
||||||
|
|
||||||
[note A static object is used behind the scene in order to keep track of the expectations of a mock function, therefore to ensure all tests run in isolation it is strongly suggested to manually [link turtle.reference.verification verify] and [link turtle.reference.reset reset] the mock function at the end of each test]
|
[note A static object is used behind the scene in order to keep track of the expectations of a mock function, therefore to ensure all tests run in isolation it is strongly suggested to manually [link turtle.reference.verification verify] and [link turtle.reference.reset reset] the mock function at the end of each test.]
|
||||||
|
|
||||||
[warning With a compiler without support for variadic macros the identifier cannot be ommitted and must be given explicitly.]
|
[warning With a compiler without support for variadic macros the identifier cannot be ommitted and must be given explicitly.]
|
||||||
|
|
||||||
|
|
@ -262,7 +262,7 @@ Synopsis :
|
||||||
|
|
||||||
MOCK_EXPECT( identifier ).``[link turtle.reference.expectation.invocation invocation]``( arguments ).with( ``[link turtle.reference.expectation.constraints constraints]`` ).in( ``[link turtle.reference.expectation.sequence sequences]`` ).``[link turtle.reference.expectation.actions action]``( value );
|
MOCK_EXPECT( identifier ).``[link turtle.reference.expectation.invocation invocation]``( arguments ).with( ``[link turtle.reference.expectation.constraints constraints]`` ).in( ``[link turtle.reference.expectation.sequence sequences]`` ).``[link turtle.reference.expectation.actions action]``( value );
|
||||||
|
|
||||||
[note The identifier refers to the one specified when [link turtle.reference.creation creating] a mock object]
|
[note The identifier refers to the one specified when [link turtle.reference.creation creating] a mock object.]
|
||||||
|
|
||||||
Example :
|
Example :
|
||||||
|
|
||||||
|
|
@ -510,7 +510,7 @@ Synopsis :
|
||||||
|
|
||||||
The expression manipulates the received parameter 'actual' as well as the passed argument 'expected' in order to implement the constraint.
|
The expression manipulates the received parameter 'actual' as well as the passed argument 'expected' in order to implement the constraint.
|
||||||
|
|
||||||
[note The type of expected must be copy-constructible and assignable]
|
[note The type of expected must be copy-constructible and assignable.]
|
||||||
|
|
||||||
Example :
|
Example :
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue