diff options
| author | Dean <Dean@d5102386-fcda-11dd-9fdb-3debd5008f28> | 2011-01-08 11:47:20 +0000 |
|---|---|---|
| committer | Dean <Dean@d5102386-fcda-11dd-9fdb-3debd5008f28> | 2011-01-08 11:47:20 +0000 |
| commit | d625bb9c89f42ac7890d8d3ce80278391e28e9e7 (patch) | |
| tree | 059fabcc52c5b6fae0d49e7a59795261fcc7bdcc /LUFA/Drivers/USB/Class/Device/CDC.h | |
| parent | 306cc375ec4287f585e46cd43a01bc6b3211612c (diff) | |
Minor documentation improvements.
git-svn-id: http://lufa-lib.googlecode.com/svn/trunk@1626 d5102386-fcda-11dd-9fdb-3debd5008f28
Diffstat (limited to 'LUFA/Drivers/USB/Class/Device/CDC.h')
| -rw-r--r-- | LUFA/Drivers/USB/Class/Device/CDC.h | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/LUFA/Drivers/USB/Class/Device/CDC.h b/LUFA/Drivers/USB/Class/Device/CDC.h index dbd5b023..8d8176be 100644 --- a/LUFA/Drivers/USB/Class/Device/CDC.h +++ b/LUFA/Drivers/USB/Class/Device/CDC.h @@ -123,10 +123,10 @@ { struct { - uint8_t HostToDevice; /**< Control line states from the host to device, as a set of CDC_CONTROL_LINE_OUT_* + uint8_t HostToDevice; /**< Control line states from the host to device, as a set of \c CDC_CONTROL_LINE_OUT_* * masks. This value is updated each time \ref CDC_Device_USBTask() is called. */ - uint8_t DeviceToHost; /**< Control line states from the device to host, as a set of CDC_CONTROL_LINE_IN_* + uint8_t DeviceToHost; /**< Control line states from the device to host, as a set of \c CDC_CONTROL_LINE_IN_* * masks - to notify the host of changes to these values, call the * \ref CDC_Device_SendControlLineStateChange() function. */ @@ -152,7 +152,7 @@ * * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state. * - * \return Boolean true if the endpoints were successfully configured, false otherwise. + * \return Boolean \c true if the endpoints were successfully configured, \c false otherwise. */ bool CDC_Device_ConfigureEndpoints(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1); @@ -319,7 +319,7 @@ static int CDC_Device_getchar(FILE* Stream) ATTR_NON_NULL_PTR_ARG(1); static int CDC_Device_getchar_Blocking(FILE* Stream) ATTR_NON_NULL_PTR_ARG(1); - void CDC_Device_Event_Stub(void); + void CDC_Device_Event_Stub(void) ATTR_CONST; void EVENT_CDC_Device_LineEncodingChanged(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo) ATTR_WEAK ATTR_NON_NULL_PTR_ARG(1) ATTR_ALIAS(CDC_Device_Event_Stub); void EVENT_CDC_Device_ControLineStateChanged(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo) |