mirror of
https://github.com/ThrowTheSwitch/Unity.git
synced 2025-07-15 00:52:46 +08:00
Documentation Updates
This commit is contained in:
@ -3,8 +3,9 @@
|
|||||||
Hi. Welcome to the coding standard for ThrowTheSwitch.org. For the most part,
|
Hi. Welcome to the coding standard for ThrowTheSwitch.org. For the most part,
|
||||||
we try to follow these standards to unify our contributors' code into a cohesive
|
we try to follow these standards to unify our contributors' code into a cohesive
|
||||||
unit (puns intended). You might find places where these standards aren't
|
unit (puns intended). You might find places where these standards aren't
|
||||||
followed. We're not perfect. Please be polite where
|
followed. We're not perfect. Please be polite where you notice these discrepancies
|
||||||
you notice these discrepancies and we'll try to be polite when we notice yours.
|
and we'll try to be polite when we notice yours.
|
||||||
|
|
||||||
;)
|
;)
|
||||||
|
|
||||||
|
|
||||||
@ -201,3 +202,6 @@ that happens, we like to indent further to line things up in nice tidy columns.
|
|||||||
|
|
||||||
Egad. Really? We use markdown and we like pdf files because they can be made to
|
Egad. Really? We use markdown and we like pdf files because they can be made to
|
||||||
look nice while still being portable. Good enough?
|
look nice while still being portable. Good enough?
|
||||||
|
|
||||||
|
|
||||||
|
*Find The Latest of This And More at [ThrowTheSwitch.org](https://throwtheswitch.org)*
|
||||||
|
@ -129,9 +129,9 @@ and double assertions (see immediately following section).
|
|||||||
|
|
||||||
### TEST_ASSERT_EACH_EQUAL_X Variants
|
### TEST_ASSERT_EACH_EQUAL_X Variants
|
||||||
|
|
||||||
Unity provides a collection of assertions for arrays containing a variety of
|
Unity provides a collection of assertions for arrays containing a variety of
|
||||||
types which can be compared to a single value as well. These are documented in
|
types which can be compared to a single value as well. These are documented in
|
||||||
the Each Equal section below. these are almost on par with the `_MESSAGE`
|
the Each Equal section below. these are almost on par with the `_MESSAGE`
|
||||||
variants of Unity's Asserts in that for pretty much any Unity type assertion you
|
variants of Unity's Asserts in that for pretty much any Unity type assertion you
|
||||||
can inject _EACH_EQUAL and run assertions on an entire block of memory.
|
can inject _EACH_EQUAL and run assertions on an entire block of memory.
|
||||||
|
|
||||||
@ -139,12 +139,12 @@ can inject _EACH_EQUAL and run assertions on an entire block of memory.
|
|||||||
|
|
||||||
"Expected" is a single value to compare to.
|
"Expected" is a single value to compare to.
|
||||||
"Actual" is an array where each element will be compared to the expected value.
|
"Actual" is an array where each element will be compared to the expected value.
|
||||||
"Size/count" is one of two parameters necessary to establish the number of array
|
"Size/count" is one of two parameters necessary to establish the number of array
|
||||||
elements and perhaps the length of elements within the array.
|
elements and perhaps the length of elements within the array.
|
||||||
|
|
||||||
Notes:
|
Notes:
|
||||||
- The `_MESSAGE` variant convention still applies here to Each Equal assertions.
|
- The `_MESSAGE` variant convention still applies here to Each Equal assertions.
|
||||||
- Assertions for handling Each Equal of floating point values are grouped with
|
- Assertions for handling Each Equal of floating point values are grouped with
|
||||||
float and double assertions (see immediately following section).
|
float and double assertions (see immediately following section).
|
||||||
|
|
||||||
|
|
||||||
@ -409,10 +409,10 @@ match. Failure messages specify the array index of the failed comparison.
|
|||||||
`expected` are single values and `actual` are arrays. `num_elements` specifies
|
`expected` are single values and `actual` are arrays. `num_elements` specifies
|
||||||
the number of elements in the arrays to compare.
|
the number of elements in the arrays to compare.
|
||||||
|
|
||||||
`_HEX` assertions produce failure messages with expected and actual array
|
`_HEX` assertions produce failure messages with expected and actual array
|
||||||
contents formatted in hexadecimal.
|
contents formatted in hexadecimal.
|
||||||
|
|
||||||
Assertions fail upon the first element in the compared arrays found not to
|
Assertions fail upon the first element in the compared arrays found not to
|
||||||
match. Failure messages specify the array index of the failed comparison.
|
match. Failure messages specify the array index of the failed comparison.
|
||||||
|
|
||||||
#### `TEST_ASSERT_EACH_EQUAL_INT (expected, actual, num_elements)`
|
#### `TEST_ASSERT_EACH_EQUAL_INT (expected, actual, num_elements)`
|
||||||
@ -710,4 +710,7 @@ with zeros.
|
|||||||
2. You're going to have to be careful of assertions that perform signed
|
2. You're going to have to be careful of assertions that perform signed
|
||||||
operations, particularly `TEST_ASSERT_INT_WITHIN`.Such assertions might wrap
|
operations, particularly `TEST_ASSERT_INT_WITHIN`.Such assertions might wrap
|
||||||
your `int` in the wrong place, and you could experience false failures. You can
|
your `int` in the wrong place, and you could experience false failures. You can
|
||||||
always back down to a simple `TEST_ASSERT` and do the operations yourself.
|
always back down to a simple `TEST_ASSERT` and do the operations yourself.
|
||||||
|
|
||||||
|
|
||||||
|
*Find The Latest of This And More at [ThrowTheSwitch.org](https://throwtheswitch.org)*
|
||||||
|
@ -392,4 +392,7 @@ every single test case throughout your entire suite of tests.
|
|||||||
|
|
||||||
The defines and macros in this guide should help you port Unity to just about
|
The defines and macros in this guide should help you port Unity to just about
|
||||||
any C target we can imagine. If you run into a snag or two, don't be afraid of
|
any C target we can imagine. If you run into a snag or two, don't be afraid of
|
||||||
asking for help on the forums. We love a good challenge!
|
asking for help on the forums. We love a good challenge!
|
||||||
|
|
||||||
|
|
||||||
|
*Find The Latest of This And More at [ThrowTheSwitch.org](https://throwtheswitch.org)*
|
||||||
|
@ -186,3 +186,6 @@ test set for that module. Then, this process is repeated for the next test file.
|
|||||||
This flexibility of separating tests into individual executables allows us to
|
This flexibility of separating tests into individual executables allows us to
|
||||||
much more thoroughly unit test our system and it keeps all the test code out of
|
much more thoroughly unit test our system and it keeps all the test code out of
|
||||||
our final release!
|
our final release!
|
||||||
|
|
||||||
|
|
||||||
|
*Find The Latest of This And More at [ThrowTheSwitch.org](https://throwtheswitch.org)*
|
||||||
|
@ -237,3 +237,6 @@ OVERALL UNITY TEST SUMMARY
|
|||||||
```
|
```
|
||||||
|
|
||||||
How convenient is that?
|
How convenient is that?
|
||||||
|
|
||||||
|
|
||||||
|
*Find The Latest of This And More at [ThrowTheSwitch.org](https://throwtheswitch.org)*
|
||||||
|
Reference in New Issue
Block a user