Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix #547 - ut_assert doc updates #548

Merged
merged 1 commit into from
Jul 22, 2020
Merged

fix #547 - ut_assert doc updates #548

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion ut_assert/README.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
core Flgith System (cFS) Unit Test (UT) Assert Library
core Flight System (cFS) Unit Test (UT) Assert Library

Introduction

Expand Down
11 changes: 5 additions & 6 deletions ut_assert/inc/utstubs.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,14 +109,13 @@ typedef int32 (*UT_VaHookFunc_t)(void *UserObj, int32 StubRetcode, uint32 CallCo
**************************************************************/

/**
* Reset the Unit test framework for only the given function
* Reset the Unit test framework for a given function, or all functions
*
* Any return code or data buffer records for the given function key
* are cleared. The special FuncKey value of "0" matches all entries.
* are cleared.
*
* \param FuncKey The stub function to reset. If zero, all functions
* are reset. This is basically equivalent to UT_Init() without
* changing the Subsys string.
* are reset.
*/
void UT_ResetState(UT_EntryKey_t FuncKey);

Expand All @@ -126,7 +125,7 @@ void UT_ResetState(UT_EntryKey_t FuncKey);
* A deferred ("count down") return code for the stub function will be
* installed. The specific implementation depends on the stub function,
* but typically it will return its default code until it is called "Count"
* times, after which it will return the given Retcode, then return to
* times, where it will return the given Retcode, then return to
* its default return code again.
*
* Multiple deferred entries for a single function are allowed. These
Expand All @@ -152,7 +151,7 @@ void UT_SetDeferredRetcode(UT_EntryKey_t FuncKey, int32 Count, int32 Retcode);
* Multiple buffer entries for a single function are allowed. These
* will be used in the order they were added.
*
* It is recommended to call UT_ResetState() at the beginning of the test case
* It is recommended to call UT_ResetState(0) at the beginning of the test case
* to ensure that any old entries for the stub functions are cleared out.
*
* \param FuncKey The stub function to add the data buffer to.
Expand Down