ThrowTheSwitch/CMock
1
0
Fork 0
mirror of https://github.com/ThrowTheSwitch/CMock.git synced 2026-07-30 07:47:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

- Added initial documentation

Browse Source 
git-svn-id: http://cmock.svn.sourceforge.net/svnroot/cmock/trunk@32 bf332499-1b4d-0410-844d-d2d48d5cc64c
This commit is contained in:
greg-williams
2008-10-28 20:59:38 +00:00
parent e6488ca1c8
commit 379cd02c5c
3 changed files with 33 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/CMock Summary.odt
BIN
View File
Binary file not shown.
docs/CMock Summary.pdf
BIN
View File
Binary file not shown.
docs/CMock Summary.txt
+33
View File
@@ -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)