doc: improve spi.h doxygen comments layout #1424
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
Doxygen comments for documenting structs have (known) issues, and the Breathe addon for Sphinx used to create our API docs has a known issue with forcing line breaks with @n or <br/> This patch tweaks the comments to use a method used in i2s.h to use @param comments for the members of a struct, and using 4 leading spaces (as done in i2s.h as well) to create a pre block for the bit-field layout comments. Fixes: #1415 Signed-off-by: David B. Kinder <[email protected]>
|
@dbkinder I have generated documentation for you pull request and it looks really nice. That empty line however looks weird in header file. Is it temporary workaround or a new way in which we are going to document structure members that are bit fields? |
nagineni
pushed a commit
to nagineni/zephyr
that referenced
this pull request
Nov 20, 2017
…oject-rtos#1424) The callstack of 2k is causing segfault in BLE stack, for example, when it starts physical web advertising, or the Websocket over 6lowpan, increasing it to 4k fixes the segfault. Fixes zephyrproject-rtos#1369 zephyrproject-rtos#1421 Signed-off-by: Jimmy Huang <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Doxygen comments for documenting structs have (known) issues,
and the Breathe addon for Sphinx used to create our API docs
has a known issue with forcing line breaks with @n or
<br/>This patch tweaks the comments to use a method used in i2s.h
to use @param comments for the members of a struct, and using
4 leading spaces (as done in i2s.h as well) to create a pre
block for the bit-field layout comments.
Fixes: #1415
Signed-off-by: David B. Kinder [email protected]