Clean up Doxygen to Docbook XSLT, update Atmel Studio blob to use the new IDs.

[pub/USBasp.git] / Projects / XPLAINBridge / USARTDescriptors.h

diff --git a/Projects/XPLAINBridge/USARTDescriptors.h b/Projects/XPLAINBridge/USARTDescriptors.h
index 94476ec..954867c 100644 (file)
--- a/Projects/XPLAINBridge/USARTDescriptors.h
+++ b/Projects/XPLAINBridge/USARTDescriptors.h
@@ -1,13 +1,13 @@
 /*
              LUFA Library
 /*
              LUFA Library

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

 
   dean [at] fourwalledcubicle [dot] com
            www.lufa-lib.org
 */
 
 /*
 
   dean [at] fourwalledcubicle [dot] com
            www.lufa-lib.org
 */
 
 /*

-  Copyright 2012  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


@@ -18,7 +18,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


@@ -81,6 +81,17 @@
                        USB_Descriptor_Endpoint_t                CDC_DataInEndpoint;
                } USART_USB_Descriptor_Configuration_t;
 
                        USB_Descriptor_Endpoint_t                CDC_DataInEndpoint;
                } USART_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 USART_StringDescriptors_t
+               {
+                   USART_STRING_ID_Language      = 0, /**< Supported Languages string descriptor ID (must be zero) */
+                   USART_STRING_ID_Manufacturer  = 1, /**< Manufacturer string ID */
+                   USART_STRING_ID_Product       = 2, /**< Product string ID */
+               };
+

        /* Function Prototypes: */
                uint16_t USART_GetDescriptor(const uint16_t wValue,
                                             const uint8_t wIndex,
        /* Function Prototypes: */
                uint16_t USART_GetDescriptor(const uint16_t wValue,
                                             const uint8_t wIndex,