From 56faeb935f40065c2f6208a5af510692a2240dac Mon Sep 17 00:00:00 2001 From: cloudsftp Date: Wed, 19 Aug 2020 10:38:26 +0200 Subject: [PATCH] add documentation --- docs/CMock_Summary.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/docs/CMock_Summary.md b/docs/CMock_Summary.md index f72a2f5..04a9885 100644 --- a/docs/CMock_Summary.md +++ b/docs/CMock_Summary.md @@ -174,6 +174,20 @@ handle the call to a function. * `retval func(void)` => `void func_StopIgnore(void)` * `retval func(params)` => `void func_StopIgnore(void)` +IgnoreStateless: +---------------- + +This plugin is similar to the Ignore plugin, but the IgnoreAndReturn functions are +stateless. So the Ignored function will always return the last specified return value +and does not queue the return values as the IgnoreAndReturn of the default plugin will. +To stop ignoring a function you can call StopIgnore or simply overwrite the Ignore +(resp. IgnoreAndReturn) with an Expect (resp. ExpectAndReturn). + +You can use this plugin by using `:ignore_stateless` instead of `:ignore` in your +CMock configuration file. + +The generated functions are the same as **Ignore** and **StopIgnore** above. + Ignore Arg: ------------ @@ -440,6 +454,7 @@ from the defaults. We've tried to specify what the defaults are below. available currently: * `:ignore` + * `:ignore_stateless` * `:ignore_arg` * `:expect_any_args` * `:array`