Add ResetReason and Watchdog driver docs #1099
Conversation
fkjagodzinski
force-pushed
the
docs_update-watchdog
branch
from
d754306 to
5f7929f
Compare
|
@AnotherButler I updated the docs as you requested. I hope they're OK now. I'm not sure how the links (also listed in this PR's TODO) should be updated. Could you take care of that, please? |
|
@fkjagodzinski Thanks for the updates. That's exactly what I was looking for. 👍 I'll update the links, but we have to wait until the code merges to master. |
Make minor tweaks.
Make minor copy edits, mostly for stylistic changes.
|
@0xc0170 Are you happy with this now? |
Fix Watchdog API reference link, so it points to correct Doxygen class.
Add link to .h file.
docs/api/drivers/ResetReason.md
Outdated
|
|
||
| ### ResetReason class reference | ||
|
|
||
| [](https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/_reset_reason_8h_source.html) |
There was a problem hiding this comment.
I've found the .h file in the Doxygen, but I can't find the class reference. I thought it would be here: https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/annotated.html but I don't see it.
There was a problem hiding this comment.
I'm not sure if I can help here. Taking a Ticker class as an example, the v5.13 doxy can be found here:
https://os.mbed.com/docs/mbed-os/v5.13/mbed-os-api-doxy/classmbed_1_1_ticker.html
So I think we should expect ResetReason in NEW_DOCS_VERSION:
https://os.mbed.com/docs/mbed-os/NEW_DOCS_VERSION/mbed-os-api-doxy/classmbed_1_1_reset_reason.html
and Watchdog in:
https://os.mbed.com/docs/mbed-os/NEW_DOCS_VERSION/mbed-os-api-doxy/classmbed_1_1_watchdog.html
At least these are the filenames I get when generating the doxygen locally.
There was a problem hiding this comment.
The one for Watchdog is here: https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/classmbed_1_1_watchdog.html, but I can't find the one for ResetReason. There may be something wrong with the doxyfile_options files. @0xc0170 Can you help?
There was a problem hiding this comment.
I think ARMmbed/mbed-os#10990 should fix this.
There was a problem hiding this comment.
That worked. 👍 Thanks for the PR.
Replace .h file transclusion with tranclusion of class reference.
|
@0xc0170 Are you happy with this? |
Apply changes from PR #1099 to add content about the ResetReason driver to v5.13.
Add documentation for the Watchdog driver by applying changes from PR #1099 .
Add docs for the new drivers introduced in ARMmbed/mbed-os#10857.
This is mostly based on #404 (I wasn't able to cherry-pick these commits though). The
ResetReason.mdis unchanged.Watchdog.mdis updated.TODO:
ResetReasonclass reference link,Watchdogclass reference link.