Add ResetReason and Watchdog driver docs #404
Conversation
Fix formatting for consistency across documentation.
Copy edit for active voice and formatting.
|
|
||
| [](http://os-doc-builder.test.mbed.com/docs/v5.8/mbed-os-api-doxy/classmbed_1_1_resetreason.html) | ||
|
|
||
| ### ResetReason example |
There was a problem hiding this comment.
Please add the examples from both files to the teams examples.
There was a problem hiding this comment.
What are the teams examples you're referring to?
There was a problem hiding this comment.
These: https://os.mbed.com/teams/mbed_example/
We've now given you access (we think), so please create your examples here, and let me know if you still need permissions.
|
|
||
| ### ResetReason class reference | ||
|
|
||
| [](http://os-doc-builder.test.mbed.com/docs/v5.8/mbed-os-api-doxy/classmbed_1_1_resetreason.html) |
There was a problem hiding this comment.
This link doesn't work. Please fix it.
There was a problem hiding this comment.
The intended pages don't currently exist. Could you generate the docs pages to link to under https://os.mbed.com/docs/v5.7/feature-hal-spec-watchdog-doxy/modules.html
There was a problem hiding this comment.
Thanks for letting me know. I'll talk with @iriark01 about having these rendered.
There was a problem hiding this comment.
Sorry, have what rendered? Is it just a feature branch to add?
There was a problem hiding this comment.
This isn't actually a feature branch. This is a driver page. Can you please help me find the correct link here: https://os-doc-builder.test.mbed.com/docs/development/mbed-os-api-doxy/annotated.html
There was a problem hiding this comment.
That might be exclusions from the mbed-os repo's branch.
There was a problem hiding this comment.
I can't see it in the exclusion, but I'm never quite sure how that works
https://github.com/ARMmbed/mbed-os/blob/feature-watchdog/doxygen_options.json
There was a problem hiding this comment.
Ahh thanks, it looks like it might be the lack of DEVICE_RESET_REASON and DEVICE_WATCHDOG in the predefined section.
There was a problem hiding this comment.
@scartmell-arm is that something you can fix?
|
|
||
| ### Watchdog class reference | ||
|
|
||
| [Add class reference here. Ask your editor for help if you've never done this before.] | ||
| [](http://os-doc-builder.test.mbed.com/docs/v5.8/mbed-os-api-doxy/classmbed_1_1_watchdog.html) |
There was a problem hiding this comment.
This link doesn't work. Please fix it.
There was a problem hiding this comment.
Can you please help me find the correct link here: https://os-doc-builder.test.mbed.com/docs/development/mbed-os-api-doxy/annotated.html
There was a problem hiding this comment.
There was a problem hiding this comment.
These are not contributing (porting) pages, so they should not go to feature branches.
ghost
mentioned this pull request
|
@scartmell-arm These are driver API documentation pages. They only relate to code on master. If this content is not yet on master, then it does not belong here yet. We only include feature-branch documentation in our contributing (porting) section, and those pages require warnings on them. |
|
Closing until this goes onto master. Please reopen when it's ready for review. |
|
@bulislaw FYI |
Uh oh!
There was an error while loading. Please reload this page.