mynewt-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ccoll...@apache.org
Subject [6/8] incubator-mynewt-core git commit: added doxygen style comments
Date Mon, 01 Aug 2016 20:59:43 GMT
added doxygen style comments


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

Branch: refs/heads/develop
Commit: 4f13d6804c44c4f39a75ee1049ea3977e57063d3
Parents: 5d4620e
Author: Brian Giori <briangiori@gmail.com>
Authored: Thu Jul 28 14:26:47 2016 -0700
Committer: Brian Giori <briangiori@gmail.com>
Committed: Thu Jul 28 14:26:47 2016 -0700

----------------------------------------------------------------------
 net/nimble/host/profiles/lls/src/ble_svc_lls.c | 11 +++++++++--
 1 file changed, 9 insertions(+), 2 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-mynewt-core/blob/4f13d680/net/nimble/host/profiles/lls/src/ble_svc_lls.c
----------------------------------------------------------------------
diff --git a/net/nimble/host/profiles/lls/src/ble_svc_lls.c b/net/nimble/host/profiles/lls/src/ble_svc_lls.c
index fca59fa..9a8e9db 100644
--- a/net/nimble/host/profiles/lls/src/ble_svc_lls.c
+++ b/net/nimble/host/profiles/lls/src/ble_svc_lls.c
@@ -58,6 +58,10 @@ static const struct ble_gatt_svc_def ble_svc_lls_defs[] = {
     },
 };
 
+/**
+ * Writes the received value from a characteristic write to 
+ * the given destination.
+ */
 static int
 ble_svc_lls_chr_write(struct os_mbuf *om, uint16_t min_len, 
                       uint16_t max_len, void *dst, 
@@ -134,6 +138,8 @@ ble_svc_lls_on_gap_event(int reason)
 
 /**
  * Gets the current alert level.
+ *
+ * @return The current alert level
  */
 uint8_t
 ble_svc_lls_alert_level_get(void)
@@ -142,8 +148,9 @@ ble_svc_lls_alert_level_get(void)
 }
 
 /**
- * Sets the current alert level. Returns 0 on success and
- * BLE_HS_EINVAL if the given alert level is not valid.
+ * Sets the current alert level. 
+ *
+ * @return 0 on success, BLE_HS_EINVAL if the given alert level is not valid.
  */
 int
 ble_svc_lls_alert_level_set(uint8_t alert_level)


Mime
View raw message