Fix documentation glitches from the restructuring changes.
[pub/USBasp.git] / LUFA / Drivers / USB / HighLevel / EndpointStream.h
index cd4a218..726378b 100644 (file)
@@ -39,7 +39,7 @@
  */\r
 \r
 /** \ingroup Group_EndpointRW  \r
- *  @defgroup Group_EndpointStreamRW Read/Write of Multi-Byte Streams\r
+ *  \defgroup Group_EndpointStreamRW Read/Write of Multi-Byte Streams\r
  *\r
  *  Functions, macros, variables, enums and types related to data reading and writing of data streams from\r
  *  and to endpoints.\r
                         *\r
                         *  \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.\r
                         */\r
-                       uint8_t Endpoint_Write_Stream_LE(const void* Buffer,\r
+                       uint8_t Endpoint_Write_Stream_LE(const void* const Buffer,\r
                                                         uint16_t Length,\r
                                                         uint16_t* const BytesProcessed) ATTR_NON_NULL_PTR_ARG(1);\r
 \r
                         *\r
                         *  \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.\r
                         */\r
-                       uint8_t Endpoint_Write_Stream_BE(const void* Buffer,\r
+                       uint8_t Endpoint_Write_Stream_BE(const void* const Buffer,\r
                                                         uint16_t Length,\r
                                                         uint16_t* const BytesProcessed) ATTR_NON_NULL_PTR_ARG(1);\r
                        \r
                         *\r
                         *  \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.\r
                         */\r
-                       uint8_t Endpoint_Read_Stream_LE(void* Buffer,\r
+                       uint8_t Endpoint_Read_Stream_LE(void* const Buffer,\r
                                                        uint16_t Length,\r
                                                        uint16_t* const BytesProcessed) ATTR_NON_NULL_PTR_ARG(1);\r
 \r
                         *\r
                         *  \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.\r
                         */\r
-                       uint8_t Endpoint_Read_Stream_BE(void* Buffer,\r
+                       uint8_t Endpoint_Read_Stream_BE(void* const Buffer,\r
                                                        uint16_t Length,\r
                                                        uint16_t* const BytesProcessed) ATTR_NON_NULL_PTR_ARG(1);\r
 \r
                         *\r
                         *  \return A value from the \ref Endpoint_ControlStream_RW_ErrorCodes_t enum.\r
                         */\r
-                       uint8_t Endpoint_Write_Control_Stream_LE(const void* Buffer,\r
+                       uint8_t Endpoint_Write_Control_Stream_LE(const void* const Buffer,\r
                                                                 uint16_t Length) ATTR_NON_NULL_PTR_ARG(1);\r
 \r
                        /** Writes the given number of bytes to the CONTROL type endpoint from the given buffer in big endian,\r
                         *\r
                         *  \return A value from the \ref Endpoint_ControlStream_RW_ErrorCodes_t enum.\r
                         */\r
-                       uint8_t Endpoint_Write_Control_Stream_BE(const void* Buffer,\r
+                       uint8_t Endpoint_Write_Control_Stream_BE(const void* const Buffer,\r
                                                                 uint16_t Length) ATTR_NON_NULL_PTR_ARG(1);\r
 \r
                        /** Reads the given number of bytes from the CONTROL endpoint from the given buffer in little endian,\r
                         *\r
                         *  \return A value from the \ref Endpoint_ControlStream_RW_ErrorCodes_t enum.\r
                         */\r
-                       uint8_t Endpoint_Read_Control_Stream_LE(void* Buffer,\r
+                       uint8_t Endpoint_Read_Control_Stream_LE(void* const Buffer,\r
                                                                uint16_t Length) ATTR_NON_NULL_PTR_ARG(1);\r
 \r
                        /** Reads the given number of bytes from the CONTROL endpoint from the given buffer in big endian,\r
                         *\r
                         *  \return A value from the \ref Endpoint_ControlStream_RW_ErrorCodes_t enum.\r
                         */\r
-                       uint8_t Endpoint_Read_Control_Stream_BE(void* Buffer,\r
+                       uint8_t Endpoint_Read_Control_Stream_BE(void* const Buffer,\r
                                                                uint16_t Length) ATTR_NON_NULL_PTR_ARG(1);\r
                        //@}\r
 \r
                         *\r
                         *  \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.\r
                         */\r
-                       uint8_t Endpoint_Write_EStream_LE(const void* Buffer,\r
+                       uint8_t Endpoint_Write_EStream_LE(const void* const Buffer,\r
                                                          uint16_t Length,\r
                                                          uint16_t* const BytesProcessed) ATTR_NON_NULL_PTR_ARG(1);\r
 \r
                         *\r
                         *  \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.\r
                         */\r
-                       uint8_t Endpoint_Write_EStream_BE(const void* Buffer,\r
+                       uint8_t Endpoint_Write_EStream_BE(const void* const Buffer,\r
                                                          uint16_t Length,\r
                                                          uint16_t* const BytesProcessed) ATTR_NON_NULL_PTR_ARG(1);\r
 \r
                         *\r
                         *  \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.\r
                         */\r
-                       uint8_t Endpoint_Read_EStream_LE(void* Buffer,\r
+                       uint8_t Endpoint_Read_EStream_LE(void* const Buffer,\r
                                                         uint16_t Length,\r
                                                         uint16_t* const BytesProcessed) ATTR_NON_NULL_PTR_ARG(1);\r
 \r
                         *\r
                         *  \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.\r
                         */\r
-                       uint8_t Endpoint_Read_EStream_BE(void* Buffer,\r
+                       uint8_t Endpoint_Read_EStream_BE(void* const Buffer,\r
                                                         uint16_t Length,\r
                                                         uint16_t* const BytesProcessed) ATTR_NON_NULL_PTR_ARG(1);\r
 \r
                         *\r
                         *  \return A value from the \ref Endpoint_ControlStream_RW_ErrorCodes_t enum.\r
                         */\r
-                       uint8_t Endpoint_Write_Control_EStream_LE(const void* Buffer,\r
+                       uint8_t Endpoint_Write_Control_EStream_LE(const void* const Buffer,\r
                                                                  uint16_t Length) ATTR_NON_NULL_PTR_ARG(1);\r
 \r
                        /** EEPROM buffer source version of \ref Endpoint_Write_Control_Stream_BE().\r
                         *\r
                         *  \return A value from the \ref Endpoint_ControlStream_RW_ErrorCodes_t enum.\r
                         */\r
-                       uint8_t Endpoint_Write_Control_EStream_BE(const void* Buffer,\r
+                       uint8_t Endpoint_Write_Control_EStream_BE(const void* const Buffer,\r
                                                                  uint16_t Length) ATTR_NON_NULL_PTR_ARG(1);\r
 \r
                        /** EEPROM buffer source version of \ref Endpoint_Read_Control_Stream_LE().\r
                         *\r
                         *  \return A value from the \ref Endpoint_ControlStream_RW_ErrorCodes_t enum.\r
                         */\r
-                       uint8_t Endpoint_Read_Control_EStream_LE(void* Buffer,\r
+                       uint8_t Endpoint_Read_Control_EStream_LE(void* const Buffer,\r
                                                                 uint16_t Length) ATTR_NON_NULL_PTR_ARG(1);\r
 \r
                        /** EEPROM buffer source version of \ref Endpoint_Read_Control_Stream_BE().\r
                         *\r
                         *  \return A value from the \ref Endpoint_ControlStream_RW_ErrorCodes_t enum.\r
                         */\r
-                       uint8_t Endpoint_Read_Control_EStream_BE(void* Buffer,\r
+                       uint8_t Endpoint_Read_Control_EStream_BE(void* const Buffer,\r
                                                                 uint16_t Length) ATTR_NON_NULL_PTR_ARG(1);\r
                        //@}\r
 \r
                         *\r
                         *  \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.\r
                         */\r
-                       uint8_t Endpoint_Write_PStream_LE(const void* Buffer,\r
+                       uint8_t Endpoint_Write_PStream_LE(const void* const Buffer,\r
                                                          uint16_t Length,\r
                                                          uint16_t* const BytesProcessed) ATTR_NON_NULL_PTR_ARG(1);\r
 \r
                         *\r
                         *  \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.\r
                         */\r
-                       uint8_t Endpoint_Write_PStream_BE(const void* Buffer,\r
+                       uint8_t Endpoint_Write_PStream_BE(const void* const Buffer,\r
                                                          uint16_t Length,\r
                                                          uint16_t* const BytesProcessed) ATTR_NON_NULL_PTR_ARG(1);\r
 \r
                         *\r
                         *  \return A value from the \ref Endpoint_ControlStream_RW_ErrorCodes_t enum.\r
                         */\r
-                       uint8_t Endpoint_Write_Control_PStream_LE(const void* Buffer,\r
+                       uint8_t Endpoint_Write_Control_PStream_LE(const void* const Buffer,\r
                                                                  uint16_t Length) ATTR_NON_NULL_PTR_ARG(1);\r
 \r
                        /** FLASH buffer source version of \ref Endpoint_Write_Control_Stream_BE().\r
                         *\r
                         *  \return A value from the \ref Endpoint_ControlStream_RW_ErrorCodes_t enum.\r
                         */\r
-                       uint8_t Endpoint_Write_Control_PStream_BE(const void* Buffer,\r
+                       uint8_t Endpoint_Write_Control_PStream_BE(const void* const Buffer,\r
                                                                  uint16_t Length) ATTR_NON_NULL_PTR_ARG(1);\r
                        //@}\r
 \r