Allow the title of top level pages to be overridden in the Atmel Studio help.

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

diff --git a/LUFA/Drivers/USB/Core/ConfigDescriptors.h b/LUFA/Drivers/USB/Core/ConfigDescriptors.h
index 0cf45fa..ad3c987 100644 (file)
--- a/LUFA/Drivers/USB/Core/ConfigDescriptors.h
+++ b/LUFA/Drivers/USB/Core/ConfigDescriptors.h
@@ -1,13 +1,13 @@
 /*
              LUFA Library
-     Copyright (C) Dean Camera, 2012.
+     Copyright (C) Dean Camera, 2013.
 
   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
@@ -76,7 +76,7 @@
                         *  uint8_t* CurrDescriptor = &ConfigDescriptor[0]; // Pointing to the configuration header
                         *  USB_Descriptor_Configuration_Header_t* ConfigHeaderPtr = DESCRIPTOR_PCAST(CurrDescriptor,
                         *                                                           USB_Descriptor_Configuration_Header_t);
-                        *  
+                        *
                         *  // Can now access elements of the configuration header struct using the -> indirection operator
                         *  \endcode
                         */
@@ -90,7 +90,7 @@
                         *  uint8_t* CurrDescriptor = &ConfigDescriptor[0]; // Pointing to the configuration header
                         *  USB_Descriptor_Configuration_Header_t ConfigHeader = DESCRIPTOR_CAST(CurrDescriptor,
                         *                                                       USB_Descriptor_Configuration_Header_t);
-                        *  
+                        *
                         *  // Can now access elements of the configuration header struct using the . operator
                         *  \endcode
                         */
@@ -231,7 +231,7 @@
                         *  Usage Example:
                         *  \code
                         *  uint8_t EndpointSearcher(void* CurrentDescriptor); // Comparator Prototype
-                        *  
+                        *
                         *  uint8_t EndpointSearcher(void* CurrentDescriptor)
                         *  {
                         *     if (DESCRIPTOR_TYPE(CurrentDescriptor) == DTYPE_Endpoint)
@@ -239,9 +239,9 @@
                         *     else
                         *         return DESCRIPTOR_SEARCH_NotFound;
                         *  }
-                        *  
+                        *
                         *  //...
-                        *  
+                        *
                         *  // After retrieving configuration descriptor:
                         *  if (USB_Host_GetNextDescriptorComp(&BytesRemaining, &CurrentConfigLoc, EndpointSearcher) ==
                         *      Descriptor_Search_Comp_Found)
@@ -252,7 +252,8 @@
                         */
                        uint8_t USB_GetNextDescriptorComp(uint16_t* const BytesRem,
                                                          void** const CurrConfigLoc,
-                                                         ConfigComparatorPtr_t const ComparatorRoutine);
+                                                         ConfigComparatorPtr_t const ComparatorRoutine) ATTR_NON_NULL_PTR_ARG(1)
+                                                         ATTR_NON_NULL_PTR_ARG(2) ATTR_NON_NULL_PTR_ARG(3);
 
                /* Inline Functions: */
                        /** Skips over the current sub-descriptor inside the configuration descriptor, so that the pointer then