From dcd6fe44af634ff7b895a2989627174fecdff62b Mon Sep 17 00:00:00 2001 From: Mark VanderVoord Date: Wed, 5 Apr 2017 14:49:55 -0400 Subject: [PATCH] Updated docs Fixed a couple little issues and added a note about example projects --- docs/CMock_Summary.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/docs/CMock_Summary.md b/docs/CMock_Summary.md index faba3b2..a6b2f6d 100644 --- a/docs/CMock_Summary.md +++ b/docs/CMock_Summary.md @@ -162,7 +162,7 @@ care how many times it was called, right? * `retval func(params)` => `void func_IgnoreAndReturn(retval_to_return)` -Ignore Args: +Ignore Arg: ------------ Maybe you overall want to use Expect and its similar variations, but you don't care @@ -577,3 +577,12 @@ based on other settings, particularly Unity's settings. This needs to be something big enough to point anywhere in Cmock's memory space... usually it's an unsigned int. +Examples +======== + +You can look in the examples directory for a couple of examples on how +you might tool CMock into your build process. You may also want to consider +using [Ceedling](https://throwtheswitch.org/Ceedling). Please note that +these examples are meant to show how the build process works. They have +failing tests ON PURPOSE to show what that would look like. Don't be alarmed. ;) +