Skip to content

Watchdog: Clean up the doxygen comments #10954

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
Merged
merged 3 commits into from
Jul 9, 2019
Merged

Watchdog: Clean up the doxygen comments #10954

merged 3 commits into from
Jul 9, 2019

Conversation

fkjagodzinski
Copy link
Member

Description

This patch updates the doxygen comments for the new Watchdog driver class. A couple of outdated comments have been updated to reflect the current driver implementation. I also added a general description of how the watchdog operates.

Pull request type

[ ] Fix
[ ] Refactor
[ ] Target update
[ ] Functionality change
[x] Docs update
[ ] Test update
[ ] Breaking change

Reviewers

@0xc0170

Release Notes

@ciarmcom ciarmcom requested review from 0xc0170 and a team July 3, 2019 15:00
@ciarmcom
Copy link
Member

ciarmcom commented Jul 3, 2019

@fkjagodzinski, thank you for your changes.
@0xc0170 @ARMmbed/mbed-os-core @ARMmbed/mbed-os-maintainers please review.

bulislaw
bulislaw suggested changes Jul 3, 2019
View reviewed changes
Copy link
Member

@bulislaw bulislaw left a comment

Choose a reason for hiding this comment

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

@AnotherButler could you have a look at the doxygen in this header please.

Edit Watchdog.h
ec53d1d 
Edit file to address comments and for consistent tense and voice.
@fkjagodzinski
Copy link
Member Author

@bulislaw, @AnotherButler thanks for your input. 👍

Fixed astyle, so travis-ci/astyle should be good now.

@artokin artokin requested a review from bulislaw July 8, 2019 09:08
@artokin
Copy link
Contributor

artokin commented Jul 8, 2019

CI started

@mbed-ci
Copy link

mbed-ci commented Jul 8, 2019

Test run: SUCCESS

Summary: 11 of 11 test jobs passed
Build number : 1
Build artifacts

@0xc0170 0xc0170 merged commit f0ec856 into ARMmbed:master Jul 9, 2019
@fkjagodzinski fkjagodzinski deleted the docs_update-watchdog_driver branch July 9, 2019 07:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@0xc0170 0xc0170 0xc0170 approved these changes

@AnotherButler AnotherButler AnotherButler approved these changes

@bulislaw bulislaw Awaiting requested review from bulislaw

Assignees
No one assigned
Labels
release-version: 5.13.1
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
9 participants
@fkjagodzinski @ciarmcom @artokin @mbed-ci @bulislaw @0xc0170 @AnotherButler @adbridge @evedon