From 3bf79c68dcf4d155f821a29bc46b60284aa90f28 Mon Sep 17 00:00:00 2001 From: Hrishikesh Dhayagude Date: Tue, 18 Dec 2018 22:08:02 +0530 Subject: [PATCH] nimble/doc: Fix minor typos --- README.md | 4 ++-- RELEASE_NOTES.md | 2 +- nimble/host/include/host/ble_att.h | 8 ++++---- nimble/host/include/host/ble_gap.h | 4 ++-- nimble/host/include/host/ble_gatt.h | 2 +- nimble/host/include/host/ble_hs_mbuf.h | 2 +- nimble/host/include/host/ble_store.h | 4 ++-- 7 files changed, 13 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 18412df3d..f6a6972eb 100644 --- a/README.md +++ b/README.md @@ -84,7 +84,7 @@ stack. These sample applications are located in the `apps/` directory of Apache Mynewt [repo](https://github.com/apache/mynewt-core). Some examples: * [blecent](https://github.com/apache/mynewt-core/tree/master/apps/blecent): -A basic central device with no user interface. Thisa pplication scans for +A basic central device with no user interface. This application scans for a peripheral that supports the alert notification service (ANS). Upon discovering such a peripheral, blecent connects and performs a characteristic read, characteristic write, and notification subscription. @@ -95,7 +95,7 @@ HCI over UART. * [bleprph](https://github.com/apache/mynewt-core/tree/master/apps/bleprph): An implementation of a minimal BLE peripheral. * [btshell](https://github.com/apache/mynewt-core/tree/master/apps/btshell): A - shell-like application allowing to configure and use most og NimBLE + shell-like application allowing to configure and use most of NimBLE functionality from command line. * [bleuart](https://github.com/apache/mynewt-core/tree/master/apps/bleuart): Implements a simple BLE peripheral that supports the Nordic diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md index 5e677aec0..9645c44f9 100644 --- a/RELEASE_NOTES.md +++ b/RELEASE_NOTES.md @@ -22,6 +22,6 @@ New features in this version of NimBLE include: * Lots of other bugfixes, minor enhancements and optimisations * Mesh improvements -If working on next-generation RTOS and Bluetooth protocotol stack +If working on next-generation RTOS and Bluetooth protocol stack sounds exciting to you, get in touch, by sending a mail to the Apache Mynewt Developer's list, dev@mynewt.apache.org. diff --git a/nimble/host/include/host/ble_att.h b/nimble/host/include/host/ble_att.h index 7e2766865..391a992ae 100644 --- a/nimble/host/include/host/ble_att.h +++ b/nimble/host/include/host/ble_att.h @@ -112,7 +112,7 @@ struct os_mbuf; /** * Reads a locally registered attribute. If the specified attribute handle - * coresponds to a GATT characteristic value or descriptor, the read is + * corresponds to a GATT characteristic value or descriptor, the read is * performed by calling the registered GATT access callback. * * @param attr_handle The 16-bit handle of the attribute to read. @@ -131,7 +131,7 @@ int ble_att_svr_read_local(uint16_t attr_handle, struct os_mbuf **out_om); /** * Writes a locally registered attribute. This function consumes the supplied * mbuf regardless of the outcome. If the specified attribute handle - * coresponds to a GATT characteristic value or descriptor, the write is + * corresponds to a GATT characteristic value or descriptor, the write is * performed by calling the registered GATT access callback. * * @param attr_handle The 16-bit handle of the attribute to write. @@ -167,7 +167,7 @@ uint16_t ble_att_preferred_mtu(void); /** * Sets the preferred ATT MTU; the device will indicate this value in all - * subseqeunt ATT MTU exchanges. The ATT MTU of a connection is equal to the + * subsequent ATT MTU exchanges. The ATT MTU of a connection is equal to the * lower of the two peers' preferred MTU values. The ATT MTU is what dictates * the maximum size of any message sent during a GATT procedure. * @@ -178,7 +178,7 @@ uint16_t ble_att_preferred_mtu(void); * @param mtu The preferred ATT MTU. * * @return 0 on success; - * BLE_HS_EINVAL if the specifeid value is not + * BLE_HS_EINVAL if the specified value is not * within the allowed range. */ int ble_att_set_preferred_mtu(uint16_t mtu); diff --git a/nimble/host/include/host/ble_gap.h b/nimble/host/include/host/ble_gap.h index f21169d3a..99e64270b 100644 --- a/nimble/host/include/host/ble_gap.h +++ b/nimble/host/include/host/ble_gap.h @@ -594,7 +594,7 @@ struct ble_gap_event { /** The handle of the relevant connection. */ uint16_t conn_handle; - /** The handle of the relevant characterstic value. */ + /** The handle of the relevant characteristic value. */ uint16_t attr_handle; /** @@ -778,7 +778,7 @@ int ble_gap_set_event_cb(uint16_t conn_handle, * - BLE_OWN_ADDR_RANDOM * - BLE_OWN_ADDR_RPA_PUBLIC_DEFAULT * - BLE_OWN_ADDR_RPA_RANDOM_DEFAULT - * @param direct_addr The peer's address for directed advertising. his + * @param direct_addr The peer's address for directed advertising. This * parameter shall be non-NULL if directed advertising is * being used. * @param duration_ms The duration of the advertisement procedure. On diff --git a/nimble/host/include/host/ble_gatt.h b/nimble/host/include/host/ble_gatt.h index c4d87da66..c3725bce8 100644 --- a/nimble/host/include/host/ble_gatt.h +++ b/nimble/host/include/host/ble_gatt.h @@ -835,7 +835,7 @@ int ble_gatts_find_chr(const ble_uuid_t *svc_uuid, const ble_uuid_t *chr_uuid, * @param chr_uuid The UUID of the parent characteristic. * @param dsc_uuid The UUID of the descriptor ro look up. * @param out_handle On success, populated with the handle - * of the descripytor attribute. Pass null if + * of the descriptor attribute. Pass null if * you don't need this value. * * @return 0 on success; diff --git a/nimble/host/include/host/ble_hs_mbuf.h b/nimble/host/include/host/ble_hs_mbuf.h index fb7b12e60..a3c2c0296 100644 --- a/nimble/host/include/host/ble_hs_mbuf.h +++ b/nimble/host/include/host/ble_hs_mbuf.h @@ -41,7 +41,7 @@ struct os_mbuf; * - L2CAP B-frame header * - Largest ATT command base (prepare write request / response). * - * @return An empty mbuf on success, NULLl on error. + * @return An empty mbuf on success, NULL on error. */ struct os_mbuf *ble_hs_mbuf_att_pkt(void); diff --git a/nimble/host/include/host/ble_store.h b/nimble/host/include/host/ble_store.h index 6871a6164..30a5666cf 100644 --- a/nimble/host/include/host/ble_store.h +++ b/nimble/host/include/host/ble_store.h @@ -164,7 +164,7 @@ struct ble_store_status_event { } overflow; /** - * Represents the possiblity that a scheduled write will fail due to + * Represents the possibility that a scheduled write will fail due to * storage exhaustion. Valid for the following event types: * o BLE_STORE_EVENT_FULL */ @@ -222,7 +222,7 @@ typedef int ble_store_write_fn(int obj_type, const union ble_store_value *val); * @param key Specifies properties of the object to search * for. An object is deleted if it matches * these criteria. - * @return 0 if an object was successfully retreived; + * @return 0 if an object was successfully retrieved; * BLE_HS_ENOENT if no matching object was found; * Other nonzero on error. */