User's guide scrub #540
Description
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