Diff: drv/zg2100/zg_if.h

Revision:

1:3a7c15057192

Parent:

0:b802fc31f1db

Child:

2:ac860ad9e490

--- a/drv/zg2100/zg_if.h	Fri Jul 09 15:37:23 2010 +0000
+++ b/drv/zg2100/zg_if.h	Fri Aug 06 10:23:41 2010 +0000
@@ -21,7 +21,7 @@
 THE SOFTWARE.
 */
 
-//ZG2100 NetServices high-level interface : configuration & setup
+/// \file ZG2100 NetServices high-level interface : configuration & setup
 //Donatien Garnier 2010
 
 #ifndef ZG_IF_H
@@ -29,26 +29,37 @@
 
 #include "zg_defs.h"
 
+///Scans for available networks on given \a channel.
 void zg_scan(byte channel);
 
+///Will be called on scan completion, for now it is just a debug dump.
 void zg_on_scan_results(byte* buf, int len);
 
+///Sets the SSID of the network to be joined.
 void zg_set_ssid(const char* ssid);
 
+///Sets WEP key.
 void zg_set_wep_key(const byte* key, int len);
 
+///Sets WPA passphrase (will compute PSK key and set it).
 void zg_set_wpa_pass(const char* pass);
 
+///On completion of the passphrase computation.
 void zg_on_psk_key(byte* buf, int len);
 
+///Sets PSK key (preferred to be called directly than recomputing it every time using \a zg_set_wpa_pass).
 void zg_set_psk_key(const byte* key, int len);
 
+///Connects to network.
 void zg_connect(ZG_BSS_TYPE type, ZG_SECURITY security);
 
+///On connection result.
 void zg_on_connect(zg_err result);
 
+///Gets connection result.
 zg_err zg_get_connection_result();
 
+///Disconnects from network.
 void zg_disconnect();
 
 void hexdump(byte* buffer, int size);