You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@mynewt.apache.org by an...@apache.org on 2018/11/15 12:45:38 UTC

[mynewt-nimble] 02/02: host/util: move function doc to header file

This is an automated email from the ASF dual-hosted git repository.

andk pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/mynewt-nimble.git

commit 6fb0f8d3ea6f520b970c4cb504172a9e4508383a
Author: Hauke Petersen <ha...@fu-berlin.de>
AuthorDate: Thu Nov 15 10:33:36 2018 +0100

    host/util: move function doc to header file
---
 nimble/host/util/include/host/util/util.h | 13 +++++++++++++
 nimble/host/util/src/addr.c               | 13 -------------
 2 files changed, 13 insertions(+), 13 deletions(-)

diff --git a/nimble/host/util/include/host/util/util.h b/nimble/host/util/include/host/util/util.h
index 7588192..3f07c00 100644
--- a/nimble/host/util/include/host/util/util.h
+++ b/nimble/host/util/include/host/util/util.h
@@ -24,6 +24,19 @@
 extern "C" {
 #endif
 
+/**
+ * Tries to configure the device with at least one Bluetooth address.
+ * Addresses are restored in a hardware-specific fashion.
+ *
+ * @param prefer_random         Whether to attempt to restore a random address
+ *                                  before checking if a public address has
+ *                                  already been configured.
+ *
+ * @return                      0 on success;
+ *                              BLE_HS_ENOADDR if the device does not have any
+ *                                  available addresses.
+ *                              Other BLE host core code on error.
+ */
 int ble_hs_util_ensure_addr(int prefer_random);
 
 #ifdef __cplusplus
diff --git a/nimble/host/util/src/addr.c b/nimble/host/util/src/addr.c
index ba66686..58dcb18 100644
--- a/nimble/host/util/src/addr.c
+++ b/nimble/host/util/src/addr.c
@@ -70,19 +70,6 @@ ble_hs_util_ensure_rand_addr(void)
     return 0;
 }
 
-/**
- * Tries to configure the device with at least one Bluetooth address.
- * Addresses are restored in a hardware-specific fasion.
- *
- * @param prefer_random         Whether to attempt to restore a random address
- *                                  before checking if a public address has
- *                                  already been configured.
- *
- * @return                      0 on success;
- *                              BLE_HS_ENOADDR if the device does not have any
- *                                  available addresses.
- *                              Other BLE host core code on error.
- */
 int
 ble_hs_util_ensure_addr(int prefer_random)
 {