improve can documentation #8385
Merged
Conversation
This file contains hidden or 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
0xc0170
previously requested changes
Oct 11, 2018
drivers/CAN.h
Outdated
| @@ -94,11 +94,15 @@ class CAN : private NonCopyable<CAN> { | |||
| * @code | |||
| * #include "mbed.h" | |||
| * | |||
| * #if defined (DEVICE_CAN) || defined(DOXYGEN_ONLY) | |||
There was a problem hiding this comment.
Is this a good example? I would leave this defined from the example - if CAN not supported, an error comes from CAN header file
There was a problem hiding this comment.
Hmm, right now the CAN header file won't give an error telling you that CAN is not supported. May be, we should add that there and skip it in the example all together?
…hould. Add "CAN_NOT_SUPPORTED" guard to header instead of example
|
Fix added. @0xc0170 , @AnotherButler please review. |
|
Actually I take that back. We cannot add it to the header file. |
AnotherButler
approved these changes
Oct 12, 2018
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.
Description
Improving documentation and modifying example in header to be correct. Hiding protected functions to appear on doxygen page.