Jack Berkhout / cc3000_hostdriver_mbedsocket

None

Fork of cc3000_hostdriver_mbedsocket by Martin Kojtal

Files at this revision

API Documentation at this revision

Revision 31:7b6e85b68b01, committed 2013-10-06

Comitter:
Kojto
Date:
Sun Oct 06 18:01:19 2013 +0200
Parent:
30:251a0a7d88de
Child:
32:e62d7252401e
Commit message:
Doxygen comments above each class

Changed in this revision

cc3000.h Show annotated file Show diff for this revision Revisions of this file 
--- a/cc3000.h	Sun Oct 06 17:22:49 2013 +0200
+++ b/cc3000.h	Sun Oct 06 18:01:19 2013 +0200
@@ -336,7 +336,7 @@
 class cc3000_spi;
 class cc3000;
 
-/**
+/** Event layer
  */
 class cc3000_event {
 public:
@@ -426,6 +426,8 @@
     cc3000              &_cc3000;
 };
 
+/** Netapp layer
+ */
 class cc3000_netapp {
 public:
     /**
@@ -498,6 +500,8 @@
 };
 
 #ifndef CC3000_UNENCRYPTED_SMART_CONFIG
+/** Security class used only if encrypted smart config is set
+ */
 class cc3000_security {
 public:
     /**
@@ -553,6 +557,8 @@
 };
 #endif
 
+/** Socket layer
+ */
 class cc3000_socket {
 public:
     /**
@@ -678,7 +684,7 @@
     cc3000_event        &_event;
 };
 
-/** SPI communication class
+/** SPI communication layer
  */
 class cc3000_spi {
 public:
@@ -776,6 +782,8 @@
     cc3000_simple_link  &_simple_link;
 };
 
+/** HCI layer
+ */
 class cc3000_hci {
 public:
     /**
@@ -833,6 +841,8 @@
     cc3000_spi &_spi;
 };
 
+/** NVMEM layer
+ */
 class cc3000_nvmem {
 public:
     /**
@@ -919,6 +929,8 @@
     cc3000_simple_link  &_simple_link;
 };
 
+/** WLAN layer
+ */
 class cc3000_wlan {
 public:
     /**
@@ -1123,7 +1135,7 @@
     cc3000_hci          &_hci;
 };
 
-/** The main class of entire cc3000 implementation
+/** The main object of cc3000 implementation
  */
 class cc3000 {
 public: