mynewt-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ad...@apache.org
Subject [2/4] incubator-mynewt-site git commit: BLE Host API - Add some comments for GATT defs.
Date Mon, 11 Jul 2016 21:19:51 GMT
BLE Host API - Add some comments for GATT defs.


Project: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/commit/b1efe048
Tree: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/tree/b1efe048
Diff: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/diff/b1efe048

Branch: refs/heads/develop
Commit: b1efe0481af5034532ac9921f8f2e089796da872
Parents: 3c2742f
Author: Christopher Collins <ccollins@apache.org>
Authored: Sat Jul 9 12:33:14 2016 -0700
Committer: Christopher Collins <ccollins@apache.org>
Committed: Sat Jul 9 12:33:14 2016 -0700

----------------------------------------------------------------------
 .../ble_hs/ble_gatts/definitions/ble_gatts_defs.md   | 15 +++++++++++++++
 1 file changed, 15 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/b1efe048/docs/network/ble/ble_hs/ble_gatts/definitions/ble_gatts_defs.md
----------------------------------------------------------------------
diff --git a/docs/network/ble/ble_hs/ble_gatts/definitions/ble_gatts_defs.md b/docs/network/ble/ble_hs/ble_gatts/definitions/ble_gatts_defs.md
index a87491a..34faff5 100644
--- a/docs/network/ble/ble_hs/ble_gatts/definitions/ble_gatts_defs.md
+++ b/docs/network/ble/ble_hs/ble_gatts/definitions/ble_gatts_defs.md
@@ -77,7 +77,18 @@ struct ble_gatt_svc_def {
 ```
 
 ```c
+/**
+ * Context for an access to a GATT characteristic or descriptor.  When a client
+ * reads or writes a locally registered characteristic or descriptor, an
+ * instance of this struct gets passed to the application callback.
+ */
 struct ble_gatt_access_ctxt {
+    /**
+     * The GATT operation being performed dictates which field in this union is
+     * valid.  If a characteristic is being accessed, the chr field is valid.
+     * Otherwise, a descriptor is being accessed, in which case the dsc field
+     * is valid.
+     */
     union {
         /**
          * The characteristic definition corresponding to the characteristic
@@ -92,6 +103,10 @@ struct ble_gatt_access_ctxt {
         const struct ble_gatt_dsc_def *dsc;
     };
 
+    /**
+     * Context describing the underlying ATT access.  Specifies additional
+     * details about the read or write being performed.
+     */
     struct ble_att_svr_access_ctxt *att;
 };
 ```


Mime
View raw message