Diff: api/README.h

Revision:

34:2616445d0823

Parent:

29:b6af04b77a56

--- a/api/README.h	Mon Oct 27 14:16:03 2014 -0700
+++ b/api/README.h	Wed Nov 26 23:46:00 2014 -0800
@@ -4,10 +4,16 @@
  * @section Overview
  * The WiConnect Library runs on a host MCU and controls a
  * WiConnect enabled WiFi module. This library is essentially a
- * programming API for the WiConnect serial command set. More infomation
- * about the serial command set may be found here:
+ * programming API for the WiConnect serial command set.
+ * More infomation about the serial command set may be found here:
  * <a href="http://wiconnect.ack.me" target="_blank">WiConnect Reference Guide</a>
  *
+ * @if mbed_sdk
+ * The library may be downloaded from here: <a href="http://developer.mbed.org/teams/ACKme/code/WiConnect/" target="_blank">WiConnect Repository</a>
+ * @else
+ * The library may be downloaded from here: <a href="https://bitbucket.org/ackme/ackme_wiconnect_library/src" target="_blank">WiConnect Repository</a>
+ * @endif
+ *
  * @section notes Important Notes
  * - This class is implemented as a 'singleton'. This means it only needs to be
  *   instantiated once.
@@ -127,7 +133,9 @@
 /**
  * @defgroup api_core_examples Examples
  * @brief    Core examples
+ * @if mbed_sdk
  * * @ref ota/example.cpp
+ * @endif
  */
 
 // @}
@@ -175,8 +183,15 @@
 /**
  * @defgroup api_network_examples Examples
  * @brief Network examples
+ * @if mbed_sdk
  * * @ref web_setup/example.cpp
  * * @ref join/example.cpp
+ * * @ref tcp_echo_client/main.cpp
+ * * @ref udp_echo_client/main.cpp
+ * @elseif arduino_sdk
+ * * @ref ConnectNoEncryption/ConnectNoEncryption.cpp
+ * * @ref ConnectWithWPA/ConnectWithWPA.cpp
+ * @endif
  */
 
 // @}
@@ -229,8 +244,18 @@
 /**
  * @defgroup api_socket_examples Examples
  * @brief    Socket examples
+ * @if mbed_sdk
  * * @ref http_get/example.cpp
  * * @ref tcp_server/example.cpp
+ * @elseif arduino_sdk
+ * * @ref SimpleWebServerWiFi/SimpleWebServerWiFi.cpp
+ * * @ref WiFiChatServer/WiFiChatServer.cpp
+ * * @ref WiFiUdpNtpClient/WiFiUdpNtpClient.cpp
+ * * @ref WiFiUdpSendReceiveString/WiFiUdpSendReceiveString.cpp
+ * * @ref WiFiWebClient/WiFiWebClient.cpp
+ * * @ref WiFiWebClientRepeating/WiFiWebClientRepeating.cpp
+ * * @ref WiFiWebServer/WiFiWebServer.cpp
+ * @endif
  *
  */
 
@@ -305,6 +330,10 @@
 /**
  * @defgroup api_ghm_examples Examples
  * @brief    goHACK.me examples
+ * @if mbed_sdk
+ * @elseif arduino_sdk
+ * * @ref GhmLedMatrix/GhmLedMatrix.cpp
+ * @endif
  */
 
 // @}