Diff: README.h

Revision:

13:2b51f5267c92

Parent:

11:ea484e1b7fc4

Child:

21:17bb3eddcbae

--- a/README.h	Tue Aug 12 02:44:34 2014 -0700
+++ b/README.h	Wed Aug 13 03:14:30 2014 -0700
@@ -1,5 +1,5 @@
 /**
- * @mainpage WiConnect Library Overview
+ * @mainpage Library Overview
  *
  * @section Overview
  * The WiConnect Library runs on a host MCU and controls a
@@ -36,11 +36,11 @@
  *
  * @subsubsection setting_blocking_mode Blocking Mode
  * In blocking mode, an API function will block until it completes.
- * TODO: more details here
+ * More details to come...
  *
  * @subsubsection setting_nonblocking_mode Non-Blocking Mode
  * In non-blocking mode, an API function returns immediately.
- * TODO: more details here
+ * More details to come...
  *
  *
  *
@@ -84,7 +84,7 @@
  *
  *
  * @section send_command_desc Sending Commands To WiFi Module
- * TODO: add detailed description here
+ * More details to come...
  *
  *
  */
@@ -92,30 +92,41 @@
 // ----------------------------------------------------------------------------
 
 /**
- * @defgroup api_core Core API
- * @brief   This contains all core API Library methods
+ * @defgroup api_core Core
+ * @brief   This contains all core methods
  *
  * @{
  */
 
 /**
- * @defgroup api_core_settings Settings
+ * @defgroup api_core_settings Settings Methods
  * @brief    API getters/setters for core library settings
  */
 
 /**
- * @defgroup api_core_send_command Send Command
+ * @defgroup api_core_send_command Send Command Methods
  * @brief    API methods for sending commands to WiConnect WiFi module
  */
 
 /**
- * @defgroup api_core_misc Miscellaneous
- * @brief    Other core API methods
+ * @defgroup api_core_misc Miscellaneous Methods
+ * @brief    Other core methods
  */
 
 /**
+ * @defgroup api_core_types Types
+ * @brief    Core Types
+ */
+
+
+/**
  * @defgroup api_core_macro Macros
- * @brief    API specific macros
+ * @brief    Core macros
+ */
+
+/**
+ * @defgroup api_core_examples Examples
+ * @brief    Core examples
  */
 
 // @}
@@ -124,78 +135,47 @@
 // ----------------------------------------------------------------------------
 
 /**
- * @defgroup api_network Network API
- * @brief   This contains all network API Library methods
+ * @defgroup api_network Network
+ * @brief   This contains all network methods
  *
  * @{
  */
 
 /**
- * @defgroup api_network_settings Settings
+ * @defgroup api_network_settings Settings Methods
  * @brief    API getters/setters for module network settings
  */
 
 /**
- * @defgroup api_network_wlan WLAN
- * @brief    API methods for joining/leaving a WLAN
+ * @defgroup api_network_wlan WLAN Methods
+ * @brief    Methods for joining/leaving a WLAN
  */
 
 /**
- * @defgroup api_network_setup Web Setup
- * @brief    API methods for enabled/disabling module web setup
+ * @defgroup api_network_setup Web Setup Methods
+ * @brief    Methods for enabled/disabling module web setup
  */
 
 /**
- * @defgroup api_network_util Utilities
- * @brief    Network utility API methods
+ * @defgroup api_network_util Utility Methods
+ * @brief    Network utility methods
+ */
+
+/**
+ * @defgroup api_network_types Types
+ * @brief    Network Types
  */
 
 /**
  * @defgroup api_network_macros Macros
- * @brief    API specific macros
- */
-
-
-// @}
-
-
-// ----------------------------------------------------------------------------
-
-/**
- * @defgroup api_socket Socket API
- * @brief   This contains all socket API Library methods
- *
- * @{
- */
-
-/**
- * @defgroup api_socket_tcp TCP
- * @brief    TCP API methods
+ * @brief    Network specific macros
  */
 
 /**
- * @defgroup api_socket_udp UDP
- * @brief    UDP API methods
- */
-
-/**
- * @defgroup api_socket_tls TLS
- * @brief    TLS API methods
- */
-
-/**
- * @defgroup api_socket_http HTTP
- * @brief    HTTP API methods
- */
-
-/**
- * @defgroup api_socket_misc Miscellaneous
- * @brief    Miscellaneous socket API methods
- */
-
-/**
- * @defgroup api_socket_macro Macros
- * @brief    API specific macros
+ * @defgroup api_network_examples Examples
+ * @brief Network examples
+ * * @ref web_setup/example.cpp
+ * * @ref join/example.cpp
  */
 
 // @}
@@ -204,50 +184,90 @@
 // ----------------------------------------------------------------------------
 
 /**
- * @defgroup api_file File API
- * @brief   This contains all file API Library methods
+ * @defgroup api_socket Socket
+ * @brief   This contains all socket methods
  *
  * @{
  */
 
 /**
+ * @defgroup api_socket_tcp TCP Methods
+ * @brief    TCP methods
+ */
+
+/**
+ * @defgroup api_socket_udp UDP Methods
+ * @brief    UDP methods
+ */
+
+/**
+ * @defgroup api_socket_tls TLS Methods
+ * @brief    TLS methods
+ */
+
+/**
+ * @defgroup api_socket_http HTTP Methods
+ * @brief    HTTP methods
+ */
+
+/**
+ * @defgroup api_socket_misc Miscellaneous Methods
+ * @brief    Miscellaneous socket methods
+ */
+
+/**
+ * @defgroup api_socket_types Types
+ * @brief    Socket Types
+ */
+
+/**
+ * @defgroup api_socket_macro Macros
+ * @brief    Socket specific macros
+ */
+
+/**
+ * @defgroup api_socket_examples Examples
+ * @brief    Socket examples
+ * * @ref http_get/example.cpp
+ *
+ *
+ */
+
+// @}
+
+
+// ----------------------------------------------------------------------------
+
+/**
+ * @defgroup api_file File
+ * @brief   This contains all file methods
+ *
+ * @{
+ */
+
+/**
+ * @defgroup api_file_methods Methods
+ * @brief    File Types
+ */
+
+/**
+ * @defgroup api_file_types Types
+ * @brief    File Types
+ */
+
+/**
  * @defgroup api_file_macro Macros
  * @brief    API specific macros
  */
 
-// @}
-
-// ----------------------------------------------------------------------------
-
 /**
- * @defgroup types Types
- * @brief   This contains all the Library typedefs and classes (including constructors)
- *
- * @{
- */
-
-/**
- * @defgroup types_core Core API
- * @brief    Core API Types
- */
-
-/**
- * @defgroup types_network Network API
- * @brief    Network API Types
- */
-
-/**
- * @defgroup types_socket Socket API
- * @brief    Socket API Types
- */
-
-/**
- * @defgroup types_file File API
- * @brief    File API Types
+ * @defgroup api_file_examples Examples
+ * @brief    File examples
  */
 
 // @}
 
+
 // ----------------------------------------------------------------------------
 
 /**