Daniel Peter / NetServices

Files at this revision

API Documentation at this revision

Revision 3:0c324737064d, committed 2010-11-09

Comitter:
mbed714
Date:
Tue Nov 09 19:32:44 2010 +0000
Parent:
2:ed3cf96c4b63
Commit message:

Changed in this revision

if/eth/EthernetNetIf.h Show annotated file Show diff for this revision Revisions of this file 
--- a/if/eth/EthernetNetIf.h	Tue Nov 09 19:24:39 2010 +0000
+++ b/if/eth/EthernetNetIf.h	Tue Nov 09 19:32:44 2010 +0000
@@ -50,6 +50,17 @@
 {
 public:
   ///Instantiates the Interface and register it against the stack, DHCP will be used
+  /**
+  * An optional hostname can be specified which will be passed to the DHCP server.
+  * Examples without and with hostname specified:
+  *
+  * @code
+  * EthernetNetIf eth();
+  * @endcode
+  * @code
+  * EthernetNetIf eth("mbedSE");
+  * @endcode
+  */
   EthernetNetIf(const char* hostname = NULL); //W/ DHCP
 
   ///Instantiates the Interface and register it against the stack, DHCP will not be used