host/iso: Add doxygen comments in the header file #1694
Merged
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
nimble/host/include/host/ble_iso.h
Outdated
| struct ble_iso_big_desc | ||
| { | ||
| /** | ||
| * The identifier of the BIG. Assigned by the Host when a new BIG is | ||
| * created. The value shall be between 0x00 and 0xEF. |
There was a problem hiding this comment.
Nitpick:
Suggested change
| * created. The value shall be between 0x00 and 0xEF. | |
| * created. |
IMO the possible values is redundant information as it's value assigned by the host, not a function parameter provided by the user.
nimble/host/include/host/ble_iso.h
Outdated
Comment on lines
58
to
69
| /** | ||
| * The maximum time in microseconds for transmission of PDUs of all BISes in | ||
| * a BIG event. The value of BIG_Sync_Delay shall equal the time from the | ||
| * anchor point to the BIG Synchronization point and shall be between | ||
| * 0x0000EA and 0x7FFFFF. | ||
| */ |
There was a problem hiding this comment.
Ditto, probably just a short description like below would be sufficient
Suggested change
| /** | |
| * The maximum time in microseconds for transmission of PDUs of all BISes in | |
| * a BIG event. The value of BIG_Sync_Delay shall equal the time from the | |
| * anchor point to the BIG Synchronization point and shall be between | |
| * 0x0000EA and 0x7FFFFF. | |
| */ | |
| /** | |
| * The maximum time in microseconds for transmission of PDUs of all BISes in | |
| * a BIG event. | |
| */ |
nimble/host/include/host/ble_iso.h
Outdated
Comment on lines
66
to
75
| /** | ||
| * The actual transport latency of transmitting payloads of all BISes in the | ||
| * BIG in microseconds. The value shall be between 0x0000EA and 0x7FFFFF. | ||
| */ |
There was a problem hiding this comment.
Ditto
Suggested change
| /** | |
| * The actual transport latency of transmitting payloads of all BISes in the | |
| * BIG in microseconds. The value shall be between 0x0000EA and 0x7FFFFF. | |
| */ | |
| /** | |
| * The actual transport latency of transmitting payloads of all BISes in the | |
| * BIG in microseconds. | |
| */ |
nimble/host/include/host/ble_iso.h
Outdated
Comment on lines
72
to
77
| /** | ||
| * The PHY used to create the BIG. The value shall be one of the following: | ||
| * o BLE_HCI_LE_PHY_1M | ||
| * o BLE_HCI_LE_PHY_2M | ||
| * o BLE_HCI_LE_PHY_CODED | ||
| */ |
There was a problem hiding this comment.
Suggested change
| /** | |
| * The PHY used to create the BIG. The value shall be one of the following: | |
| * o BLE_HCI_LE_PHY_1M | |
| * o BLE_HCI_LE_PHY_2M | |
| * o BLE_HCI_LE_PHY_CODED | |
| */ | |
| /** | |
| * The PHY used to create the BIG. The value can be one of the following: | |
| * o BLE_HCI_LE_PHY_1M | |
| * o BLE_HCI_LE_PHY_2M | |
| * o BLE_HCI_LE_PHY_CODED | |
| */ |
nimble/host/include/host/ble_iso.h
Outdated
Comment on lines
80
to
83
| /** | ||
| * The number of subevents per BIS in each BIG event. The value shall be | ||
| * between 1 and 31 and shall be an integer multiple of BN. | ||
| */ |
There was a problem hiding this comment.
Suggested change
| /** | |
| * The number of subevents per BIS in each BIG event. The value shall be | |
| * between 1 and 31 and shall be an integer multiple of BN. | |
| */ | |
| /** | |
| * The number of subevents per BIS in each BIG event. | |
| */ |
nimble/host/include/host/ble_iso.h
Outdated
Comment on lines
113
to
116
| /** | ||
| * The time between two adjacent BIG anchor points in units of 1.25 ms. The | ||
| * value shall be between 0x0004 and 0x0C80 (i.e. 5 ms to 4 s). | ||
| */ |
There was a problem hiding this comment.
Suggested change
| /** | |
| * The time between two adjacent BIG anchor points in units of 1.25 ms. The | |
| * value shall be between 0x0004 and 0x0C80 (i.e. 5 ms to 4 s). | |
| */ | |
| /** | |
| * The time between two adjacent BIG anchor points in units of 1.25 ms. | |
| */ |
nimble/host/include/host/ble_iso.h
Outdated
Comment on lines
119
to
121
| /** | ||
| * The total number of BISes in the BIG. The value shall be between 1 and 31. | ||
| */ |
There was a problem hiding this comment.
Suggested change
| /** | |
| * The total number of BISes in the BIG. The value shall be between 1 and 31. | |
| */ | |
| /** | |
| * The total number of BISes in the BIG. | |
| */ |
nimble/host/include/host/ble_iso.h
Outdated
Comment on lines
124
to
127
| /** | ||
| * The connection handles of all the BIS in the BIG. The value shall be | ||
| * between 0x0000 and 0x0EFF. | ||
| */ |
There was a problem hiding this comment.
Suggested change
| /** | |
| * The connection handles of all the BIS in the BIG. The value shall be | |
| * between 0x0000 and 0x0EFF. | |
| */ | |
| /** | |
| * The connection handles of all the BIS in the BIG. | |
| */ |
nimble/host/include/host/ble_iso.h
Outdated
Comment on lines
199
to
244
| /** | ||
| * The PHY parameter is a bit field that indicates the PHY used for | ||
| * transmission of PDUs of BISes in the BIG. The value can be one of the | ||
| * following: | ||
| * o BLE_HCI_LE_PHY_1M_PREF_MASK | ||
| * o BLE_HCI_LE_PHY_2M_PREF_MASK | ||
| * o BLE_HCI_LE_PHY_CODED_PREF_MASK | ||
| */ |
There was a problem hiding this comment.
Suggested change
| /** | |
| * The PHY parameter is a bit field that indicates the PHY used for | |
| * transmission of PDUs of BISes in the BIG. The value can be one of the | |
| * following: | |
| * o BLE_HCI_LE_PHY_1M_PREF_MASK | |
| * o BLE_HCI_LE_PHY_2M_PREF_MASK | |
| * o BLE_HCI_LE_PHY_CODED_PREF_MASK | |
| */ | |
| /** | |
| * The PHY parameter is a bit field that indicates the PHY used for | |
| * transmission of PDUs of BISes in the BIG. The value shall be one of the | |
| * following: | |
| * o BLE_HCI_LE_PHY_1M_PREF_MASK | |
| * o BLE_HCI_LE_PHY_2M_PREF_MASK | |
| * o BLE_HCI_LE_PHY_CODED_PREF_MASK | |
| */ |
nimble/host/include/host/ble_iso.h
Outdated
Comment on lines
209
to
252
| /** | ||
| * Indicates the preferred method of arranging subevents of multiple BISes. | ||
| * The value can be one of the following: | ||
| * o 0x00 - Sequential | ||
| * o 0x01 - Interleaved | ||
| */ |
There was a problem hiding this comment.
Suggested change
| /** | |
| * Indicates the preferred method of arranging subevents of multiple BISes. | |
| * The value can be one of the following: | |
| * o 0x00 - Sequential | |
| * o 0x01 - Interleaved | |
| */ | |
| /** | |
| * Indicates the preferred method of arranging subevents of multiple BISes. | |
| * The value shall be one of the following: | |
| * o 0x00 - Sequential | |
| * o 0x01 - Interleaved | |
| */ |
and in other places
Adds missing structures and functions documentation.
KKopyscinski
approved these changes
Feb 28, 2024
sjanc
approved these changes
Feb 28, 2024
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.
Adds missing structures and functions documentation.