Bluetooth: GATT: Clarify start and end handles #88234
Conversation
github-actions
bot
added
area: Bluetooth Host
github-actions
bot
requested review from
alwa-nordic,
cvinayak,
hermabe,
jhedberg,
rugeGerritsen,
sjanc and
theob-pro
omkar3141
force-pushed
the
omku/gatt_doc_update
branch
from
7f69800 to
53e6734
Compare
There was a problem hiding this comment.
I think we should be careful to not tell how to use this in specific cases, when they can be use in many cases. I think some of the documentation added in this PR attempts to tell users how/when to call this function but with using only a very small subset of how/when.
omkar3141
force-pushed
the
omku/gatt_doc_update
branch
from
53e6734 to
531ef11
Compare
include/zephyr/bluetooth/gatt.h
Outdated
| * point of the range over which this read should | ||
| * be performed. For example, this could be set to | ||
| * @ref BT_ATT_FIRST_ATTRIBUTE_HANDLE to set the | ||
| * starting point of the range at the beginning of | ||
| * the GATT database, or to the starting handle of a |
There was a problem hiding this comment.
It generally also seems like you are using a column width of 80 instead of 100. Suggest to use 100 as that is our maximum in Zephyr
There was a problem hiding this comment.
Again, sticking to existing pattern in gatt.h. Do you insist to change this?
There was a problem hiding this comment.
Column width is not really a pattern IMO :D There are many places in gatt.h that uses column width >80, so I suggest we continue with that
|
The commit message header should also be updated from |
omkar3141
force-pushed
the
omku/gatt_doc_update
branch
from
531ef11 to
6f23ab1
Compare
omkar3141
changed the title
omkar3141
force-pushed
the
omku/gatt_doc_update
branch
from
6f23ab1 to
e5f324b
Compare
jhedberg
changed the title
|
@omkar3141 there are some merge conflicts that need to be fixed |
omkar3141
force-pushed
the
omku/gatt_doc_update
branch
from
e5f324b to
004b447
Compare
omkar3141
force-pushed
the
omku/gatt_doc_update
branch
from
004b447 to
4f5cc7a
Compare
omkar3141
force-pushed
the
omku/gatt_doc_update
branch
from
4f5cc7a to
178e125
Compare
There was a problem hiding this comment.
Pull Request Overview
This PR clarifies the documentation for the GATT API by updating the parameter descriptions for start and end handles. The changes update Doxygen comments both for attribute iteration functions and discovery/read parameters to improve clarity.
- Updated function comments to explicitly refer to "Starting attribute handle" and "Ending attribute handle".
- Enhanced descriptions in the bt_gatt_discover_params and bt_gatt_read_params structures.
- Maintained consistency in terminology across the API documentation.
Clarifies what does start_handle and end_handle means in the GATT API. Signed-off-by: Omkar Kulkarni <[email protected]>
omkar3141
force-pushed
the
omku/gatt_doc_update
branch
from
178e125 to
858633e
Compare
Clarifies what does start_handle and end_handle means in the GATT API.