From 059214820490844edf03e59ff4c20dc3af02c752 Mon Sep 17 00:00:00 2001 From: mat007 Date: Mon, 20 May 2013 10:48:49 +0000 Subject: [PATCH] Tweaked documentation git-svn-id: https://svn.code.sf.net/p/turtle/code/trunk@656 860be788-9bd5-4423-9f1e-828f051e677b --- build/boost/doc/customization.qbk | 2 +- build/boost/doc/mock.qbk | 4 ---- build/boost/doc/reference.qbk | 14 +++++++------- 3 files changed, 8 insertions(+), 12 deletions(-) diff --git a/build/boost/doc/customization.qbk b/build/boost/doc/customization.qbk index 255f381..e4f0044 100644 --- a/build/boost/doc/customization.qbk +++ b/build/boost/doc/customization.qbk @@ -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]. -[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] diff --git a/build/boost/doc/mock.qbk b/build/boost/doc/mock.qbk index 94482c1..68ac685 100644 --- a/build/boost/doc/mock.qbk +++ b/build/boost/doc/mock.qbk @@ -14,10 +14,6 @@ [/ [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] ] diff --git a/build/boost/doc/reference.qbk b/build/boost/doc/reference.qbk index 337e32f..0cd7281 100644 --- a/build/boost/doc/reference.qbk +++ b/build/boost/doc/reference.qbk @@ -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. -[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] @@ -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' -[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.] @@ -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 -[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 : @@ -188,7 +188,7 @@ Synopsis : 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 : @@ -242,7 +242,7 @@ Synopsis : 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.] @@ -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 ); -[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 : @@ -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. -[note The type of expected must be copy-constructible and assignable] +[note The type of expected must be copy-constructible and assignable.] Example :