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

Update OS_TimerSet API documentation for timer disable #10

Closed
skliper opened this issue Sep 13, 2019 · 1 comment · Fixed by #371 or #375
Closed

Update OS_TimerSet API documentation for timer disable #10

skliper opened this issue Sep 13, 2019 · 1 comment · Fixed by #371 or #375
Labels
docs
Milestone
Bootes

Comments

@skliper
Copy link
Contributor

skliper commented Sep 13, 2019

Is your feature request related to a problem? Please describe.
As stated in #9, the OS_TimerSet documentation does not match behavior.

Describe the solution you'd like
API documentation should describe OS_TimerDelete() as the method to cancel the timer (not a start time of zero)

Describe alternatives you've considered
None

Additional context
None

Requester Info
Jacob Hageman/NASA-GSFC
@skliper skliper added this to the 5.0.0 milestone Sep 16, 2019
@avan989
Copy link
Contributor

avan989 commented Sep 17, 2019

I'll do this.

skliper added a commit that referenced this issue Oct 1, 2019
@skliper
Merge pull request #20 from avan989/updateDoc
bd73bde 
Fix #10, Update documentations for OS_TimerSet
skliper added a commit that referenced this issue Oct 1, 2019
@skliper
CCB 2019-09-25: Merge #10, #11, #15, #17
4f6afbe 
Reviewed and approved at 2019-09-25 CCB
@skliper skliper closed this as completed in e572937 Oct 2, 2019
@skliper skliper modified the milestones: 5.0.0, 5.1.0 Oct 2, 2019
@skliper skliper mentioned this issue Mar 15, 2020
Closed
skliper added a commit to skliper/osal that referenced this issue Mar 15, 2020
@skliper
Fix nasa#10, Update timing API documentation
1aa87de 
Replicated changes to old documents that were
done previously.  Document/comment change only.
@skliper skliper mentioned this issue Mar 15, 2020
Merged
@astrogeco astrogeco mentioned this issue Mar 23, 2020
Merged
@astrogeco astrogeco added the docs label Sep 22, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
docs
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
Integration Candidate 2020-03-18 nasa/osal
3 participants
@avan989 @skliper @astrogeco