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

User's guide scrub #540

Closed
skliper opened this issue Mar 3, 2020 · 0 comments
Closed

User's guide scrub #540

skliper opened this issue Mar 3, 2020 · 0 comments
Assignees
Milestone

Comments

@skliper
Copy link
Contributor

skliper commented Mar 3, 2020

Is your feature request related to a problem? Please describe.
User's guide out of date and inconsistant

Describe the solution you'd like
General scrub of users guide

  • Replace non-documented formatting mechanisms for return codes (causes errors)
    • Custom table aliases for return values causing issues, use built in
  • Make references into links where needed
  • Fix links where needed (remove private links)
  • Remove duplicated documentation in *.c files (API's documented in *.h, with prototype)
  • Remove duplicated brief in API table (pull from object brief)
  • Remove xrefitem style formatting (caused warnings, see Remove old ASIST mnemonics from doxygen comments #553)
  • Fix glossary table
  • Fix use of BSP where PSP applies
  • Performance collection focused on cFE, not tool (updated reference for java tool)
  • Update Event Message Format documentation to match order/contents
  • Update applicable documents with modern references
  • Removed no-longer-up-to-date dox templates (eclipse header templates)
  • Cleaned up SB sequence counter section
  • Added a couple FAQs
  • Single sourced the versioning section
  • Resolved ALL doxygen warnings (including those detailed in doxygen warning expected <TR> tag and illegal command #403)

Describe alternatives you've considered
None

Additional context
Related issues: #212, #261, #267, #389, #403, #499, #506, #508, #531, #536
Looks like EDS file for SB needs GetPipeIdByNameErrorCounter

Future considerations

  • scrub return codes, not all listed in current API documentation
  • remove autodoc, explicitly document (futureproof from missing documentation)

Requester Info
Jacob Hageman - NASA/GSFC

@skliper skliper added this to the 6.8.0 milestone Mar 3, 2020
@skliper skliper self-assigned this Mar 3, 2020
skliper added a commit to skliper/cFE that referenced this issue Mar 13, 2020
NOTE - Comments/documentation only, no logic updates
skliper added a commit to skliper/cFE that referenced this issue Mar 13, 2020
NOTE - Comments/documentation only, no logic updates
Also fixes nasa#403, resolves all warnings
@skliper skliper changed the title WIP: User's guide scrub User's guide scrub Mar 13, 2020
lbleier-GSFC pushed a commit to lbleier-GSFC/cFE that referenced this issue Apr 6, 2020
NOTE - Comments/documentation only, no logic updates
Also fixes nasa#403, resolves all warnings
Also fixes nasa#536, comment typo in CFE_SB_RcvMsg implementation header
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.

1 participant