Demos/Host/StillImageHost/StillImageHost.txt

   1 /** \file
   2  *
   3  *  This file contains special DoxyGen information for the generation of the main page and other special
   4  *  documentation pages. It is not a project source file.
   5  */
   6
   7 /** \mainpage Still Image Host Demo
   8  *
   9  *  \section SSec_Info USB Information:
  10  *
  11  *  The following table gives a rundown of the USB utilization of this demo.
  12  *
  13  *  <table>
  14  *   <tr>
  15  *    <td><b>USB Mode:</b></td>
  16  *    <td>Host</td>
  17  *   </tr>
  18  *   <tr>
  19  *    <td><b>USB Class:</b></td>
  20  *    <td>Still Image Device</td>
  21  *   </tr>
  22  *   <tr>
  23  *    <td><b>USB Subclass:</b></td>
  24  *    <td>N/A</td>
  25  *   </tr>
  26  *   <tr>
  27  *    <td><b>Relevant Standards:</b></td>
  28  *    <td>USBIF Still Image Class Specification</td>
  29  *    <td>PIMA 15740 Specification</td>
  30  *   </tr>
  31  *   <tr>
  32  *    <td><b>Usable Speeds:</b></td>
  33  *    <td>Full Speed Mode</td>
  34  *   </tr>
  35  *  </table>
  36  *
  37  *  \section SSec_Description Project Description:
  38  *
  39  *  Still Image host demonstration application. This gives a simple reference
  40  *  application for implementing a Still Image host, for USB devices such as
  41  *  digital cameras.
  42  *
  43  *  This demo will enumerate an attached USB Still Image device, print out its
  44  *  information structure, open a session with the device and finally close the
  45  *  session.
  46  *
  47  *  \section SSec_Options Project Options
  48  *
  49  *  The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value.
  50  *
  51  *  <table>
  52  *   <tr>
  53  *    <td>
  54  *     None
  55  *    </td>
  56  *   </tr>
  57  *  </table>
  58  */