Combined Mouse, MouseViaInt and MouseFullInt demos into a single unified demo.

[pub/lufa.git] / Demos / RNDISEthernet / RNDISEthernet.txt

diff --git a/Demos/RNDISEthernet/RNDISEthernet.txt b/Demos/RNDISEthernet/RNDISEthernet.txt
index bd4ff69..306cf85 100644 (file)
--- a/Demos/RNDISEthernet/RNDISEthernet.txt
+++ b/Demos/RNDISEthernet/RNDISEthernet.txt
@@ -5,7 +5,11 @@
  */\r
  \r
 /** \mainpage RNDIS Class Ethernet Demo (with Webserver/Telnet)\r
- *  \r
+ *\r
+ *  \section SSec_Info USB Information:\r
+ *\r
+ *  The following table gives a rundown of the USB utilization of this demo.\r
+ *\r
  *  Remote Network Driver Interface demonstration application.\r
  *  This gives a simple reference application for implementing\r
  *  a CDC RNDIS device acting as a simple network interface for\r
@@ -37,6 +41,8 @@
  *  recommended that it be replaced with an external open source TCP/IP\r
  *  stack that is feature complete, such as the uIP stack.\r
  *\r
+ *  \section SSec_Description Project Description: \r
+ *\r
  *  <table>\r
  *   <tr>\r
  *    <td><b>USB Mode:</b></td>\r
@@ -59,4 +65,51 @@
  *    <td>Full Speed Mode</td>\r
  *   </tr>\r
  *  </table>\r
+ *\r
+ *  \section SSec_Options Project Options\r
+ *\r
+ *  The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value.\r
+ *\r
+ *  <table>\r
+ *   <tr>\r
+ *    <td><b>Define Name:</b></td>\r
+ *    <td><b>Location:</b></td>\r
+ *    <td><b>Description:</b></td>\r
+ *   </tr>\r
+ *   <tr>\r
+ *    <td>NO_DECODE_ETHERNET</td>\r
+ *    <td>Makefile CDEFS</td>\r
+ *    <td>When defined, received Ethernet headers will not be decoded and printed to the device serial port.</td>\r
+ *   </tr>\r
+ *   <tr>\r
+ *    <td>NO_DECODE_ARP</td>\r
+ *    <td>Makefile CDEFS</td>\r
+ *    <td>When defined, received ARP headers will not be decoded and printed to the device serial port.</td>\r
+ *   </tr>\r
+ *   <tr>\r
+ *    <td>NO_DECODE_IP</td>\r
+ *    <td>Makefile CDEFS</td>\r
+ *    <td>When defined, received IP headers will not be decoded and printed to the device serial port.</td>\r
+ *   </tr>\r
+ *   <tr>\r
+ *    <td>NO_DECODE_ICMP</td>\r
+ *    <td>Makefile CDEFS</td>\r
+ *    <td>When defined, received ICMP headers will not be decoded and printed to the device serial port.</td>\r
+ *   </tr>\r
+ *   <tr>\r
+ *    <td>NO_DECODE_TCP</td>\r
+ *    <td>Makefile CDEFS</td>\r
+ *    <td>When defined, received TCP headers will not be decoded and printed to the device serial port.</td>\r
+ *   </tr>\r
+ *   <tr>\r
+ *    <td>NO_DECODE_UDP</td>\r
+ *    <td>Makefile CDEFS</td>\r
+ *    <td>When defined, received UDP headers will not be decoded and printed to the device serial port.</td>\r
+ *   </tr>\r
+ *   <tr>\r
+ *    <td>NO_DECODE_DHCP</td>\r
+ *    <td>Makefile CDEFS</td>\r
+ *    <td>When defined, received DHCP headers will not be decoded and printed to the device serial port.</td>\r
+ *   </tr>\r
+ *  </table>\r
  */
\ No newline at end of file