Minor documentation fixes.

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

diff --git a/Demos/Device/LowLevel/RNDISEthernet/RNDISEthernet.txt b/Demos/Device/LowLevel/RNDISEthernet/RNDISEthernet.txt
index 2175ecb..3099ac0 100644 (file)
--- a/Demos/Device/LowLevel/RNDISEthernet/RNDISEthernet.txt
+++ b/Demos/Device/LowLevel/RNDISEthernet/RNDISEthernet.txt
@@ -3,17 +3,17 @@
  *  This file contains special DoxyGen information for the generation of the main page and other special
  *  documentation pages. It is not a project source file.
  */
  *  This file contains special DoxyGen information for the generation of the main page and other special
  *  documentation pages. It is not a project source file.
  */

- 
+

 /** \mainpage RNDIS Class Ethernet Demo (with Webserver/Telnet)
  *
 /** \mainpage RNDIS Class Ethernet Demo (with Webserver/Telnet)
  *

- *  \section SSec_Compat Demo Compatibility:
+ *  \section Sec_Compat Demo Compatibility:

  *
  *  The following list indicates what microcontrollers are compatible with this demo.
  *
  *
  *  The following list indicates what microcontrollers are compatible with this demo.
  *

- *  - Series 7 USB AVRs
- *  - Series 6 USB AVRs
+ *  - Series 7 USB AVRs (AT90USBxxx7)
+ *  - Series 6 USB AVRs (AT90USBxxx6)

  *
  *

- *  \section SSec_Info USB Information:
+ *  \section Sec_Info USB Information:

  *
  *  The following table gives a rundown of the USB utilization of this demo.
  *
  *
  *  The following table gives a rundown of the USB utilization of this demo.
  *


@@ -26,7 +26,7 @@
  *    <td><b>USB Class:</b></td>
  *    <td>Communications Device Class (CDC)</td>
  *   </tr>
  *    <td><b>USB Class:</b></td>
  *    <td>Communications Device Class (CDC)</td>
  *   </tr>

- *   <tr> 
+ *   <tr>

  *    <td><b>USB Subclass:</b></td>
  *    <td>Remote NDIS (Microsoft Proprietary CDC Class Networking Standard)</td>
  *   </tr>
  *    <td><b>USB Subclass:</b></td>
  *    <td>Remote NDIS (Microsoft Proprietary CDC Class Networking Standard)</td>
  *   </tr>


@@ -40,7 +40,7 @@
  *   </tr>
  *  </table>
  *
  *   </tr>
  *  </table>
  *

- *  \section SSec_Description Project Description: 
+ *  \section Sec_Description Project Description:

  *
  *  Remote Network Driver Interface demonstration application.
  *  This gives a simple reference application for implementing
  *
  *  Remote Network Driver Interface demonstration application.
  *  This gives a simple reference application for implementing


@@ -49,7 +49,7 @@
  *  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 2000 (manually
  *  patched with the Microsoft RNDIS hotfix) and above (with no
  *  manual patches), or on the latest Linux kernels.

- *  
+ *

  *  Before running, you will need to install the INF file that
  *  is located in the RNDISEthernet project directory. This will
  *  enable Windows to use its inbuilt RNDIS drivers, negating the
  *  Before running, you will need to install the INF file that
  *  is located in the RNDISEthernet project directory. This will
  *  enable Windows to use its inbuilt RNDIS drivers, negating the


@@ -58,7 +58,7 @@
  *  Windows 2000 is used, the Microsoft INF file in the hotfix
  *  will need to be altered to use the VID/PID of the demo and
  *  then chosen instead of the LUFA RNDIS INF file when prompted.
  *  Windows 2000 is used, the Microsoft INF file in the hotfix
  *  will need to be altered to use the VID/PID of the demo and
  *  then chosen instead of the LUFA RNDIS INF file when prompted.

- *  
+ *

  *  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
  *  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


@@ -66,14 +66,14 @@
  *  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.
  *  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
  *  \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 
+ *  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.
  *
  *  recommended that it be replaced with an external open source TCP/IP
  *  stack that is feature complete, such as the uIP stack.
  *

- *  \section SSec_Options Project Options
+ *  \section Sec_Options Project Options

  *
  *  The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value.
  *
  *
  *  The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value.
  *


@@ -85,38 +85,39 @@
  *   </tr>
  *   <tr>
  *    <td>NO_DECODE_ETHERNET</td>
  *   </tr>
  *   <tr>
  *    <td>NO_DECODE_ETHERNET</td>

- *    <td>Makefile CDEFS</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>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 CDEFS</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>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 CDEFS</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>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 CDEFS</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>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 CDEFS</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>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 CDEFS</td>
+ *    <td>Makefile LUFA_OPTS</td>

  *    <td>When defined, received UDP headers will not be decoded and printed to the device serial port.</td>
  *   </tr>
  *   <tr>
  *    <td>NO_DECODE_DHCP</td>
  *    <td>When defined, received UDP headers will not be decoded and printed to the device serial port.</td>
  *   </tr>
  *   <tr>
  *    <td>NO_DECODE_DHCP</td>

- *    <td>Makefile CDEFS</td>
+ *    <td>Makefile LUFA_OPTS</td>

  *    <td>When defined, received DHCP headers will not be decoded and printed to the device serial port.</td>
  *   </tr>
  *  </table>
  *    <td>When defined, received DHCP headers will not be decoded and printed to the device serial port.</td>
  *   </tr>
  *  </table>

- */
\ No newline at end of file
+ */
+