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

OSAL API Documentation Should Be Doxygen Based #144

Closed
skliper opened this issue Sep 30, 2019 · 3 comments · Fixed by #371
Closed

OSAL API Documentation Should Be Doxygen Based #144

skliper opened this issue Sep 30, 2019 · 3 comments · Fixed by #371
Assignees
@skliper
Labels
enhancement
Milestone
Bootes

Comments

@skliper
Copy link
Contributor

skliper commented Sep 30, 2019

The OSAL API documents are currently available as separate word and .pdf documents. The API's are defined and maintained in the source code. Any changes or new findings to the API's can easily get left undocumented, creating a disconnect between the source code and what is stated in the OSAL API word and .pdf documents. It is highly recommended to couple the documentation with the source code via doxygen.
@skliper skliper self-assigned this Sep 30, 2019
@skliper
Copy link
Contributor Author

skliper commented Sep 30, 2019

Imported from trac issue 121. Created by sstrege on 2015-11-30T17:28:19, last modified: 2019-08-14T14:11:46

@skliper skliper added the bug label Sep 30, 2019
@skliper skliper removed their assignment Sep 30, 2019
@skliper skliper added this to the 5.1.0 milestone Oct 22, 2019
@skliper skliper added enhancement and removed bug labels Oct 22, 2019
@skliper
Copy link
Contributor Author

skliper commented Jan 2, 2020

See nasa/cFE#445

Just need to cross check old document with doxygen to confirm everything needed exists.

@skliper skliper linked a pull request Mar 18, 2020 that will close this issue
Fix #364 and others, Scrub user's guide #371
Merged
@skliper skliper self-assigned this Mar 18, 2020
@skliper
Copy link
Contributor Author

skliper commented Jun 5, 2020

Closed by #371

@skliper skliper closed this as completed Jun 5, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@skliper skliper

Labels
enhancement
Projects
None yet
Milestone
Bootes
Development

Successfully merging a pull request may close this issue.

Fix #364 and others, Scrub user's guide skliper/osal
1 participant
@skliper