ahoneybun/qmk_firmware
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Change over Doxygen \note documentation to \pre where applicable.

Browse source
This commit is contained in:
Dean Camera 2010-06-15 03:34:55 +00:00
parent 27fb44268f
commit a14ece5f57
17 changed files with 118 additions and 123 deletions
Download patch file Download diff file Expand all files Collapse all files

18
LUFA/Drivers/USB/LowLevel/Endpoint.h
View file

@ -756,8 +756,8 @@
*
* The banking mode may be either \ref ENDPOINT_BANK_SINGLE or \ref ENDPOINT_BANK_DOUBLE.
*
* \note The default control endpoint does not have to be manually configured, as it is automatically
* configured by the library internally.
* \note The default control endpoint should not be manually configured by the user application, as
* it is automatically configured by the library internally.
* \n\n
*
* \note This routine will select the specified endpoint, and the endpoint will remain selected
@ -844,7 +844,7 @@
/** FLASH buffer source version of \ref Endpoint_Write_Stream_LE().
*
* \note The FLASH data must be located in the first 64KB of FLASH for this function to work correctly.
* \pre The FLASH data must be located in the first 64KB of FLASH for this function to work correctly.
*
* \ingroup Group_EndpointStreamRW
*
@ -893,7 +893,7 @@
/** FLASH buffer source version of \ref Endpoint_Write_Stream_BE().
*
* \note The FLASH data must be located in the first 64KB of FLASH for this function to work correctly.
* \pre The FLASH data must be located in the first 64KB of FLASH for this function to work correctly.
*
* \ingroup Group_EndpointStreamRW
*
@ -1019,14 +1019,13 @@
uint8_t Endpoint_Write_Control_EStream_LE(const void* Buffer, uint16_t Length) ATTR_NON_NULL_PTR_ARG(1);
/** FLASH buffer source version of \ref Endpoint_Write_Control_Stream_LE().
*
* \pre The FLASH data must be located in the first 64KB of FLASH for this function to work correctly.
*
* \note This function automatically clears the control transfer's status stage. Do not manually attempt
* to clear the status stage when using this routine in a control transaction.
* \n\n
*
* \note The FLASH data must be located in the first 64KB of FLASH for this function to work correctly.
* \n\n
*
* \note This routine should only be used on CONTROL type endpoints.
*
* \warning Unlike the standard stream read/write commands, the control stream commands cannot be chained
@ -1085,14 +1084,13 @@
uint8_t Endpoint_Write_Control_EStream_BE(const void* Buffer, uint16_t Length) ATTR_NON_NULL_PTR_ARG(1);
/** FLASH buffer source version of \ref Endpoint_Write_Control_Stream_BE().
*
* \pre The FLASH data must be located in the first 64KB of FLASH for this function to work correctly.
*
* \note This function automatically clears the control transfer's status stage. Do not manually attempt
* to clear the status stage when using this routine in a control transaction.
* \n\n
*
* \note The FLASH data must be located in the first 64KB of FLASH for this function to work correctly.
* \n\n
*
* \note This routine should only be used on CONTROL type endpoints.
*
* \warning Unlike the standard stream read/write commands, the control stream commands cannot be chained