Minor documentation improvements.

[pub/USBasp.git] / LUFA / Drivers / USB / Core / Device.h

diff --git a/LUFA/Drivers/USB/Core/Device.h b/LUFA/Drivers/USB/Core/Device.h
index 29452be..1fb14d7 100644 (file)
--- a/LUFA/Drivers/USB/Core/Device.h
+++ b/LUFA/Drivers/USB/Core/Device.h
@@ -1,13 +1,13 @@
 /*
              LUFA Library
 /*
              LUFA Library

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

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


@@ -108,19 +108,19 @@
                         *  index and language ID. This function MUST be overridden in the user application (added with full, identical
                         *  prototype and name so that the library can call it to retrieve descriptor data.
                         *
                         *  index and language ID. This function MUST be overridden in the user application (added with full, identical
                         *  prototype and name so that the library can call it to retrieve descriptor data.
                         *

-                        *  \param[in] wValue               The type of the descriptor to retrieve in the upper byte, and the index in the
-                        *                                  lower byte (when more than one descriptor of the given type exists, such as the
-                        *                                  case of string descriptors). The type may be one of the standard types defined
-                        *                                  in the DescriptorTypes_t enum, or may be a class-specific descriptor type value.
-                        *  \param[in] wIndex               The language ID of the string to return if the \c wValue type indicates
-                        *                                  \ref DTYPE_String, otherwise zero for standard descriptors, or as defined in a
-                        *                                  class-specific standards.
-                        *  \param[out] DescriptorAddress   Pointer to the descriptor in memory. This should be set by the routine to
-                        *                                  the address of the descriptor.
-                        *  \param[out] MemoryAddressSpace  A value from the \ref USB_DescriptorMemorySpaces_t enum to indicate the memory
-                        *                                  space in which the descriptor is stored. This parameter does not exist when one
-                        *                                  of the \c USE_*_DESCRIPTORS compile time options is used, or on architectures which
-                        *                                  use a unified address space.
+                        *  \param[in] wValue                  The type of the descriptor to retrieve in the upper byte, and the index in the
+                        *                                     lower byte (when more than one descriptor of the given type exists, such as the
+                        *                                     case of string descriptors). The type may be one of the standard types defined
+                        *                                     in the DescriptorTypes_t enum, or may be a class-specific descriptor type value.
+                        *  \param[in] wIndex                  The language ID of the string to return if the \c wValue type indicates
+                        *                                     \ref DTYPE_String, otherwise zero for standard descriptors, or as defined in a
+                        *                                     class-specific standards.
+                        *  \param[out] DescriptorAddress      Pointer to the descriptor in memory. This should be set by the routine to
+                        *                                     the address of the descriptor.
+                        *  \param[out] DescriptorMemorySpace  A value from the \ref USB_DescriptorMemorySpaces_t enum to indicate the memory
+                        *                                     space in which the descriptor is stored. This parameter does not exist when one
+                        *                                     of the \c USE_*_DESCRIPTORS compile time options is used, or on architectures which
+                        *                                     use a unified address space.

                         *
                         *  \note By default, the library expects all descriptors to be located in flash memory via the \c PROGMEM attribute.
                         *        If descriptors should be located in RAM or EEPROM instead (to speed up access in the case of RAM, or to
                         *
                         *  \note By default, the library expects all descriptors to be located in flash memory via the \c PROGMEM attribute.
                         *        If descriptors should be located in RAM or EEPROM instead (to speed up access in the case of RAM, or to


@@ -135,7 +135,7 @@
                                                            const void** const DescriptorAddress
                        #if (defined(ARCH_HAS_MULTI_ADDRESS_SPACE) || defined(__DOXYGEN__)) && \
                            !(defined(USE_FLASH_DESCRIPTORS) || defined(USE_EEPROM_DESCRIPTORS) || defined(USE_RAM_DESCRIPTORS))
                                                            const void** const DescriptorAddress
                        #if (defined(ARCH_HAS_MULTI_ADDRESS_SPACE) || defined(__DOXYGEN__)) && \
                            !(defined(USE_FLASH_DESCRIPTORS) || defined(USE_EEPROM_DESCRIPTORS) || defined(USE_RAM_DESCRIPTORS))

-                                                           , uint8_t* MemoryAddressSpace
+                                                           , uint8_t* const DescriptorMemorySpace

                        #endif
                                                            ) ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(3);
 
                        #endif
                                                            ) ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(3);