From 04c383ea7a991325ab6d2894b4f5bbdbbeb8fdd9 Mon Sep 17 00:00:00 2001 From: Martin Kletzander Date: Wed, 26 Nov 2014 11:55:59 +0100 Subject: [PATCH] tests: fix documentation for mocking methods It looks like it was copy-pasted, so in case anyone wonders what some of those methods do without looking at them, and for the sake of completeness, fix them. Signed-off-by: Martin Kletzander --- tests/virmock.h | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/tests/virmock.h b/tests/virmock.h index 8352e30197..a69c836e98 100644 --- a/tests/virmock.h +++ b/tests/virmock.h @@ -175,8 +175,8 @@ * @retval: the return value * @...: pairs of parameter type and parameter name * - * Define a replacement for @name which invokes wrap_@name - * forwarding on all args, and passing back the return value. + * Define a replacement for @name which doesn't invoke anything, just + * returns @retval. */ # define VIR_MOCK_STUB_RET_ARGS(name, rettype, retval, ...) \ rettype name(VIR_MOCK_ARGTYPENAMES_UNUSED(__VA_ARGS__)) \ @@ -188,9 +188,10 @@ * VIR_MOCK_STUB_RET_VOID: * @name: the symbol name to replace * @rettype: the return type + * @retval: value to return * - * Define a replacement for @name which invokes wrap_@name - * with no arguments, and passing back the return value. + * Define a replacement for @name which doesn't invoke anything, just + * returns @retval. */ # define VIR_MOCK_STUB_RET_VOID(name, rettype, retval) \ rettype name(void) \ @@ -203,8 +204,8 @@ * @name: the symbol name to replace * @...: pairs of parameter type and parameter name * - * Define a replacement for @name which invokes wrap_@name - * forwarding on all args, but with no return value. + * Define a replacement for @name which doesn't invoke or return + * anything. */ # define VIR_MOCK_STUB_VOID_ARGS(name, ...) \ void name(VIR_MOCK_ARGTYPENAMES_UNUSED(__VA_ARGS__)) \ @@ -217,8 +218,8 @@ * VIR_MOCK_STUB_VOID_VOID: * @name: the symbol name to replace * - * Define a replacement for @name which invokes wrap_@name - * with no arguments and with no return value + * Define a replacement for @name which doesn't invoke or return + * anything. */ # define VIR_MOCK_STUB_VOID_VOID(name) \ void name(void) \