examples prepared for release

Author: davetcc

src/SCCircularBuffer.h

@@ -10,6 +10,11 @@
 #include <inttypes.h>
 #include <SCThreadingSupport.h>
 
+/**
+ * @file SCCircularBuffer.h
+ * @brief a circular buffer implementation that is thread safe and works on all supported boards
+ */
+
 namespace tccollection {
 
 /**

src/SCThreadingSupport.h

@@ -6,6 +6,11 @@
 #ifndef SIMPLECOLLECTIONS_SCTHREADINGSUPPORT_H
 #define SIMPLECOLLECTIONS_SCTHREADINGSUPPORT_H
 
+/**
+ * @file SCThreadingSupport.h
+ * @brief provides the thread safety implementation for circular buffers
+ */
+
 // when not on mbed, we need to load Arduino.h to get the right defines for some boards.
 #ifndef __MBED__
 #include <Arduino.h>

src/SimpleCollections.h

@@ -4,7 +4,8 @@
  */
 
 /**
- * @file SimpleCollections.h memory efficient collections for use on all embedded devices.
+ * @file SimpleCollections.h
+ * @brief memory efficient collections for use on all embedded devices.
  */
 
 #ifndef SIMPLE_COLLECTIONS_H