Austin Blackstone / BLE_API

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Fork of BLE_API by Bluetooth Low Energy

Files at this revision

API Documentation at this revision

Revision 240:20df772f2374, committed 2014-12-08

Comitter:
mbedAustin
Date:
Mon Dec 08 20:51:17 2014 +0000
Parent:
239:58642869879c
Commit message:
updated documenatation to UriBeacon;

Changed in this revision

services/URIBeaconConfigService.h Show annotated file Show diff for this revision Revisions of this file 
--- a/services/URIBeaconConfigService.h	Mon Dec 08 20:43:06 2014 +0000
+++ b/services/URIBeaconConfigService.h	Mon Dec 08 20:51:17 2014 +0000
@@ -130,13 +130,13 @@
      * Update flags of the URIBeacon dynamically.
      *
      * @param[in] flagsIn
-     *
+     * @verbatim
      *     ### UriBeacon Flags
      *     Bit   | Description
      *     :---- | :----------
      *     0     | Invisible Hint
      *     1..7  | Reserved for future use. Must be zero.
-     *
+     * @endverbatim
      *     The `Invisible Hint` flag is a command for the user-agent that tells
      *     it not to access or display the UriBeacon. This is a guideline only,
      *     and is not a blocking method. User agents may, with user approval,
@@ -175,12 +175,12 @@
     /**
      * The period in milliseconds that a UriBeacon packet is transmitted.
      *
-     * @Note: A value of zero disables UriBeacon transmissions.
+     * @note A value of zero disables UriBeacon transmissions.
      *
      * @param beaconPeriodIn
      *              Beacon advertising period in milliseconds
      */
-    void setBeaconPeriod(uint16_t beaconPeriodIn) {
+    void setBeaconPeriod(uint16_t beaconPeriodIn) { 
         beaconPeriod = beaconPeriodIn;
         configureGAP();
         updateBeaconPeriodCharacteristic();