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

Fix #2287, remove return value doxygen markup #2288

Merged
merged 1 commit into from
Apr 13, 2023

Conversation

jphickey
Copy link
Contributor

The CFE_ES_TaskRecordSetFree() function is a void, it should not have any documentation about return value. Remove this line. Appears to be a cut and paste error, produces a warning in newer Doxygen versions.

Checklist (Please check before submitting)

Describe the contribution
Fixes #2287

Testing performed
Build documentation

Expected behavior changes
None

System(s) tested on
Debian

Contributor Info - All information REQUIRED for consideration of pull request
Joseph Hickey, Vantage Systems, Inc.

The CFE_ES_TaskRecordSetFree() function is a void, it should not have
any documentation about return value.  Remove this line.  Appears to be
a cut and paste error, produces a warning in newer Doxygen versions.
@jphickey jphickey added the CCB:Ready Ready for discussion at the Configuration Control Board (CCB) label Apr 11, 2023
@dzbaker dzbaker added CCB:Approved Indicates code review and approval by community CCB and removed CCB:Ready Ready for discussion at the Configuration Control Board (CCB) labels Apr 13, 2023
dzbaker added a commit to nasa/cFS that referenced this pull request Apr 13, 2023
*Combines:*

cFE v7.0.0-rc4+dev268
sch_lab v2.5.0-rc4+dev53
to_lab v2.5.0-rc4+dev45

**Includes:**

*cFE*
- nasa/cFE#2254
- nasa/cFE#2288
- nasa/cFE#2290

*sch_lab*
- nasa/sch_lab#136

*to_lab*
- nasa/to_lab#139

Co-authored by: Joseph Hickey <[email protected]>
@dzbaker dzbaker merged commit eef72cc into nasa:main Apr 13, 2023
dzbaker added a commit to nasa/cFS that referenced this pull request Apr 13, 2023
*Combines:*

cFE v7.0.0-rc4+dev268
sch_lab v2.5.0-rc4+dev53
to_lab v2.5.0-rc4+dev45

**Includes:**

*cFE*
- nasa/cFE#2254
- nasa/cFE#2288
- nasa/cFE#2290

*sch_lab*
- nasa/sch_lab#136

*to_lab*
- nasa/to_lab#139

Co-authored by: Joseph Hickey <[email protected]>
@jphickey jphickey deleted the fix-2287-dox branch April 17, 2023 15:17
@dmknutsen dmknutsen added this to the Equuleus milestone May 26, 2023
@chillfig chillfig added the docs This change only affects documentation. label Aug 30, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CCB:Approved Indicates code review and approval by community CCB docs This change only affects documentation. Equuleus-rc1
Projects
None yet
Development

Successfully merging this pull request may close these issues.

return code doc on void function CFE_ES_TaskRecordSetFree()
4 participants