Improve documentation of the libwdog supervisor API #34
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Implements the changes proposed in troglobit#33 Signed-off-by: Andreas Helbech Kleist <akle@ambu.com>
Kleist
commented
Jun 20, 2022
| @@ -257,6 +256,8 @@ int wdog_kick2 (int id, unsigned int *ack); | |||
| int wdog_extend_kick (int id, unsigned int timeout, unsigned int *ack); | |||
| ``` | |||
|
|
|||
| See [wdog.h](src/wdog.h) for detailed API documentation. | |||
There was a problem hiding this comment.
I considered adding the full Doxygen comments here, but I think it might be too verbose for the README file.
|
lgtm. I'll probably build on this later, for the next release, adding to the ci pipeline and setting up some host (probably https://codedocs.xyz/) to publish. Thanks so much for this, very appreciated! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Implements the changes proposed in #33
Signed-off-by: Andreas Helbech Kleist akle@ambu.com