diff options
Diffstat (limited to 'Projects/Magstripe')
| -rw-r--r-- | Projects/Magstripe/Lib/CircularBitBuffer.h | 8 | ||||
| -rw-r--r-- | Projects/Magstripe/Magstripe.c | 14 |
2 files changed, 11 insertions, 11 deletions
diff --git a/Projects/Magstripe/Lib/CircularBitBuffer.h b/Projects/Magstripe/Lib/CircularBitBuffer.h index 6f1fa1508..ffbdc86c6 100644 --- a/Projects/Magstripe/Lib/CircularBitBuffer.h +++ b/Projects/Magstripe/Lib/CircularBitBuffer.h @@ -73,20 +73,20 @@ /* Function Prototypes: */
/** Initializes or resets a given bit buffer, ready to store new bits.
*
- * \param Buffer Bit buffer to initialize
+ * \param[in,out] Buffer Bit buffer to initialize
*/
void BitBuffer_Init(BitBuffer_t* Buffer) ATTR_NON_NULL_PTR_ARG(1);
/** Stores a bit into the next location inside a given bit buffer.
*
- * \param Buffer Bit buffer to store a bit into
- * \param Bit Bit to store into the buffer
+ * \param[in,out] Buffer Bit buffer to store a bit into
+ * \param[in] Bit Bit to store into the buffer
*/
void BitBuffer_StoreNextBit(BitBuffer_t* Buffer, bool Bit) ATTR_NON_NULL_PTR_ARG(1);
/** Retrieves a bit from the next location inside a given bit buffer.
*
- * \param Buffer Bit buffer to store a bit into
+ * \param[in,out] Buffer Bit buffer to store a bit into
*
* \return Next bit from the buffer
*/
diff --git a/Projects/Magstripe/Magstripe.c b/Projects/Magstripe/Magstripe.c index 1963973b4..ec2313c04 100644 --- a/Projects/Magstripe/Magstripe.c +++ b/Projects/Magstripe/Magstripe.c @@ -160,9 +160,9 @@ ISR(TIMER0_COMPA_vect, ISR_BLOCK) /** HID Class driver callback function for the creation of a HID report for the host.
*
- * \param HIDInterfaceInfo Pointer to the HID interface structure for the HID interface being referenced
- * \param ReportID Report ID requested by the host if non-zero, otherwise callback should set to the generated report ID
- * \param ReportData Pointer to the preallocated report buffer where the created report should be stored
+ * \param[in] HIDInterfaceInfo Pointer to the HID interface structure for the HID interface being referenced
+ * \param[in,out] ReportID Report ID requested by the host if non-zero, otherwise callback should set to the generated report ID
+ * \param[out] ReportData Pointer to the preallocated report buffer where the created report should be stored
*
* \return Number of bytes in the created report
*/
@@ -209,10 +209,10 @@ uint16_t CALLBACK_HID_Device_CreateHIDReport(USB_ClassInfo_HID_Device_t* HIDInte /** HID Class driver callback function for the processing of a received HID report from the host.
*
- * \param HIDInterfaceInfo Pointer to the HID interface structure for the HID interface being referenced
- * \param ReportID Report ID of the received report from the host
- * \param ReportData Pointer to the report buffer where the received report is stored
- * \param ReportSize Size in bytes of the report received from the host
+ * \param[in] HIDInterfaceInfo Pointer to the HID interface structure for the HID interface being referenced
+ * \param[in] ReportID Report ID of the received report from the host
+ * \param[in] ReportData Pointer to the report buffer where the received report is stored
+ * \param[in] ReportSize Size in bytes of the report received from the host
*/
void CALLBACK_HID_Device_ProcessHIDReport(USB_ClassInfo_HID_Device_t* HIDInterfaceInfo, uint8_t ReportID,
void* ReportData, uint16_t ReportSize)
|