Minor documentation improvements.

[pub/USBasp.git] / Projects / RelayBoard / Descriptors.h

diff --git a/Projects/RelayBoard/Descriptors.h b/Projects/RelayBoard/Descriptors.h
index 554c361..97ed225 100644 (file)
--- a/Projects/RelayBoard/Descriptors.h
+++ b/Projects/RelayBoard/Descriptors.h
@@ -1,14 +1,14 @@
 /*
              LUFA Library
 /*
              LUFA Library

-     Copyright (C) Dean Camera, 2010.
+     Copyright (C) Dean Camera, 2013.

 
   dean [at] fourwalledcubicle [dot] com
 
   dean [at] fourwalledcubicle [dot] com

-      www.fourwalledcubicle.com
+           www.lufa-lib.org

 */
 
 /*
   Copyright 2010  OBinou (obconseil [at] gmail [dot] com)
 */
 
 /*
   Copyright 2010  OBinou (obconseil [at] gmail [dot] com)

-  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
+  Copyright 2013  Dean Camera (dean [at] fourwalledcubicle [dot] com)

 
   Permission to use, copy, modify, distribute, and sell this
   software and its documentation for any purpose is hereby granted
 
   Permission to use, copy, modify, distribute, and sell this
   software and its documentation for any purpose is hereby granted


@@ -19,7 +19,7 @@
   advertising or publicity pertaining to distribution of the
   software without specific, written prior permission.
 
   advertising or publicity pertaining to distribution of the
   software without specific, written prior permission.
 

-  The author disclaim all warranties with regard to this
+  The author disclaims all warranties with regard to this

   software, including all implied warranties of merchantability
   and fitness.  In no event shall the author be liable for any
   special, indirect or consequential damages or any damages
   software, including all implied warranties of merchantability
   and fitness.  In no event shall the author be liable for any
   special, indirect or consequential damages or any damages


@@ -48,9 +48,23 @@
                 */
                typedef struct
                {
                 */
                typedef struct
                {

-                       USB_Descriptor_Configuration_Header_t    Config;
-                       USB_Descriptor_Interface_t               RelayBoardInterface;
-               } RelayBoard_USB_Descriptor_Configuration_t;
+                       USB_Descriptor_Configuration_Header_t Config;
+
+                       // Relay Board Interface
+                       USB_Descriptor_Interface_t            RelayBoardInterface;
+               } USB_Descriptor_Configuration_t;
+
+               /** Enum for the device string descriptor IDs within the device. Each string descriptor should
+                *  have a unique ID index associated with it, which can be used to refer to the string from
+                *  other descriptors.
+                */
+               enum StringDescriptors_t
+               {
+                   STRING_ID_Language      = 0, /**< Supported Languages string descriptor ID (must be zero) */
+                   STRING_ID_Manufacturer  = 1, /**< Manufacturer string ID */
+                   STRING_ID_Product       = 2, /**< Product string ID */
+                   STRING_ID_Serial        = 3, /**< Serial number string ID */
+               };

 
        /* Function Prototypes: */
                uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue,
 
        /* Function Prototypes: */
                uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue,