Aleksander Vognild Burkow / Puck

A library for easier setup and prototyping of new pucks, by collecting everything that is common for all pucks in one place.

Dependencies:   BLE_API nRF51822

Fork of Puck by Nordic Pucks

Files at this revision

API Documentation at this revision

Revision 13:23a05bd2fe2b, committed 2014-08-01

Comitter:
aleksanb
Date:
Fri Aug 01 14:15:25 2014 +0000
Parent:
12:fb8678ee25b0
Commit message:
More documentation.

Changed in this revision

Puck.h Show annotated file Show diff for this revision Revisions of this file 
diff -r fb8678ee25b0 -r 23a05bd2fe2b Puck.h
--- a/Puck.h	Fri Aug 01 13:31:46 2014 +0000
+++ b/Puck.h	Fri Aug 01 14:15:25 2014 +0000
@@ -21,7 +21,8 @@
      std::vector<CharacteristicWriteCallback>* callbacks;
 } CharacteristicWriteCallbacks;
   
-/** Puck class. Abstracts away much 
+/**
+ *  @brief A library for easier setup and prototyping of IoT devices (pucks), by collecting everything that is common for all pucks in one place.
  *
  */ 
 class Puck {
@@ -330,7 +331,7 @@
  *
  *  Example:
  *  @code
- *  while (puck->drive) {
+ *  while (puck->drive()) {
  *      // Do stuff
  *  }
  *  @endcode