diff --git a/docs/CMock Summary.odt b/docs/CMock Summary.odt new file mode 100644 index 0000000..6f5cfb3 Binary files /dev/null and b/docs/CMock Summary.odt differ diff --git a/docs/CMock Summary.pdf b/docs/CMock Summary.pdf new file mode 100644 index 0000000..ecc9149 Binary files /dev/null and b/docs/CMock Summary.pdf differ diff --git a/docs/CMock Summary.txt b/docs/CMock Summary.txt new file mode 100644 index 0000000..8031c2b --- /dev/null +++ b/docs/CMock Summary.txt @@ -0,0 +1,33 @@ +CMock Generated Mock Module Summary +=================================== + + +CMock will generate expect functions as follows: + +Original Function => Generated Mock Function +---------------------------------------------- +void func(void) => void func_Expect(void) +void func(params) => void func_Expect(expected_params) +retval func(void) => void func_ExpectAndReturn(retval_to_return) +retval func(params) => void func_ExpectAndReturn(expected_params, retval_to_return) + + +CMock will generate the following expect functions, in addition to those above, if the CException plugin is used: + +Original Function => Generated Mock Function +---------------------------------------------- +void func(void) => void func_ExpectAndThrow(value_to_throw) +void func(params) => void func_ExpectAndThrow(expected_params, value_to_throw) +retval func(void) => void func_ExpectAndThrow(value_to_throw) +retval func(params) => void func_ExpectAndThrow(expected_params, value_to_throw) + + +CMock will generate the following expect functions, in addition to those above, if the CIgnore plugin is used: + +Original Function => Generated Mock Function +---------------------------------------------- +void func(void) => void func_Ignore(void) +void func(params) => void func_Ignore(void) +retval func(void) => void func_IgnoreAndReturn(retval_to_return) +retval func(params) => void func_IgnoreAndReturn(retval_to_return) +