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 #17, Fix Doxygen Warnings #18

Merged
merged 3 commits into from
Apr 24, 2020
Merged

Fix #17, Fix Doxygen Warnings #18

merged 3 commits into from
Apr 24, 2020

Conversation

lbleier-GSFC
Copy link
Contributor

@lbleier-GSFC lbleier-GSFC commented Apr 10, 2020 •
edited
Loading

Describe the contribution
Fixes #17 to resolve doxygen warnings

Testing performed
Steps taken to test the contribution:

  1. Corrected lines that generated warnings
  2. Rebuilt documentation with make doc
  3. Observed no warnings generated
  4. Viewed relevant page(s) to verify correctness

Expected behavior changes
Changes to documentation only; no code impact

Contributor Info - All information REQUIRED for consideration of pull request
Leor Bleier, NASA\GSFC

skliper
skliper reviewed Apr 10, 2020
View reviewed changes
fsw/public_inc/sample_lib.h Outdated
** \returns
** \retstmt Returns #CFE_SUCCESS if successful \endcode
** \endreturns
** \returns Returns #CFE_SUCCESS
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggest - \return Execution status, see \ref CFEReturnCodes

@astrogeco astrogeco added the docs label Apr 13, 2020
@astrogeco astrogeco changed the title Fix17 fixdocwarnings Fix #17, fixdocwarnings Apr 13, 2020
@astrogeco astrogeco linked an issue Apr 13, 2020 that may be closed by this pull request
Fix doxygen warnings #17
Closed
@astrogeco astrogeco changed the title Fix #17, fixdocwarnings Fix #17, Fix Doxygen Warnings Apr 13, 2020
skliper
skliper requested changes Apr 15, 2020
View reviewed changes
Copy link
Contributor

@skliper skliper left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See updated return message comment (for consistency)

@skliper skliper added the CCB:Ready PR or Issue is ready for discussion at the Configuration Control Board (CCB) label Apr 15, 2020
@skliper
Copy link
Contributor

skliper commented Apr 22, 2020

20200422 CCB - APPROVED

@skliper skliper added CCB:Approved Indicates code review and approval by community CCB and removed CCB:Ready PR or Issue is ready for discussion at the Configuration Control Board (CCB) labels Apr 22, 2020
@astrogeco astrogeco merged commit a561fbf into nasa:integration-candidate Apr 24, 2020
@astrogeco astrogeco mentioned this pull request Apr 27, 2020
Merged
@skliper skliper added this to the 1.2.0 milestone Jun 1, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@skliper skliper skliper approved these changes

Assignees
No one assigned
Labels
CCB:Approved Indicates code review and approval by community CCB CCB:FastTrack docs
Projects
None yet
Milestone
Bootes
Development

Successfully merging this pull request may close these issues.

Fix doxygen warnings
3 participants
@lbleier-GSFC @skliper @astrogeco