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.

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

Add missing doxygen to new UT Assert API #1361

Closed
jphickey opened this issue Feb 2, 2023 · 0 comments · Fixed by #1362
Closed

Add missing doxygen to new UT Assert API #1361

jphickey opened this issue Feb 2, 2023 · 0 comments · Fixed by #1362
Assignees
Milestone

Comments

@jphickey
Copy link
Contributor

jphickey commented Feb 2, 2023

Is your feature request related to a problem? Please describe.
cFS documentation workflow is failing with some undocumented parameters:

/home/runner/work/cFS/cFS/osal/ut_assert/inc/utstubs.h:201: warning: The following parameters of UT_ConfigureGenericStubReturnValue(UT_EntryKey_t FuncKey, const void *ValuePtr, size_t ValueSize, UT_ValueGenre_t ValueGenre, int32 DeferCount, const char *TypeName) are not documented:
  parameter 'ValuePtr'
  parameter 'ValueSize'
  parameter 'ValueGenre'
  parameter 'DeferCount'
  parameter 'TypeName'

Describe the solution you'd like
Add documentation

Additional context
This unfortunately is not found by OSAL CI workflows, it was found by CFS workflows only after merging to main. Potentially need to tweak workflows so this type of thing gets detected by the OSAL checks and/or a way to point the CFS workflow at the IC branch so it can be identified before merge.

Requester Info
Joseph Hickey, Vantage Systems, Inc.

@jphickey jphickey self-assigned this Feb 2, 2023
@jphickey jphickey added the bug label Feb 2, 2023
dzbaker added a commit that referenced this issue Feb 3, 2023
Fix #1361, add doxygen for UT_ConfigureGenericStubReturnValue
@dzbaker dzbaker closed this as completed in 6b4dd43 Feb 3, 2023
@chillfig chillfig added this to the Equuleus milestone Feb 7, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants