Fix spacing of the function parameter descriptions in the Doxygen documentation.
authorDean Camera <dean@fourwalledcubicle.com>
Sat, 29 May 2010 08:08:26 +0000 (08:08 +0000)
committerDean Camera <dean@fourwalledcubicle.com>
Sat, 29 May 2010 08:08:26 +0000 (08:08 +0000)
21 files changed:
LUFA/Common/Common.h
LUFA/Drivers/Board/LEDs.h
LUFA/Drivers/Peripheral/AVRU4U6U7/TWI.h
LUFA/Drivers/Peripheral/SPI.h
LUFA/Drivers/USB/Class/Device/CDC.h
LUFA/Drivers/USB/Class/Device/HID.h
LUFA/Drivers/USB/Class/Device/MIDI.h
LUFA/Drivers/USB/Class/Host/CDC.h
LUFA/Drivers/USB/Class/Host/HID.h
LUFA/Drivers/USB/Class/Host/HIDParser.h
LUFA/Drivers/USB/Class/Host/MIDI.h
LUFA/Drivers/USB/Class/Host/MassStorage.h
LUFA/Drivers/USB/Class/Host/Printer.h
LUFA/Drivers/USB/Class/Host/RNDIS.h
LUFA/Drivers/USB/Class/Host/StillImage.h
LUFA/Drivers/USB/HighLevel/ConfigDescriptor.h
LUFA/Drivers/USB/HighLevel/Events.h
LUFA/Drivers/USB/LowLevel/Device.h
LUFA/Drivers/USB/LowLevel/Endpoint.h
LUFA/Drivers/USB/LowLevel/Host.h
LUFA/Drivers/USB/LowLevel/Pipe.h

index febc216..76307d7 100644 (file)
                         *
                         *  \ingroup Group_BitManip
                         *
                         *
                         *  \ingroup Group_BitManip
                         *
-                        *  \param[in] Byte   Byte of data whose bits are to be reversed
+                        *  \param[in] Byte  Byte of data whose bits are to be reversed
                         */
                        static inline uint8_t BitReverse(uint8_t Byte) ATTR_WARN_UNUSED_RESULT ATTR_CONST;
                        static inline uint8_t BitReverse(uint8_t Byte)
                         */
                        static inline uint8_t BitReverse(uint8_t Byte) ATTR_WARN_UNUSED_RESULT ATTR_CONST;
                        static inline uint8_t BitReverse(uint8_t Byte)
                         *
                         *  \ingroup Group_BitManip
                         *
                         *
                         *  \ingroup Group_BitManip
                         *
-                        *  \param[in] Word   Word of data whose bytes are to be swapped
+                        *  \param[in] Word  Word of data whose bytes are to be swapped
                         */
                        static inline uint16_t SwapEndian_16(uint16_t Word) ATTR_WARN_UNUSED_RESULT ATTR_CONST;
                        static inline uint16_t SwapEndian_16(uint16_t Word)
                         */
                        static inline uint16_t SwapEndian_16(uint16_t Word) ATTR_WARN_UNUSED_RESULT ATTR_CONST;
                        static inline uint16_t SwapEndian_16(uint16_t Word)
                         *
                         *  \ingroup Group_BitManip
                         *
                         *
                         *  \ingroup Group_BitManip
                         *
-                        *  \param[in] DWord   Double word of data whose bytes are to be swapped
+                        *  \param[in] DWord  Double word of data whose bytes are to be swapped
                         */
                        static inline uint32_t SwapEndian_32(uint32_t DWord) ATTR_WARN_UNUSED_RESULT ATTR_CONST;
                        static inline uint32_t SwapEndian_32(uint32_t DWord)
                         */
                        static inline uint32_t SwapEndian_32(uint32_t DWord) ATTR_WARN_UNUSED_RESULT ATTR_CONST;
                        static inline uint32_t SwapEndian_32(uint32_t DWord)
                         *
                         *  \ingroup Group_BitManip
                         *
                         *
                         *  \ingroup Group_BitManip
                         *
-                        *  \param[in,out] Data  Pointer to a number containing an even number of bytes to be reversed
-                        *  \param[in] Bytes  Length of the data in bytes
+                        *  \param[in,out] Data   Pointer to a number containing an even number of bytes to be reversed
+                        *  \param[in]     Bytes  Length of the data in bytes
                         */
                        static inline void SwapEndian_n(void* Data, uint8_t Bytes);
                        static inline void SwapEndian_n(void* Data, uint8_t Bytes)
                         */
                        static inline void SwapEndian_n(void* Data, uint8_t Bytes);
                        static inline void SwapEndian_n(void* Data, uint8_t Bytes)
index 5e6a4cd..f34041e 100644 (file)
                
                /** Toggles all LEDs in the LED mask, leaving all others in their current states.
                 *
                
                /** Toggles all LEDs in the LED mask, leaving all others in their current states.
                 *
-                *  \param[in] LEDMask Mask of the board LEDs to manipulate (see board-specific LEDs.h driver file)
+                *  \param[in] LEDMask  Mask of the board LEDs to manipulate (see board-specific LEDs.h driver file)
                 */
                static inline void LEDs_ToggleLEDs(const uint8_t LEDMask);
 
                 */
                static inline void LEDs_ToggleLEDs(const uint8_t LEDMask);
 
index f6a2517..eb9e6aa 100644 (file)
 
                        /** Receives a byte from the currently addressed device on the TWI bus.
                         *
 
                        /** Receives a byte from the currently addressed device on the TWI bus.
                         *
-                        *  \param[in] Byte  Location where the read byte is to be stored
+                        *  \param[in] Byte      Location where the read byte is to be stored
                         *  \param[in] LastByte  Indicates if the byte should be ACKed if false, NAKed if true
                         *
                         *  \return Boolean true if the byte reception sucessfully completed, false otherwise
                         *  \param[in] LastByte  Indicates if the byte should be ACKed if false, NAKed if true
                         *
                         *  \return Boolean true if the byte reception sucessfully completed, false otherwise
index 9e64753..195818a 100644 (file)
                        /** Sends a byte through the SPI interface, blocking until the transfer is complete. The response
                         *  byte sent to from the attached SPI device is ignored.
                         *
                        /** Sends a byte through the SPI interface, blocking until the transfer is complete. The response
                         *  byte sent to from the attached SPI device is ignored.
                         *
-                        *  \param[in] Byte Byte to send through the SPI interface
+                        *  \param[in] Byte  Byte to send through the SPI interface
                         */
                        static inline void SPI_SendByte(const uint8_t Byte) ATTR_ALWAYS_INLINE;
                        static inline void SPI_SendByte(const uint8_t Byte)
                         */
                        static inline void SPI_SendByte(const uint8_t Byte) ATTR_ALWAYS_INLINE;
                        static inline void SPI_SendByte(const uint8_t Byte)
index f0351f5..8a0cb6a 100644 (file)
                         *  \note This function must only be called when the Device state machine is in the DEVICE_STATE_Configured state or
                         *        the call will fail.
                         *
                         *  \note This function must only be called when the Device state machine is in the DEVICE_STATE_Configured state or
                         *        the call will fail.
                         *
-                        *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state
-                        *  \param[in] Data  Pointer to the string to send to the host
-                        *  \param[in] Length  Size in bytes of the string to send to the host
+                        *  \param[in,out]   CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state
+                        *  \param[in]       Data              Pointer to the string to send to the host
+                        *  \param[in]       Length            Size in bytes of the string to send to the host
                         *
                         *  \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum
                         */
                         *
                         *  \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum
                         */
                         *        the call will fail.
                         *
                         *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state
                         *        the call will fail.
                         *
                         *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state
-                        *  \param[in] Data  Byte of data to send to the host
+                        *  \param[in]     Data              Byte of data to send to the host
                         *
                         *  \return A value from the \ref Endpoint_WaitUntilReady_ErrorCodes_t enum
                         */
                         *
                         *  \return A value from the \ref Endpoint_WaitUntilReady_ErrorCodes_t enum
                         */
                         *        to the given CDC interface.
                         *
                         *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state
                         *        to the given CDC interface.
                         *
                         *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state
-                        *  \param[in,out] Stream  Pointer to a FILE structure where the created stream should be placed
+                        *  \param[in,out] Stream            Pointer to a FILE structure where the created stream should be placed
                         */
                        void CDC_Device_CreateStream(USB_ClassInfo_CDC_Device_t* CDCInterfaceInfo, FILE* Stream);
 
                         */
                        void CDC_Device_CreateStream(USB_ClassInfo_CDC_Device_t* CDCInterfaceInfo, FILE* Stream);
 
                         *  the transfer. While blocking, the USB and CDC service tasks are called repeatedly to maintain USB communications.
                         *
                         *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state
                         *  the transfer. While blocking, the USB and CDC service tasks are called repeatedly to maintain USB communications.
                         *
                         *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state
-                        *  \param[in,out] Stream  Pointer to a FILE structure where the created stream should be placed
+                        *  \param[in,out] Stream            Pointer to a FILE structure where the created stream should be placed
                         */
                        void CDC_Device_CreateBlockingStream(USB_ClassInfo_CDC_Device_t* CDCInterfaceInfo, FILE* Stream);
 
                         */
                        void CDC_Device_CreateBlockingStream(USB_ClassInfo_CDC_Device_t* CDCInterfaceInfo, FILE* Stream);
 
index 9e42843..4088e87 100644 (file)
                         *  user is responsible for the creation of the next HID input report to be sent to the host.
                         *
                         *  \param[in,out] HIDInterfaceInfo  Pointer to a structure containing a HID Class configuration and state
                         *  user is responsible for the creation of the next HID input report to be sent to the host.
                         *
                         *  \param[in,out] HIDInterfaceInfo  Pointer to a structure containing a HID Class configuration and state
-                        *  \param[in,out] ReportID  If preset to a non-zero value, this is the report ID being requested by the host. If zero, this should
-                        *                 be set to the report ID of the generated HID input report (if any). If multiple reports are not sent via the
-                        *                 given HID interface, this parameter should be ignored.
-                        *  \param[in] ReportType  Type of HID report to generate, either \ref REPORT_ITEM_TYPE_In or \ref REPORT_ITEM_TYPE_Feature
-                        *  \param[out] ReportData  Pointer to a buffer where the generated HID report should be stored
-                        *  \param[out] ReportSize  Number of bytes in the generated input report, or zero if no report is to be sent
+                        *  \param[in,out] ReportID          If preset to a non-zero value, this is the report ID being requested by the host. If zero, 
+                        *                                   this should be set to the report ID of the generated HID input report (if any). If multiple
+                        *                                   reports are not sent via the given HID interface, this parameter should be ignored.
+                        *  \param[in]     ReportType        Type of HID report to generate, either \ref REPORT_ITEM_TYPE_In or \ref REPORT_ITEM_TYPE_Feature
+                        *  \param[out]    ReportData        Pointer to a buffer where the generated HID report should be stored
+                        *  \param[out]    ReportSize        Number of bytes in the generated input report, or zero if no report is to be sent
                         *
                         *  \return Boolean true to force the sending of the report even if it is identical to the previous report and still within
                         *          the idle period (useful for devices which report relative movement), false otherwise
                         *
                         *  \return Boolean true to force the sending of the report even if it is identical to the previous report and still within
                         *          the idle period (useful for devices which report relative movement), false otherwise
                         *  the user is responsible for the processing of the received HID output report from the host.
                         *
                         *  \param[in,out] HIDInterfaceInfo  Pointer to a structure containing a HID Class configuration and state
                         *  the user is responsible for the processing of the received HID output report from the host.
                         *
                         *  \param[in,out] HIDInterfaceInfo  Pointer to a structure containing a HID Class configuration and state
-                        *  \param[in] ReportID  Report ID of the received output report. If multiple reports are not received via the given HID
-                        *                   interface, this parameter should be ignored.
-                        *  \param[in] ReportType  Type of received HID report, either \ref REPORT_ITEM_TYPE_Out or \ref REPORT_ITEM_TYPE_Feature
-                        *  \param[in] ReportData  Pointer to a buffer where the received HID report is stored.
-                        *  \param[in] ReportSize  Size in bytes of the received report from the host.
+                        *  \param[in]     ReportID          Report ID of the received output report. If multiple reports are not received via the given HID
+                        *                                   interface, this parameter should be ignored.
+                        *  \param[in]     ReportType        Type of received HID report, either \ref REPORT_ITEM_TYPE_Out or \ref REPORT_ITEM_TYPE_Feature
+                        *  \param[in]     ReportData        Pointer to a buffer where the received HID report is stored.
+                        *  \param[in]     ReportSize        Size in bytes of the received report from the host.
                         */
                        void CALLBACK_HID_Device_ProcessHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo, const uint8_t ReportID,
                                                                  const uint8_t ReportType, const void* ReportData, const uint16_t ReportSize) ATTR_NON_NULL_PTR_ARG(1)
                         */
                        void CALLBACK_HID_Device_ProcessHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo, const uint8_t ReportID,
                                                                  const uint8_t ReportType, const void* ReportData, const uint16_t ReportSize) ATTR_NON_NULL_PTR_ARG(1)
index c4b8715..9529f17 100644 (file)
                         *        the call will fail.
                         *
                         *  \param[in,out] MIDIInterfaceInfo  Pointer to a structure containing a MIDI Class configuration and state
                         *        the call will fail.
                         *
                         *  \param[in,out] MIDIInterfaceInfo  Pointer to a structure containing a MIDI Class configuration and state
-                        *  \param[in] Event  Pointer to a populated USB_MIDI_EventPacket_t structure containing the MIDI event to send
+                        *  \param[in]     Event              Pointer to a populated USB_MIDI_EventPacket_t structure containing the MIDI event to send
                         *
                         *  \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum                   
                         */
                         *
                         *  \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum                   
                         */
                         *        the call will fail.
                         *
                         *  \param[in,out] MIDIInterfaceInfo  Pointer to a structure containing a MIDI Class configuration and state
                         *        the call will fail.
                         *
                         *  \param[in,out] MIDIInterfaceInfo  Pointer to a structure containing a MIDI Class configuration and state
-                        *  \param[out] Event  Pointer to a USB_MIDI_EventPacket_t structure where the received MIDI event is to be placed
+                        *  \param[out]    Event              Pointer to a USB_MIDI_EventPacket_t structure where the received MIDI event is to be placed
                         *
                         *  \return Boolean true if a MIDI event packet was received, false otherwise
                         */
                         *
                         *  \return Boolean true if a MIDI event packet was received, false otherwise
                         */
index 2ccc880..c3ca645 100644 (file)
                         *  This should be called once after the stack has enumerated the attached device, while the host state machine is in
                         *  the Addressed state.
                         *
                         *  This should be called once after the stack has enumerated the attached device, while the host state machine is in
                         *  the Addressed state.
                         *
-                        *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing an CDC Class host configuration and state
-                        *  \param[in] ConfigDescriptorSize  Length of the attached device's Configuration Descriptor
-                        *  \param[in] DeviceConfigDescriptor  Pointer to a buffer containing the attached device's Configuration Descriptor
+                        *  \param[in,out] CDCInterfaceInfo        Pointer to a structure containing an CDC Class host configuration and state
+                        *  \param[in]     ConfigDescriptorSize    Length of the attached device's Configuration Descriptor
+                        *  \param[in]     DeviceConfigDescriptor  Pointer to a buffer containing the attached device's Configuration Descriptor
                         *
                         *  \return A value from the \ref CDCHost_EnumerationFailure_ErrorCodes_t enum
                         */
                         *
                         *  \return A value from the \ref CDCHost_EnumerationFailure_ErrorCodes_t enum
                         */
                         *        call will fail.
                         *
                         *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class host configuration and state
                         *        call will fail.
                         *
                         *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class host configuration and state
-                        *  \param[in] Data  Pointer to the string to send to the device
-                        *  \param[in] Length  Size in bytes of the string to send to the device
+                        *  \param[in]     Data              Pointer to the string to send to the device
+                        *  \param[in]     Length            Size in bytes of the string to send to the device
                         *
                         *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum
                         */
                         *
                         *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum
                         */
                         *        call will fail.
                         *
                         *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class host configuration and state
                         *        call will fail.
                         *
                         *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class host configuration and state
-                        *  \param[in] Data  Byte of data to send to the device
+                        *  \param[in]     Data              Byte of data to send to the device
                         *
                         *  \return A value from the \ref Pipe_WaitUntilReady_ErrorCodes_t enum
                         */
                         *
                         *  \return A value from the \ref Pipe_WaitUntilReady_ErrorCodes_t enum
                         */
                         *        to the given CDC interface.
                         *
                         *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state
                         *        to the given CDC interface.
                         *
                         *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state
-                        *  \param[in,out] Stream  Pointer to a FILE structure where the created stream should be placed
+                        *  \param[in,out] Stream            Pointer to a FILE structure where the created stream should be placed
                         */
                        void CDC_Host_CreateStream(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo, FILE* Stream);
 
                         */
                        void CDC_Host_CreateStream(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo, FILE* Stream);
 
                         *  the transfer. While blocking, the USB and CDC service tasks are called repeatedly to maintain USB communications.
                         *
                         *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state
                         *  the transfer. While blocking, the USB and CDC service tasks are called repeatedly to maintain USB communications.
                         *
                         *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state
-                        *  \param[in,out] Stream  Pointer to a FILE structure where the created stream should be placed
+                        *  \param[in,out] Stream            Pointer to a FILE structure where the created stream should be placed
                         */
                        void CDC_Host_CreateBlockingStream(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo, FILE* Stream);
 
                         */
                        void CDC_Host_CreateBlockingStream(USB_ClassInfo_CDC_Host_t* CDCInterfaceInfo, FILE* Stream);
 
index 7aabd7c..88c514b 100644 (file)
                         *  \note Once the device pipes are configured, the HID device's reporting protocol <b>must</b> be set via a call
                         *        to either the \ref HID_Host_SetBootProtocol() or \ref HID_Host_SetReportProtocol() function.
                         *
                         *  \note Once the device pipes are configured, the HID device's reporting protocol <b>must</b> be set via a call
                         *        to either the \ref HID_Host_SetBootProtocol() or \ref HID_Host_SetReportProtocol() function.
                         *
-                        *  \param[in,out] HIDInterfaceInfo  Pointer to a structure containing a HID Class host configuration and state
-                        *  \param[in] ConfigDescriptorSize  Length of the attached device's Configuration Descriptor
-                        *  \param[in] DeviceConfigDescriptor  Pointer to a buffer containing the attached device's Configuration Descriptor
+                        *  \param[in,out] HIDInterfaceInfo        Pointer to a structure containing a HID Class host configuration and state
+                        *  \param[in]     ConfigDescriptorSize    Length of the attached device's Configuration Descriptor
+                        *  \param[in]     DeviceConfigDescriptor  Pointer to a buffer containing the attached device's Configuration Descriptor
                         *
                         *  \return A value from the \ref HIDHost_EnumerationFailure_ErrorCodes_t enum
                         */
                         *
                         *  \return A value from the \ref HIDHost_EnumerationFailure_ErrorCodes_t enum
                         */
                         *        can generate.
                         *
                         *  \param[in,out] HIDInterfaceInfo  Pointer to a structure containing a HID Class host configuration and state
                         *        can generate.
                         *
                         *  \param[in,out] HIDInterfaceInfo  Pointer to a structure containing a HID Class host configuration and state
-                        *  \param[in] Buffer  Buffer to store the received report into
+                        *  \param[in]     Buffer            Buffer to store the received report into
                         *
                         *  \return An error code from the \ref Pipe_Stream_RW_ErrorCodes_t enum
                         */
                         *
                         *  \return An error code from the \ref Pipe_Stream_RW_ErrorCodes_t enum
                         */
                         *  \note When the HID_HOST_BOOT_PROTOCOL_ONLY compile time token is defined, this method is unavailable.
                         *
                         *  \param[in,out] HIDInterfaceInfo  Pointer to a structure containing a HID Class host configuration and state
                         *  \note When the HID_HOST_BOOT_PROTOCOL_ONLY compile time token is defined, this method is unavailable.
                         *
                         *  \param[in,out] HIDInterfaceInfo  Pointer to a structure containing a HID Class host configuration and state
-                        *  \param[in] ReportID  Report ID of the received report if ControlRequest is false, set by the to the Report ID to fetch
-                        *  \param[in] Buffer  Buffer to store the received report into
+                        *  \param[in]     ReportID          Report ID of the received report if ControlRequest is false, set by the to the Report ID to fetch
+                        *  \param[in]     Buffer            Buffer to store the received report into
                         *
                         *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum
                         */
                         *
                         *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum
                         */
                         *        from the parameter list of this function.
                         *
                         *  \param[in,out] HIDInterfaceInfo  Pointer to a structure containing a HID Class host configuration and state
                         *        from the parameter list of this function.
                         *
                         *  \param[in,out] HIDInterfaceInfo  Pointer to a structure containing a HID Class host configuration and state
-                        *  \param[in] ReportID  Report ID of the report to send to the device, or 0 if the device does not use report IDs
-                        *  \param[in] ReportType  Type of report to issue to the device, either \ref REPORT_ITEM_TYPE_Out or \ref REPORT_ITEM_TYPE_Feature
-                        *  \param[in] Buffer  Buffer containing the report to send to the attached device
-                        *  \param[in] ReportSize  Report size in bytes to send to the attached device
+                        *  \param[in]     ReportID          Report ID of the report to send to the device, or 0 if the device does not use report IDs
+                        *  \param[in]     ReportType        Type of report to issue to the device, either \ref REPORT_ITEM_TYPE_Out or \ref REPORT_ITEM_TYPE_Feature
+                        *  \param[in]     Buffer            Buffer containing the report to send to the attached device
+                        *  \param[in]     ReportSize        Report size in bytes to send to the attached device
                         *
                         *  \return An error code from the \ref USB_Host_SendControlErrorCodes_t enum if the DeviceUsesOUTPipe flag is set in
                         *          the interface's state structure, a value from the \ref Pipe_Stream_RW_ErrorCodes_t enum otherwise
                         *
                         *  \return An error code from the \ref USB_Host_SendControlErrorCodes_t enum if the DeviceUsesOUTPipe flag is set in
                         *          the interface's state structure, a value from the \ref Pipe_Stream_RW_ErrorCodes_t enum otherwise
index 6630750..e99ddd8 100644 (file)
                 *  leftwards until the data's sign bit is in the correct position.
                 *
                 *  \param[in] reportitem  HID Report Item whose retrieved value is to be aligned
                 *  leftwards until the data's sign bit is in the correct position.
                 *
                 *  \param[in] reportitem  HID Report Item whose retrieved value is to be aligned
-                *  \param[in] type  Data type to align the HID report item's value to
+                *  \param[in] type        Data type to align the HID report item's value to
                 *
                 *  \return Left-aligned data of the given report item's pre-retrived value for the given datatype
                 */
                 *
                 *  \return Left-aligned data of the given report item's pre-retrived value for the given datatype
                 */
                        /** Function to process a given HID report returned from an attached device, and store it into a given
                         *  \ref HID_ReportInfo_t structure.
                         *
                        /** Function to process a given HID report returned from an attached device, and store it into a given
                         *  \ref HID_ReportInfo_t structure.
                         *
-                        *  \param[in] ReportData  Buffer containing the device's HID report table
-                        *  \param[in] ReportSize  Size in bytes of the HID report table
+                        *  \param[in]  ReportData  Buffer containing the device's HID report table
+                        *  \param[in]  ReportSize  Size in bytes of the HID report table
                         *  \param[out] ParserData  Pointer to a \ref HID_ReportInfo_t instance for the parser output
                         *
                         *  \return A value in the \ref HID_Parse_ErrorCodes_t enum
                         *  \param[out] ParserData  Pointer to a \ref HID_ReportInfo_t instance for the parser output
                         *
                         *  \return A value in the \ref HID_Parse_ErrorCodes_t enum
                         *  When called, this copies the report item's Value element to it's PreviousValue element for easy
                         *  checking to see if an item's value has changed before processing a report.
                         *
                         *  When called, this copies the report item's Value element to it's PreviousValue element for easy
                         *  checking to see if an item's value has changed before processing a report.
                         *
-                        *  \param[in] ReportData  Buffer containing an IN or FEATURE report from an attached device
+                        *  \param[in]     ReportData  Buffer containing an IN or FEATURE report from an attached device
                         *  \param[in,out] ReportItem  Pointer to the report item of interest in a \ref HID_ReportInfo_t ReportItem array
                         *
                         *  \returns Boolean true if the item to retrieve was located in the given report, false otherwise
                         *  \param[in,out] ReportItem  Pointer to the report item of interest in a \ref HID_ReportInfo_t ReportItem array
                         *
                         *  \returns Boolean true if the item to retrieve was located in the given report, false otherwise
                         *  If the device has multiple HID reports, the first byte in the report is set to the report ID of the given item.
                         *
                         *  \param[out] ReportData  Buffer holding the current OUT or FEATURE report data
                         *  If the device has multiple HID reports, the first byte in the report is set to the report ID of the given item.
                         *
                         *  \param[out] ReportData  Buffer holding the current OUT or FEATURE report data
-                        *  \param[in] ReportItem  Pointer to the report item of interest in a \ref HID_ReportInfo_t ReportItem array
+                        *  \param[in]  ReportItem  Pointer to the report item of interest in a \ref HID_ReportInfo_t ReportItem array
                         */
                        void USB_SetHIDReportItemInfo(uint8_t* ReportData, HID_ReportItem_t* const ReportItem)
                                                      ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);
                         */
                        void USB_SetHIDReportItemInfo(uint8_t* ReportData, HID_ReportItem_t* const ReportItem)
                                                      ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);
                        /** Retrieves the size of a given HID report in bytes from it's Report ID.
                         *
                         *  \param[in] ParserData  Pointer to a \ref HID_ReportInfo_t instance containing the parser output
                        /** Retrieves the size of a given HID report in bytes from it's Report ID.
                         *
                         *  \param[in] ParserData  Pointer to a \ref HID_ReportInfo_t instance containing the parser output
-                        *  \param[in] ReportID  Report ID of the report whose size is to be retrieved
+                        *  \param[in] ReportID    Report ID of the report whose size is to be retrieved
                         *  \param[in] ReportType  Type of the report whose size is to be determined, a valued from the
                         *                         \ref HID_ReportItemTypes_t enum
                         *
                         *  \param[in] ReportType  Type of the report whose size is to be determined, a valued from the
                         *                         \ref HID_ReportItemTypes_t enum
                         *
index 2ff6c9b..5f38c73 100644 (file)
                         *  This should be called once after the stack has enumerated the attached device, while the host state machine is in
                         *  the Addressed state.
                         *
                         *  This should be called once after the stack has enumerated the attached device, while the host state machine is in
                         *  the Addressed state.
                         *
-                        *  \param[in,out] MIDIInterfaceInfo  Pointer to a structure containing an MIDI Class host configuration and state
-                        *  \param[in] ConfigDescriptorSize  Length of the attached device's Configuration Descriptor
-                        *  \param[in] DeviceConfigDescriptor  Pointer to a buffer containing the attached device's Configuration Descriptor
+                        *  \param[in,out] MIDIInterfaceInfo       Pointer to a structure containing an MIDI Class host configuration and state
+                        *  \param[in]     ConfigDescriptorSize    Length of the attached device's Configuration Descriptor
+                        *  \param[in]     DeviceConfigDescriptor  Pointer to a buffer containing the attached device's Configuration Descriptor
                         *
                         *  \return A value from the \ref MIDIHost_EnumerationFailure_ErrorCodes_t enum
                         */
                         *
                         *  \return A value from the \ref MIDIHost_EnumerationFailure_ErrorCodes_t enum
                         */
                         *        call will fail.
                         *
                         *  \param[in,out] MIDIInterfaceInfo  Pointer to a structure containing a MIDI Class configuration and state
                         *        call will fail.
                         *
                         *  \param[in,out] MIDIInterfaceInfo  Pointer to a structure containing a MIDI Class configuration and state
-                        *  \param[in] Event  Pointer to a populated USB_MIDI_EventPacket_t structure containing the MIDI event to send
+                        *  \param[in]     Event              Pointer to a populated USB_MIDI_EventPacket_t structure containing the MIDI event to send
                         *
                         *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum                       
                         */
                         *
                         *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum                       
                         */
                         *        call will fail.
                         *
                         *  \param[in,out] MIDIInterfaceInfo  Pointer to a structure containing a MIDI Class configuration and state
                         *        call will fail.
                         *
                         *  \param[in,out] MIDIInterfaceInfo  Pointer to a structure containing a MIDI Class configuration and state
-                        *  \param[out] Event  Pointer to a USB_MIDI_EventPacket_t structure where the received MIDI event is to be placed
+                        *  \param[out]    Event              Pointer to a USB_MIDI_EventPacket_t structure where the received MIDI event is to be placed
                         *
                         *  \return Boolean true if a MIDI event packet was received, false otherwise
                         */
                         *
                         *  \return Boolean true if a MIDI event packet was received, false otherwise
                         */
index e4f7415..1759a98 100644 (file)
                         *  is found within the device. This should be called once after the stack has enumerated the attached device, while
                         *  the host state machine is in the Addressed state.
                         *
                         *  is found within the device. This should be called once after the stack has enumerated the attached device, while
                         *  the host state machine is in the Addressed state.
                         *
-                        *  \param[in,out] MSInterfaceInfo  Pointer to a structure containing an MS Class host configuration and state
-                        *  \param[in] ConfigDescriptorSize  Length of the attached device's Configuration Descriptor
-                        *  \param[in] DeviceConfigDescriptor  Pointer to a buffer containing the attached device's Configuration Descriptor
+                        *  \param[in,out] MSInterfaceInfo         Pointer to a structure containing an MS Class host configuration and state
+                        *  \param[in]     ConfigDescriptorSize    Length of the attached device's Configuration Descriptor
+                        *  \param[in]     DeviceConfigDescriptor  Pointer to a buffer containing the attached device's Configuration Descriptor
                         *
                         *  \return A value from the \ref MSHost_EnumerationFailure_ErrorCodes_t enum
                         */
                         *
                         *  \return A value from the \ref MSHost_EnumerationFailure_ErrorCodes_t enum
                         */
                         *        if the device STALLs the request.
                         *
                         *  \param[in,out] MSInterfaceInfo  Pointer to a structure containing a MS Class host configuration and state
                         *        if the device STALLs the request.
                         *
                         *  \param[in,out] MSInterfaceInfo  Pointer to a structure containing a MS Class host configuration and state
-                        *  \param[out] MaxLUNIndex  Pointer to a location where the highest LUN index value should be stored
+                        *  \param[out]    MaxLUNIndex      Pointer to a location where the highest LUN index value should be stored
                         *
                         *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum
                         */
                         *
                         *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum
                         */
                         *        call will fail.
                         *
                         *  \param[in,out] MSInterfaceInfo  Pointer to a structure containing a MS Class host configuration and state
                         *        call will fail.
                         *
                         *  \param[in,out] MSInterfaceInfo  Pointer to a structure containing a MS Class host configuration and state
-                        *  \param[in] LUNIndex  LUN index within the device the command is being issued to
-                        *  \param[out] InquiryData  Location where the read inquiry data should be stored
+                        *  \param[in]     LUNIndex         LUN index within the device the command is being issued to
+                        *  \param[out]    InquiryData      Location where the read inquiry data should be stored
                         *
                         *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum or MS_ERROR_LOGICAL_CMD_FAILED
                         */
                         *
                         *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum or MS_ERROR_LOGICAL_CMD_FAILED
                         */
                        /** Sends a TEST UNIT READY command to the device, to determine if it is ready to accept other SCSI commands.
                         *
                         *  \param[in,out] MSInterfaceInfo  Pointer to a structure containing a MS Class host configuration and state
                        /** Sends a TEST UNIT READY command to the device, to determine if it is ready to accept other SCSI commands.
                         *
                         *  \param[in,out] MSInterfaceInfo  Pointer to a structure containing a MS Class host configuration and state
-                        *  \param[in] LUNIndex  LUN index within the device the command is being issued to
+                        *  \param[in]     LUNIndex         LUN index within the device the command is being issued to
                         *
                         *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum or MS_ERROR_LOGICAL_CMD_FAILED if not ready
                         */
                         *
                         *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum or MS_ERROR_LOGICAL_CMD_FAILED if not ready
                         */
                         *        call will fail.
                         *
                         *  \param[in,out] MSInterfaceInfo  Pointer to a structure containing a MS Class host configuration and state
                         *        call will fail.
                         *
                         *  \param[in,out] MSInterfaceInfo  Pointer to a structure containing a MS Class host configuration and state
-                        *  \param[in] LUNIndex  LUN index within the device the command is being issued to
-                        *  \param[out] DeviceCapacity  Pointer to the location where the capacity information should be stored
+                        *  \param[in]     LUNIndex         LUN index within the device the command is being issued to
+                        *  \param[out]    DeviceCapacity   Pointer to the location where the capacity information should be stored
                         *
                         *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum or MS_ERROR_LOGICAL_CMD_FAILED if not ready
                         */
                         *
                         *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum or MS_ERROR_LOGICAL_CMD_FAILED if not ready
                         */
                         *        call will fail.
                         *
                         *  \param[in,out] MSInterfaceInfo  Pointer to a structure containing a MS Class host configuration and state
                         *        call will fail.
                         *
                         *  \param[in,out] MSInterfaceInfo  Pointer to a structure containing a MS Class host configuration and state
-                        *  \param[in] LUNIndex  LUN index within the device the command is being issued to
-                        *  \param[out] SenseData  Pointer to the location where the sense information should be stored
+                        *  \param[in]     LUNIndex         LUN index within the device the command is being issued to
+                        *  \param[out]    SenseData        Pointer to the location where the sense information should be stored
                         *
                         *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum or MS_ERROR_LOGICAL_CMD_FAILED if not ready
                         */
                         *
                         *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum or MS_ERROR_LOGICAL_CMD_FAILED if not ready
                         */
                         *        call will fail.
                         *
                         *  \param[in,out] MSInterfaceInfo  Pointer to a structure containing a MS Class host configuration and state
                         *        call will fail.
                         *
                         *  \param[in,out] MSInterfaceInfo  Pointer to a structure containing a MS Class host configuration and state
-                        *  \param[in] LUNIndex  LUN index within the device the command is being issued to
-                        *  \param[in] PreventRemoval  Boolean true if the device should be locked from removal, false otherwise
+                        *  \param[in]     LUNIndex         LUN index within the device the command is being issued to
+                        *  \param[in]     PreventRemoval   Boolean true if the device should be locked from removal, false otherwise
                         *
                         *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum or MS_ERROR_LOGICAL_CMD_FAILED if not ready
                         */
                         *
                         *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum or MS_ERROR_LOGICAL_CMD_FAILED if not ready
                         */
                         *        call will fail.
                         *
                         *  \param[in,out] MSInterfaceInfo  Pointer to a structure containing a MS Class host configuration and state
                         *        call will fail.
                         *
                         *  \param[in,out] MSInterfaceInfo  Pointer to a structure containing a MS Class host configuration and state
-                        *  \param[in] LUNIndex  LUN index within the device the command is being issued to
-                        *  \param[in] BlockAddress  Starting block address within the device to read from
-                        *  \param[in] Blocks  Total number of blocks to read
-                        *  \param[in] BlockSize  Size in bytes of each block within the device
-                        *  \param[out] BlockBuffer  Pointer to where the read data from the device should be stored
+                        *  \param[in]     LUNIndex         LUN index within the device the command is being issued to
+                        *  \param[in]     BlockAddress     Starting block address within the device to read from
+                        *  \param[in]     Blocks           Total number of blocks to read
+                        *  \param[in]     BlockSize        Size in bytes of each block within the device
+                        *  \param[out]    BlockBuffer      Pointer to where the read data from the device should be stored
                         *
                         *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum or MS_ERROR_LOGICAL_CMD_FAILED if not ready
                         */
                         *
                         *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum or MS_ERROR_LOGICAL_CMD_FAILED if not ready
                         */
                         *        call will fail.
                         *
                         *  \param[in,out] MSInterfaceInfo  Pointer to a structure containing a MS Class host configuration and state
                         *        call will fail.
                         *
                         *  \param[in,out] MSInterfaceInfo  Pointer to a structure containing a MS Class host configuration and state
-                        *  \param[in] LUNIndex  LUN index within the device the command is being issued to
-                        *  \param[in] BlockAddress  Starting block address within the device to write to
-                        *  \param[in] Blocks  Total number of blocks to read
-                        *  \param[in] BlockSize  Size in bytes of each block within the device
-                        *  \param[in] BlockBuffer  Pointer to where the data to write should be sourced from
+                        *  \param[in]     LUNIndex         LUN index within the device the command is being issued to
+                        *  \param[in]     BlockAddress     Starting block address within the device to write to
+                        *  \param[in]     Blocks           Total number of blocks to read
+                        *  \param[in]     BlockSize        Size in bytes of each block within the device
+                        *  \param[in]     BlockBuffer      Pointer to where the data to write should be sourced from
                         *
                         *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum or MS_ERROR_LOGICAL_CMD_FAILED if not ready
                         */
                         *
                         *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum or MS_ERROR_LOGICAL_CMD_FAILED if not ready
                         */
index aa650ba..c8950e1 100644 (file)
                         *  the device. This should be called once after the stack has enumerated the attached device, while the host state
                         *  machine is in the Addressed state.
                         *
                         *  the device. This should be called once after the stack has enumerated the attached device, while the host state
                         *  machine is in the Addressed state.
                         *
-                        *  \param[in,out] PRNTInterfaceInfo  Pointer to a structure containing a Printer Class host configuration and state
-                        *  \param[in] ConfigDescriptorSize  Length of the attached device's Configuration Descriptor
-                        *  \param[in] DeviceConfigDescriptor  Pointer to a buffer containing the attached device's Configuration Descriptor
+                        *  \param[in,out] PRNTInterfaceInfo       Pointer to a structure containing a Printer Class host configuration and state
+                        *  \param[in]     ConfigDescriptorSize    Length of the attached device's Configuration Descriptor
+                        *  \param[in]     DeviceConfigDescriptor  Pointer to a buffer containing the attached device's Configuration Descriptor
                         *
                         *  \return A value from the \ref PRNTHost_EnumerationFailure_ErrorCodes_t enum
                         */
                         *
                         *  \return A value from the \ref PRNTHost_EnumerationFailure_ErrorCodes_t enum
                         */
                         *  PRNT_PORTSTATUS_* macros to determine the printer port's status.
                         *
                         *  \param[in,out] PRNTInterfaceInfo  Pointer to a structure containing a Printer Class host configuration and state
                         *  PRNT_PORTSTATUS_* macros to determine the printer port's status.
                         *
                         *  \param[in,out] PRNTInterfaceInfo  Pointer to a structure containing a Printer Class host configuration and state
-                        *  \param[out]  PortStatus  Location where the retrieved port status should be stored
+                        *  \param[out]    PortStatus         Location where the retrieved port status should be stored
                         *
                         *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum
                         */
                         *
                         *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum
                         */
                         *        call will fail.
                         *
                         *  \param[in,out] PRNTInterfaceInfo  Pointer to a structure containing a Printer Class host configuration and state
                         *        call will fail.
                         *
                         *  \param[in,out] PRNTInterfaceInfo  Pointer to a structure containing a Printer Class host configuration and state
-                        *  \param[in] PrinterCommands  Pointer to a buffer containing the raw command stream to send to the printer
-                        *  \param[in] CommandSize  Size in bytes of the command stream to be sent
+                        *  \param[in]     PrinterCommands    Pointer to a buffer containing the raw command stream to send to the printer
+                        *  \param[in]     CommandSize        Size in bytes of the command stream to be sent
                         *
                         *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum
                         */
                         *
                         *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum
                         */
                         *  This string, when supported, contains the model, manufacturer and acceptable printer languages for the attached device.
                         *
                         *  \param[in,out] PRNTInterfaceInfo  Pointer to a structure containing a Printer Class host configuration and state
                         *  This string, when supported, contains the model, manufacturer and acceptable printer languages for the attached device.
                         *
                         *  \param[in,out] PRNTInterfaceInfo  Pointer to a structure containing a Printer Class host configuration and state
-                        *  \param[out] DeviceIDString  Pointer to a buffer where the Device ID string should be stored, in ASCII format
-                        *  \param[in] BufferSize  Size in bytes of the buffer allocated for the Device ID string
+                        *  \param[out]    DeviceIDString     Pointer to a buffer where the Device ID string should be stored, in ASCII format
+                        *  \param[in]     BufferSize         Size in bytes of the buffer allocated for the Device ID string
                         *
                         *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum
                         */
                         *
                         *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum
                         */
index feddc72..c7dba71 100644 (file)
                         *  This should be called once after the stack has enumerated the attached device, while the host state machine is in
                         *  the Addressed state.
                         *
                         *  This should be called once after the stack has enumerated the attached device, while the host state machine is in
                         *  the Addressed state.
                         *
-                        *  \param[in,out] RNDISInterfaceInfo  Pointer to a structure containing an RNDIS Class host configuration and state
-                        *  \param[in] ConfigDescriptorSize  Length of the attached device's Configuration Descriptor
-                        *  \param[in] DeviceConfigDescriptor  Pointer to a buffer containing the attached device's Configuration Descriptor
+                        *  \param[in,out] RNDISInterfaceInfo      Pointer to a structure containing an RNDIS Class host configuration and state
+                        *  \param[in]     ConfigDescriptorSize    Length of the attached device's Configuration Descriptor
+                        *  \param[in]     DeviceConfigDescriptor  Pointer to a buffer containing the attached device's Configuration Descriptor
                         *
                         *  \return A value from the \ref RNDISHost_EnumerationFailure_ErrorCodes_t enum
                         */
                         *
                         *  \return A value from the \ref RNDISHost_EnumerationFailure_ErrorCodes_t enum
                         */
                        /** Sets a given RNDIS property of an attached RNDIS device.
                         *
                         *  \param[in,out] RNDISInterfaceInfo  Pointer to a structure containing an RNDIS Class host configuration and state
                        /** Sets a given RNDIS property of an attached RNDIS device.
                         *
                         *  \param[in,out] RNDISInterfaceInfo  Pointer to a structure containing an RNDIS Class host configuration and state
-                        *  \param[in] Oid  OID number of the parameter to set
-                        *  \param[in] Buffer  Pointer to where the property data is to be sourced from
-                        *  \param[in] Length  Length in bytes of the property data to sent to the device
+                        *  \param[in]     Oid                 OID number of the parameter to set
+                        *  \param[in]     Buffer              Pointer to where the property data is to be sourced from
+                        *  \param[in]     Length              Length in bytes of the property data to sent to the device
                         *
                         *  \return A value from the USB_Host_SendControlErrorCodes_t enum or RNDIS_COMMAND_FAILED if the device returned a
                         *          logical command failure
                         *
                         *  \return A value from the USB_Host_SendControlErrorCodes_t enum or RNDIS_COMMAND_FAILED if the device returned a
                         *          logical command failure
                        /** Gets a given RNDIS property of an attached RNDIS device.
                         *
                         *  \param[in,out] RNDISInterfaceInfo  Pointer to a structure containing an RNDIS Class host configuration and state
                        /** Gets a given RNDIS property of an attached RNDIS device.
                         *
                         *  \param[in,out] RNDISInterfaceInfo  Pointer to a structure containing an RNDIS Class host configuration and state
-                        *  \param[in] Oid  OID number of the parameter to get
-                        *  \param[in] Buffer  Pointer to where the property data is to be written to
-                        *  \param[in] MaxLength  Length in bytes of the destination buffer size
+                        *  \param[in]     Oid                 OID number of the parameter to get
+                        *  \param[in]     Buffer              Pointer to where the property data is to be written to
+                        *  \param[in]     MaxLength           Length in bytes of the destination buffer size
                         *
                         *  \return A value from the USB_Host_SendControlErrorCodes_t enum or RNDIS_COMMAND_FAILED if the device returned a
                         *          logical command failure
                         *
                         *  \return A value from the USB_Host_SendControlErrorCodes_t enum or RNDIS_COMMAND_FAILED if the device returned a
                         *          logical command failure
                         *        call will fail.
                         *
                         *  \param[in,out] RNDISInterfaceInfo  Pointer to a structure containing an RNDIS Class host configuration and state
                         *        call will fail.
                         *
                         *  \param[in,out] RNDISInterfaceInfo  Pointer to a structure containing an RNDIS Class host configuration and state
-                        *  \param[out] Buffer  Pointer to a buffer where the packer data is to be written to
-                        *  \param[out] PacketLength  Pointer to where the length in bytes of the read packet is to be stored
+                        *  \param[out]    Buffer              Pointer to a buffer where the packer data is to be written to
+                        *  \param[out]    PacketLength        Pointer to where the length in bytes of the read packet is to be stored
                         *
                         *  \return A value from the Pipe_Stream_RW_ErrorCodes_t enum
                         */
                         *
                         *  \return A value from the Pipe_Stream_RW_ErrorCodes_t enum
                         */
                         *        call will fail.
                         *
                         *  \param[in,out] RNDISInterfaceInfo  Pointer to a structure containing an RNDIS Class host configuration and state
                         *        call will fail.
                         *
                         *  \param[in,out] RNDISInterfaceInfo  Pointer to a structure containing an RNDIS Class host configuration and state
-                        *  \param[in] Buffer  Pointer to a buffer where the packer data is to be read from
-                        *  \param[in] PacketLength  Length in bytes of the packet to send
+                        *  \param[in]     Buffer              Pointer to a buffer where the packer data is to be read from
+                        *  \param[in]     PacketLength        Length in bytes of the packet to send
                         *
                         *  \return A value from the Pipe_Stream_RW_ErrorCodes_t enum
                         */
                         *
                         *  \return A value from the Pipe_Stream_RW_ErrorCodes_t enum
                         */
index 02a3f3a..e8ebec5 100644 (file)
                         *  found within the device. This should be called once after the stack has enumerated the attached device, while
                         *  the host state machine is in the Addressed state.
                         *
                         *  found within the device. This should be called once after the stack has enumerated the attached device, while
                         *  the host state machine is in the Addressed state.
                         *
-                        *  \param[in,out] SIInterfaceInfo  Pointer to a structure containing a Still Image Class host configuration and state
-                        *  \param[in] ConfigDescriptorSize  Length of the attached device's Configuration Descriptor
-                        *  \param[in] DeviceConfigDescriptor  Pointer to a buffer containing the attached device's Configuration Descriptor
+                        *  \param[in,out] SIInterfaceInfo         Pointer to a structure containing a Still Image Class host configuration and state
+                        *  \param[in]     ConfigDescriptorSize    Length of the attached device's Configuration Descriptor
+                        *  \param[in]     DeviceConfigDescriptor  Pointer to a buffer containing the attached device's Configuration Descriptor
                         *
                         *  \return A value from the \ref SIHost_EnumerationFailure_ErrorCodes_t enum
                         */
                         *
                         *  \return A value from the \ref SIHost_EnumerationFailure_ErrorCodes_t enum
                         */
                         *        call will fail.
                         *
                         *  \param[in,out] SIInterfaceInfo  Pointer to a structure containing a Still Image Class host configuration and state
                         *        call will fail.
                         *
                         *  \param[in,out] SIInterfaceInfo  Pointer to a structure containing a Still Image Class host configuration and state
-                        *  \param[in] PIMAHeader  Pointer to a PIMA container structure that is to be sent
+                        *  \param[in]     PIMAHeader       Pointer to a PIMA container structure that is to be sent
                         *
                         *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum
                         */
                         *
                         *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum
                         */
                         *        call will fail.
                         *
                         *  \param[in,out] SIInterfaceInfo  Pointer to a structure containing a Still Image Class host configuration and state
                         *        call will fail.
                         *
                         *  \param[in,out] SIInterfaceInfo  Pointer to a structure containing a Still Image Class host configuration and state
-                        *  \param[out] PIMAHeader  Pointer to a PIMA container structure where the received block is to be stored
+                        *  \param[out]    PIMAHeader       Pointer to a PIMA container structure where the received block is to be stored
                         *
                         *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum
                         */
                         *
                         *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum
                         */
                         *        call will fail.
                         *
                         *  \param[in,out] SIInterfaceInfo  Pointer to a structure containing a Still Image Class host configuration and state
                         *        call will fail.
                         *
                         *  \param[in,out] SIInterfaceInfo  Pointer to a structure containing a Still Image Class host configuration and state
-                        *  \param[in] Operation  PIMA operation code to issue to the device
-                        *  \param[in] TotalParams  Total number of 32-bit parameters to send to the device in the issued command block
-                        *  \param[in] Params  Pointer to an array of 32-bit values containing the parameters to send in the command block
+                        *  \param[in]     Operation        PIMA operation code to issue to the device
+                        *  \param[in]     TotalParams      Total number of 32-bit parameters to send to the device in the issued command block
+                        *  \param[in]     Params           Pointer to an array of 32-bit values containing the parameters to send in the command block
                         *
                         *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum, or \ref SI_ERROR_LOGICAL_CMD_FAILED if the device
                         *          returned a logical command failure
                         *
                         *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum, or \ref SI_ERROR_LOGICAL_CMD_FAILED if the device
                         *          returned a logical command failure
                         *        call will fail.
                         *
                         *  \param[in,out] SIInterfaceInfo  Pointer to a structure containing a Still Image Class host configuration and state
                         *        call will fail.
                         *
                         *  \param[in,out] SIInterfaceInfo  Pointer to a structure containing a Still Image Class host configuration and state
-                        *  \param[out] PIMAHeader  Pointer to a PIMA container structure where the event should be stored
+                        *  \param[out]    PIMAHeader       Pointer to a PIMA container structure where the event should be stored
                         *
                         *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum, or \ref SI_ERROR_LOGICAL_CMD_FAILED if the device
                         *          returned a logical command failure
                         *
                         *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum, or \ref SI_ERROR_LOGICAL_CMD_FAILED if the device
                         *          returned a logical command failure
                         *        call will fail.
                         *
                         *  \param[in,out] SIInterfaceInfo  Pointer to a structure containing a Still Image Class host configuration and state
                         *        call will fail.
                         *
                         *  \param[in,out] SIInterfaceInfo  Pointer to a structure containing a Still Image Class host configuration and state
-                        *  \param[in] Buffer  Pointer to a buffer where the data to send has been stored
-                        *  \param[in] Bytes  Length in bytes of the data in the buffer to send to the attached device
+                        *  \param[in]     Buffer           Pointer to a buffer where the data to send has been stored
+                        *  \param[in]     Bytes            Length in bytes of the data in the buffer to send to the attached device
                         *
                         *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum
                         */
                         *
                         *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum
                         */
                         *        call will fail.
                         *
                         *  \param[in,out] SIInterfaceInfo  Pointer to a structure containing a Still Image Class host configuration and state
                         *        call will fail.
                         *
                         *  \param[in,out] SIInterfaceInfo  Pointer to a structure containing a Still Image Class host configuration and state
-                        *  \param[out] Buffer  Pointer to a buffer where the received data is to be stored
-                        *  \param[in] Bytes  Length in bytes of the data to read
+                        *  \param[out]    Buffer           Pointer to a buffer where the received data is to be stored
+                        *  \param[in]     Bytes            Length in bytes of the data to read
                         *
                         *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum
                         */
                         *
                         *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum
                         */
index 0995533..1bf4aca 100644 (file)
                         *
                         *  \note This function is available in USB Host mode only.
                         *
                         *
                         *  \note This function is available in USB Host mode only.
                         *
-                        *  \param[in,out] BytesRem  Pointer to an int storing the remaining bytes in the configuration descriptor
-                        *  \param[in,out] CurrConfigLoc  Pointer to the current position in the configuration descriptor
-                        *  \param[in] ComparatorRoutine  Name of the comparator search function to use on the configuration descriptor
+                        *  \param[in,out] BytesRem           Pointer to an int storing the remaining bytes in the configuration descriptor
+                        *  \param[in,out] CurrConfigLoc      Pointer to the current position in the configuration descriptor
+                        *  \param[in]     ComparatorRoutine  Name of the comparator search function to use on the configuration descriptor
                         *
                         *  \return Value of one of the members of the \ref DSearch_Comp_Return_ErrorCodes_t enum
                         *
                         *
                         *  \return Value of one of the members of the \ref DSearch_Comp_Return_ErrorCodes_t enum
                         *
                        /** Retrieves the configuration descriptor data from an attached device via a standard request into a buffer,
                         *  including validity and size checking to prevent a buffer overflow.
                         *
                        /** Retrieves the configuration descriptor data from an attached device via a standard request into a buffer,
                         *  including validity and size checking to prevent a buffer overflow.
                         *
-                        *  \param[in] ConfigNumber  Device configuration descriptor number to fetch from the device (usually set to 1 for
-                        *                           single configuration devices)
+                        *  \param[in]     ConfigNumber   Device configuration descriptor number to fetch from the device (usually set to 1 for
+                        *                                single configuration devices)
                         *  \param[in,out] ConfigSizePtr  Pointer to a uint16_t for storing the retrieved configuration descriptor size
                         *  \param[in,out] ConfigSizePtr  Pointer to a uint16_t for storing the retrieved configuration descriptor size
-                        *  \param[out] BufferPtr  Pointer to the buffer for storing the configuration descriptor data.
-                        *  \param[out] BufferSize  Size of the allocated buffer where the configuration descriptor is to be stored
+                        *  \param[out]    BufferPtr      Pointer to the buffer for storing the configuration descriptor data.
+                        *  \param[out]    BufferSize     Size of the allocated buffer where the configuration descriptor is to be stored
                         *
                         *  \return A value from the \ref USB_Host_GetConfigDescriptor_ErrorCodes_t enum
                         */
                         *
                         *  \return A value from the \ref USB_Host_GetConfigDescriptor_ErrorCodes_t enum
                         */
                        /** Skips to the next sub-descriptor inside the configuration descriptor of the specified type value.
                         *  The bytes remaining value is automatically decremented.
                         *
                        /** Skips to the next sub-descriptor inside the configuration descriptor of the specified type value.
                         *  The bytes remaining value is automatically decremented.
                         *
-                        * \param[in,out] BytesRem  Pointer to the number of bytes remaining of the configuration descriptor
+                        * \param[in,out] BytesRem       Pointer to the number of bytes remaining of the configuration descriptor
                         * \param[in,out] CurrConfigLoc  Pointer to the current descriptor inside the configuration descriptor
                         * \param[in,out] CurrConfigLoc  Pointer to the current descriptor inside the configuration descriptor
-                        * \param[in] Type  Descriptor type value to search for
+                        * \param[in]     Type           Descriptor type value to search for
                         */
                        void USB_GetNextDescriptorOfType(uint16_t* const BytesRem,
                                                         void** const CurrConfigLoc,
                         */
                        void USB_GetNextDescriptorOfType(uint16_t* const BytesRem,
                                                         void** const CurrConfigLoc,
                         *  descriptor is reached first, the number of bytes remaining to process is set to zero and the
                         *  function exits. The bytes remaining value is automatically decremented.
                         *
                         *  descriptor is reached first, the number of bytes remaining to process is set to zero and the
                         *  function exits. The bytes remaining value is automatically decremented.
                         *
-                        * \param[in,out] BytesRem  Pointer to the number of bytes remaining of the configuration descriptor
+                        * \param[in,out] BytesRem       Pointer to the number of bytes remaining of the configuration descriptor
                         * \param[in,out] CurrConfigLoc  Pointer to the current descriptor inside the configuration descriptor
                         * \param[in,out] CurrConfigLoc  Pointer to the current descriptor inside the configuration descriptor
-                        * \param[in] Type  Descriptor type value to search for
-                        * \param[in] BeforeType  Descriptor type value which must not be reached before the given Type descriptor
+                        * \param[in]     Type           Descriptor type value to search for
+                        * \param[in]     BeforeType     Descriptor type value which must not be reached before the given Type descriptor
                         */
                        void USB_GetNextDescriptorOfTypeBefore(uint16_t* const BytesRem,
                                                               void** const CurrConfigLoc,
                         */
                        void USB_GetNextDescriptorOfTypeBefore(uint16_t* const BytesRem,
                                                               void** const CurrConfigLoc,
                         *  which must come after a descriptor of the second given type value. The bytes remaining value is
                         *  automatically decremented.
                         *
                         *  which must come after a descriptor of the second given type value. The bytes remaining value is
                         *  automatically decremented.
                         *
-                        * \param[in,out] BytesRem  Pointer to the number of bytes remaining of the configuration descriptor
+                        * \param[in,out] BytesRem       Pointer to the number of bytes remaining of the configuration descriptor
                         * \param[in,out] CurrConfigLoc  Pointer to the current descriptor inside the configuration descriptor
                         * \param[in,out] CurrConfigLoc  Pointer to the current descriptor inside the configuration descriptor
-                        * \param[in] Type  Descriptor type value to search for
-                        * \param[in] AfterType  Descriptor type value which must be reached before the given Type descriptor
+                        * \param[in]     Type           Descriptor type value to search for
+                        * \param[in]     AfterType      Descriptor type value which must be reached before the given Type descriptor
                         */
                        void USB_GetNextDescriptorOfTypeAfter(uint16_t* const BytesRem,
                                                              void** const CurrConfigLoc,
                         */
                        void USB_GetNextDescriptorOfTypeAfter(uint16_t* const BytesRem,
                                                              void** const CurrConfigLoc,
                        /** Skips over the current sub-descriptor inside the configuration descriptor, so that the pointer then
                            points to the next sub-descriptor. The bytes remaining value is automatically decremented.
                         *
                        /** Skips over the current sub-descriptor inside the configuration descriptor, so that the pointer then
                            points to the next sub-descriptor. The bytes remaining value is automatically decremented.
                         *
-                        * \param[in,out] BytesRem  Pointer to the number of bytes remaining of the configuration descriptor
+                        * \param[in,out] BytesRem       Pointer to the number of bytes remaining of the configuration descriptor
                         * \param[in,out] CurrConfigLoc  Pointer to the current descriptor inside the configuration descriptor
                         */
                        static inline void USB_GetNextDescriptor(uint16_t* const BytesRem,
                         * \param[in,out] CurrConfigLoc  Pointer to the current descriptor inside the configuration descriptor
                         */
                        static inline void USB_GetNextDescriptor(uint16_t* const BytesRem,
index edc7a8b..e8984a4 100644 (file)
                        /** Event for USB device enumeration failure. This event fires when a the USB interface is
                         *  in host mode, and an attached USB device has failed to enumerate completely.
                         *
                        /** Event for USB device enumeration failure. This event fires when a the USB interface is
                         *  in host mode, and an attached USB device has failed to enumerate completely.
                         *
-                        *  \param[in] ErrorCode  Error code indicating the failure reason, a value in 
-                        *                        \ref USB_Host_EnumerationErrorCodes_t
+                        *  \param[in] ErrorCode     Error code indicating the failure reason, a value in 
+                        *                           \ref USB_Host_EnumerationErrorCodes_t
                         *
                         *  \param[in] SubErrorCode  Sub error code indicating the reason for failure - for example, if the
                         *                           ErrorCode parameter indicates a control error, this will give the error
                         *
                         *  \param[in] SubErrorCode  Sub error code indicating the reason for failure - for example, if the
                         *                           ErrorCode parameter indicates a control error, this will give the error
index d8e7739..7f9d540 100644 (file)
                         *  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 wValue type indicates 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 USE_*_DESCRIPTORS compile time options is used.
+                        *  \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 wValue type indicates 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 USE_*_DESCRIPTORS compile time options is used.
                         *
                         *  \note By default, the library expects all descriptors to be located in flash memory via the 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 PROGMEM attribute.
                         *        If descriptors should be located in RAM or EEPROM instead (to speed up access in the case of RAM, or to
index 68413b8..760a377 100644 (file)
                         *  \ingroup Group_EndpointStreamRW
                         *
                         *  \param[out] Buffer  Pointer to the destination data buffer to write to.
                         *  \ingroup Group_EndpointStreamRW
                         *
                         *  \param[out] Buffer  Pointer to the destination data buffer to write to.
-                        *  \param[in] Length  Number of bytes to send via the currently selected endpoint.
+                        *  \param[in]  Length  Number of bytes to send via the currently selected endpoint.
                         *
                         *  \return A value from the \ref Endpoint_ControlStream_RW_ErrorCodes_t enum.
                         */
                         *
                         *  \return A value from the \ref Endpoint_ControlStream_RW_ErrorCodes_t enum.
                         */
                         *  \ingroup Group_EndpointStreamRW
                         *
                         *  \param[out] Buffer  Pointer to the destination data buffer to write to.
                         *  \ingroup Group_EndpointStreamRW
                         *
                         *  \param[out] Buffer  Pointer to the destination data buffer to write to.
-                        *  \param[in] Length  Number of bytes to send via the currently selected endpoint.
+                        *  \param[in]  Length  Number of bytes to send via the currently selected endpoint.
                         *
                         *  \return A value from the \ref Endpoint_ControlStream_RW_ErrorCodes_t enum.
                         */
                         *
                         *  \return A value from the \ref Endpoint_ControlStream_RW_ErrorCodes_t enum.
                         */
                         *  \ingroup Group_EndpointStreamRW
                         *
                         *  \param[out] Buffer  Pointer to the destination data buffer to write to.
                         *  \ingroup Group_EndpointStreamRW
                         *
                         *  \param[out] Buffer  Pointer to the destination data buffer to write to.
-                        *  \param[in] Length  Number of bytes to send via the currently selected endpoint.
+                        *  \param[in]  Length  Number of bytes to send via the currently selected endpoint.
                         *
                         *  \return A value from the \ref Endpoint_ControlStream_RW_ErrorCodes_t enum.
                         */
                         *
                         *  \return A value from the \ref Endpoint_ControlStream_RW_ErrorCodes_t enum.
                         */
                         *  \ingroup Group_EndpointStreamRW
                         *
                         *  \param[out] Buffer  Pointer to the destination data buffer to write to.
                         *  \ingroup Group_EndpointStreamRW
                         *
                         *  \param[out] Buffer  Pointer to the destination data buffer to write to.
-                        *  \param[in] Length  Number of bytes to send via the currently selected endpoint.
+                        *  \param[in]  Length  Number of bytes to send via the currently selected endpoint.
                         *
                         *  \return A value from the \ref Endpoint_ControlStream_RW_ErrorCodes_t enum.
                         */
                         *
                         *  \return A value from the \ref Endpoint_ControlStream_RW_ErrorCodes_t enum.
                         */
index 1ef0239..fef6b43 100644 (file)
                         *
                         *  \note After this routine returns, the control pipe will be selected.
                         *
                         *
                         *  \note After this routine returns, the control pipe will be selected.
                         *
-                        *  \param[in] Index  Index of the string index to retrieve
-                        *  \param[out] Buffer  Pointer to the destination buffer where the retrieved string decriptor is
-                        *                      to be stored
+                        *  \param[in]  Index        Index of the string index to retrieve
+                        *  \param[out] Buffer       Pointer to the destination buffer where the retrieved string decriptor is
+                        *                           to be stored
                         *  \param[in] BufferLength  Maximum size of the string descriptor which can be stored into the buffer
                         *
                         *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum to indicate the result.
                         *  \param[in] BufferLength  Maximum size of the string descriptor which can be stored into the buffer
                         *
                         *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum to indicate the result.
index 02f882d..b4b40ca 100644 (file)
                         *
                         *  \ingroup Group_PipeStreamRW
                         *
                         *
                         *  \ingroup Group_PipeStreamRW
                         *
-                        *  \param[in] Length  Number of bytes to send via the currently selected pipe.
+                        *  \param[in] Length    Number of bytes to send via the currently selected pipe.
                         *  \param[in] Callback  Name of a callback routine to call between successive USB packet transfers, NULL if no callback
                         *
                         *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.
                         *  \param[in] Callback  Name of a callback routine to call between successive USB packet transfers, NULL if no callback
                         *
                         *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.
                         *
                         *  \ingroup Group_PipeStreamRW
                         *
                         *
                         *  \ingroup Group_PipeStreamRW
                         *
-                        *  \param[out] Buffer   Pointer to the source data buffer to write to.
-                        *  \param[in] Length    Number of bytes to read for the currently selected pipe to read from.
-                        *  \param[in] Callback  Name of a callback routine to call between successive USB packet transfers, NULL if no callback
+                        *  \param[out] Buffer    Pointer to the source data buffer to write to.
+                        *  \param[in]  Length    Number of bytes to read for the currently selected pipe to read from.
+                        *  \param[in]  Callback  Name of a callback routine to call between successive USB packet transfers, NULL if no callback
                         *
                         *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.
                         */
                         *
                         *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.
                         */
                         *
                         *  \ingroup Group_PipeStreamRW
                         *
                         *
                         *  \ingroup Group_PipeStreamRW
                         *
-                        *  \param[out] Buffer   Pointer to the source data buffer to write to.
-                        *  \param[in] Length    Number of bytes to read for the currently selected pipe to read from.
-                        *  \param[in] Callback  Name of a callback routine to call between successive USB packet transfers, NULL if no callback
+                        *  \param[out] Buffer    Pointer to the source data buffer to write to.
+                        *  \param[in]  Length    Number of bytes to read for the currently selected pipe to read from.
+                        *  \param[in]  Callback  Name of a callback routine to call between successive USB packet transfers, NULL if no callback
                         *
                         *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.
                         */
                         *
                         *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.
                         */
                         *
                         *  \ingroup Group_PipeStreamRW
                         *
                         *
                         *  \ingroup Group_PipeStreamRW
                         *
-                        *  \param[out] Buffer   Pointer to the source data buffer to write to.
-                        *  \param[in] Length    Number of bytes to read for the currently selected pipe to read from.
-                        *  \param[in] Callback  Name of a callback routine to call between successive USB packet transfers, NULL if no callback
+                        *  \param[out] Buffer    Pointer to the source data buffer to write to.
+                        *  \param[in]  Length    Number of bytes to read for the currently selected pipe to read from.
+                        *  \param[in]  Callback  Name of a callback routine to call between successive USB packet transfers, NULL if no callback
                         *
                         *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.
                         */
                         *
                         *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.
                         */
                         *
                         *  \ingroup Group_PipeStreamRW
                         *
                         *
                         *  \ingroup Group_PipeStreamRW
                         *
-                        *  \param[out] Buffer   Pointer to the source data buffer to write to.
-                        *  \param[in] Length    Number of bytes to read for the currently selected pipe to read from.
-                        *  \param[in] Callback  Name of a callback routine to call between successive USB packet transfers, NULL if no callback
+                        *  \param[out] Buffer    Pointer to the source data buffer to write to.
+                        *  \param[in]  Length    Number of bytes to read for the currently selected pipe to read from.
+                        *  \param[in]  Callback  Name of a callback routine to call between successive USB packet transfers, NULL if no callback
                         *
                         *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.
                         */
                         *
                         *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum.
                         */