Bill Schilit / BLE_API

Improve readability with getHandle inline

Fork of BLE_API by Bluetooth Low Energy

Files at this revision

API Documentation at this revision

Revision 241:58642869879c, committed 2014-12-08

Comitter:
mbedAustin
Date:
Mon Dec 08 20:43:06 2014 +0000
Parent:
240:905d6fc17fda
Child:
242:20df772f2374
Commit message:
last minute changes to UriBeacon doxygen

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:24:12 2014 +0000
+++ b/services/URIBeaconConfigService.h	Mon Dec 08 20:43:06 2014 +0000
@@ -149,7 +149,10 @@
     }
 
     /**
-     * Update the txPowerLevels table.
+     * @breif Update the txPowerLevels table.
+     * 
+     * @param[in] powerLevelsIn
+     *              Array of power levels
      */
     void setTxPowerLevels(const int8_t powerLevelsIn[NUM_POWER_MODES]) {
         memcpy(powerLevels, powerLevelsIn, sizeof(powerLevels));
@@ -158,7 +161,10 @@
     }
 
     /**
-     * Set the effective power mode from one of the values in the powerLevels tables.
+     * @breif Set the effective power mode from one of the values in the powerLevels tables.
+     *
+     * @param[in] mode
+     *              Set the TX Power Mode.
      */
     void setTxPowerMode(TXPowerModes_t mode) {
         txPowerMode = mode;
@@ -170,6 +176,9 @@
      * The period in milliseconds that a UriBeacon packet is transmitted.
      *
      * @Note: A value of zero disables UriBeacon transmissions.
+     *
+     * @param beaconPeriodIn
+     *              Beacon advertising period in milliseconds
      */
     void setBeaconPeriod(uint16_t beaconPeriodIn) {
         beaconPeriod = beaconPeriodIn;