Upgrade doxygen configuration files to the latest version.

[pub/lufa.git] / Projects / Webserver / Webserver.txt

diff --git a/Projects/Webserver/Webserver.txt b/Projects/Webserver/Webserver.txt
index ddb0659..10aa716 100644 (file)
--- a/Projects/Webserver/Webserver.txt
+++ b/Projects/Webserver/Webserver.txt
@@ -10,7 +10,7 @@
  *
  *  The following list indicates what microcontrollers are compatible with this project.
  *
- *  - Series 7 USB AVRs (AT90USBxxx7)
+ *  \li Series 7 USB AVRs (AT90USBxxx7)
  *
  *  \section Sec_Info USB Information:
  *
@@ -40,7 +40,7 @@
  *        SCSI Block Commands Specification</td>
  *   </tr>
  *   <tr>
- *    <td><b>Usable Speeds:</b></td>
+ *    <td><b>Supported USB Speeds:</b></td>
  *    <td>Full Speed Mode</td>
  *   </tr>
  *  </table>
@@ -52,10 +52,12 @@
  *  demonstrates how the libraries can be combined into a robust network enabled application, with the addition of a RNDIS
  *  network device.
  *
- *  To use this project, plug the USB AVR into a computer, so that it enumerates as a standard Mass Storage device. Load
- *  HTML files onto the disk, so that they can be served out to clients -- the default file to serve should be called
+ *  To use this project, plug the USB AVR into a computer, so that it enumerates as a standard Mass Storage and RNDIS composite
+ *  device. Load HTML files onto the disk, so that they can be served out to clients -- the default file to serve should be called
  *  <i>index.htm</i>. Filenames must be in 8.3 format for them to be retrieved correctly by the webserver, and the total
- *  requested file path must be equal to or less than the maximum URI length (\see \ref Sec_Options).
+ *  requested file path must be equal to or less than the maximum URI length (\see \ref Sec_Options). Supply the included INF
+ *  file when requested on Windows machines to enable the RNDIS interface, and allow the files to be viewed on a standard web-browser
+ *  using the IP address 10.0.0.2.
  *
  *  When attached to a RNDIS class device, such as a USB (desktop) modem, the system will enumerate the device, set the
  *  appropriate parameters needed for connectivity and begin listening for new HTTP connections on port 80 and TELNET
@@ -73,42 +75,52 @@
  *
  *  <table>
  *   <tr>
- *    <td><b>Define Name:</b></td>
- *    <td><b>Location:</b></td>
- *    <td><b>Description:</b></td>
+ *    <th><b>Define Name:</b></th>
+ *    <th><b>Location:</b></th>
+ *    <th><b>Description:</b></th>
  *   </tr>
  *   <tr>
  *    <td>ENABLE_TELNET_SERVER</td>
- *    <td>Makefile LUFA_OPTS</td>
+ *    <td>AppConfig.h</td>
  *    <td>When defined, this enables the TELNET server in addition to the HTTP webserver, which listens for incoming connections
  *        and processes user commands.</td>
  *   </tr>
  *   <tr>
  *    <td>ENABLE_DHCP_CLIENT</td>
- *    <td>Makefile LUFA_OPTS</td>
+ *    <td>AppConfig.h</td>
  *    <td>When defined, this enables the DHCP client for dynamic IP allocation of the network settings from a DHCP server.</td>
  *   </tr>
  *   <tr>
+ *    <td>ENABLE_DHCP_SERVER</td>
+ *    <td>AppConfig.h</td>
+ *    <td>When defined, this enables the DHCP server for dynamic IP allocation of the network settings to a DHCP client.</td>
+ *   </tr>
+ *   <tr>
  *    <td>DEVICE_IP_ADDRESS</td>
- *    <td>Lib/uIPManagement.h</td>
+ *    <td>AppConfig.h</td>
  *    <td>IP address that the webserver should use when connected to a RNDIS device (when ENABLE_DHCP_CLIENT is not defined).</td>
  *   </tr>
  *   <tr>
  *    <td>DEVICE_NETMASK</td>
- *    <td>Lib/uIPManagement.h</td>
+ *    <td>AppConfig.h</td>
  *    <td>Netmask that the webserver should use when connected to a RNDIS device (when ENABLE_DHCP_CLIENT is not defined).</td>
  *   </tr>
  *   <tr>
  *    <td>DEVICE_GATEWAY</td>
- *    <td>Lib/uIPManagement.h</td>
+ *    <td>AppConfig.h</td>
  *    <td>Default routing gateway that the webserver should use when connected to a RNDIS device (when ENABLE_DHCP_CLIENT
  *        is not defined).</td>
  *   </tr>
  *   <tr>
  *    <td>MAX_URI_LENGTH</td>
- *    <td>Makefile LUFA_OPTS</td>
+ *    <td>AppConfig.h</td>
  *    <td>Maximum length of a URI for the Webserver. This is the maximum file path, including subdirectories and separators.</td>
  *   </tr>
+ *   <tr>
+ *    <td>SERVER_MAC_ADDRESS</td>
+ *    <td>AppConfig.h</td>
+ *    <td>MAC address of the server used when sending Ethernet packets onto the bus.</td>
+ *   </tr>
  *  </table>
  */