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

Jump to bottom

Fix #574, Document UtAssert_Message parameters #713

Merged
merged 1 commit into from
Jan 6, 2021
Merged

Fix #574, Document UtAssert_Message parameters #713

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
11 changes: 9 additions & 2 deletions ut_assert/inc/utassert.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -272,13 +272,20 @@ bool UtAssertEx(bool Expression, UtAssert_CaseType_t CaseType, const char *File,
void UtAssert_Abort(const char *Message);

/**
* Output an informational message to the console/log file
* \brief Output an informational message to the console/log file
*
* Just like the standard printf except it will output to the given status channel (see utassert.h)
*
* This calls into the UT BSP function to actually write the message
* to the current output device. This may be the console or a log file
* or something else depending on what BSP is in use.
*
* \param MessageType Message case type
* \param File File name containing the message
* \param Line Line number containing the message
* \param Spec printf style format followed by args of message
*
* \sa Helper macros: UtPrintf(), UtDebug()
*/
void UtAssert_Message(uint8 MessageType, const char *File, uint32 Line, const char *Spec, ...) OS_PRINTF(4, 5);

Expand All @@ -292,7 +299,7 @@ void UtAssert_Message(uint8 MessageType, const char *File, uint32 Line, const ch
*
* \param File File containing the test case
* \param LineNum Line number containing the test case
* \param MessageType Should be set to either UT_MESSAGE_PASS or UT_MESSAGE_FAILURE.
* \param MessageType Message case type
* \param SubsysName The subsystem under test (abbreviated name)
* \param ShortDesc Short description of the test case
* \param SegmentNum Sequence among the overall/global test Segments
Expand Down