Skip to content

UtAssert_Message doxygen comments should include params #574

New issue
New issue
Closed
#744
#713
Closed
UtAssert_Message doxygen comments should include params#574
#744
#713
Labels
docsunit-testTickets related to the OSAL unit testing (functional and/or coverage)
Milestone
Caelum
@asgibson

Description

@asgibson
asgibson
opened on Aug 20, 2020

Describe the bug
There are no param items listed in the UtAssert_Message method in utassert.h

To Reproduce
N/A

Expected behavior
Add param descriptions.

Code snips

osal/ut_assert/inc/utassert.h

Lines 267 to 276 in ff5b38d

/**
* 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.
*/
void UtAssert_Message(uint8 MessageType, const char *File, uint32 Line, const char *Spec, ...) OS_PRINTF(4,5);

System observed on:
RHEL 7.6

Additional context
N/A

Reporter Info
Alan Gibson NASA GSFC/587

Metadata

Metadata

Assignees

No one assigned

    Labels

    docsunit-testTickets related to the OSAL unit testing (functional and/or coverage)

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions