Upgrade doxygen configuration files to the latest version.

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

diff --git a/Demos/Device/ClassDriver/RNDISEthernet/RNDISEthernet.txt b/Demos/Device/ClassDriver/RNDISEthernet/RNDISEthernet.txt
index 3099ac0..c926dda 100644 (file)
--- a/Demos/Device/ClassDriver/RNDISEthernet/RNDISEthernet.txt
+++ b/Demos/Device/ClassDriver/RNDISEthernet/RNDISEthernet.txt
@@ -4,14 +4,17 @@
  *  documentation pages. It is not a project source file.
  */
 
-/** \mainpage RNDIS Class Ethernet Demo (with Webserver/Telnet)
+/** \mainpage RNDIS Class Ethernet Demo
  *
  *  \section Sec_Compat Demo Compatibility:
  *
  *  The following list indicates what microcontrollers are compatible with this demo.
  *
- *  - Series 7 USB AVRs (AT90USBxxx7)
- *  - Series 6 USB AVRs (AT90USBxxx6)
+ *  \li Series 7 USB AVRs (AT90USBxxx7)
+ *  \li Series 6 USB AVRs (AT90USBxxx6)
+ *  \li Series AU XMEGA AVRs (ATXMEGAxxxAxU)
+ *  \li Series B XMEGA AVRs (ATXMEGAxxxBx)
+ *  \li Series C XMEGA AVRs (ATXMEGAxxxCx)
  *
  *  \section Sec_Info USB Information:
  *
@@ -35,7 +38,7 @@
  *    <td>Microsoft RNDIS Specification</td>
  *   </tr>
  *   <tr>
- *    <td><b>Usable Speeds:</b></td>
+ *    <td><b>Supported USB Speeds:</b></td>
  *    <td>Full Speed Mode</td>
  *   </tr>
  *  </table>
@@ -46,9 +49,8 @@
  *  This gives a simple reference application for implementing
  *  a CDC RNDIS device acting as a simple network interface for
  *  ethernet packet exchange. RNDIS is a proprietary Microsoft
- *  standard; this demo will only work on Windows 2000 (manually
- *  patched with the Microsoft RNDIS hotfix) and above (with no
- *  manual patches), or on the latest Linux kernels.
+ *  standard; this demo will only work on Windows XP, or on modern
+ *  Linux kernels.
  *
  *  Before running, you will need to install the INF file that
  *  is located in the RNDISEthernet project directory. This will
@@ -61,17 +63,8 @@
  *
  *  When enumerated, this demo will install as a new network
  *  adapter which ethernet packets can be sent to and received
- *  from. Running on top of the adapter is a very simple TCP/IP
- *  stack with a HTTP webserver and TELNET host which can be
- *  accessed through a web browser at IP address 10.0.0.2:80 or
- *  through a TELNET client at 10.0.0.2:25. This device also supports
- *  ping echos via the ICMP protocol.
- *
- *  \note The TCP/IP stack in this demo has a number of limitations
- *  and should serve as an example only - it is not fully featured nor
- *  compliant to the TCP/IP specification. For complete projects, it is
- *  recommended that it be replaced with an external open source TCP/IP
- *  stack that is feature complete, such as the uIP stack.
+ *  from. When packets are received from the host, the on-board LEDs should
+ *  flash.
  *
  *  \section Sec_Options Project Options
  *
@@ -79,44 +72,14 @@
  *
  *  <table>
  *   <tr>
- *    <td><b>Define Name:</b></td>
- *    <td><b>Location:</b></td>
- *    <td><b>Description:</b></td>
- *   </tr>
- *   <tr>
- *    <td>NO_DECODE_ETHERNET</td>
- *    <td>Makefile LUFA_OPTS</td>
- *    <td>When defined, received Ethernet headers will not be decoded and printed to the device serial port.</td>
- *   </tr>
- *   <tr>
- *    <td>NO_DECODE_ARP</td>
- *    <td>Makefile LUFA_OPTS</td>
- *    <td>When defined, received ARP headers will not be decoded and printed to the device serial port.</td>
- *   </tr>
- *   <tr>
- *    <td>NO_DECODE_IP</td>
- *    <td>Makefile LUFA_OPTS</td>
- *    <td>When defined, received IP headers will not be decoded and printed to the device serial port.</td>
- *   </tr>
- *   <tr>
- *    <td>NO_DECODE_ICMP</td>
- *    <td>Makefile LUFA_OPTS</td>
- *    <td>When defined, received ICMP headers will not be decoded and printed to the device serial port.</td>
- *   </tr>
- *   <tr>
- *    <td>NO_DECODE_TCP</td>
- *    <td>Makefile LUFA_OPTS</td>
- *    <td>When defined, received TCP headers will not be decoded and printed to the device serial port.</td>
- *   </tr>
- *   <tr>
- *    <td>NO_DECODE_UDP</td>
- *    <td>Makefile LUFA_OPTS</td>
- *    <td>When defined, received UDP headers will not be decoded and printed to the device serial port.</td>
+ *    <th><b>Define Name:</b></th>
+ *    <th><b>Location:</b></th>
+ *    <th><b>Description:</b></th>
  *   </tr>
  *   <tr>
- *    <td>NO_DECODE_DHCP</td>
- *    <td>Makefile LUFA_OPTS</td>
- *    <td>When defined, received DHCP headers will not be decoded and printed to the device serial port.</td>
+ *    <td>ADAPTER_MAC_ADDRESS</td>
+ *    <td>AppConfig.h</td>
+ *    <td>Configures the MAC address of the RNDIS adapter on the host (PC) side.</td>
  *   </tr>
  *  </table>
  */