diff options
author | Dean Camera <dean@fourwalledcubicle.com> | 2013-03-18 19:24:55 +0000 |
---|---|---|
committer | Dean Camera <dean@fourwalledcubicle.com> | 2013-03-18 19:24:55 +0000 |
commit | 03cdb09071c5c9ed9dd0f851a0980d360a4492d0 (patch) | |
tree | 26aca239e281055455d88b9d44a8a1c52b97beb1 /LUFA | |
parent | 88bcc6fde546f12a31f46b5c8b77631b0c648638 (diff) | |
download | lufa-03cdb09071c5c9ed9dd0f851a0980d360a4492d0.tar.gz lufa-03cdb09071c5c9ed9dd0f851a0980d360a4492d0.tar.bz2 lufa-03cdb09071c5c9ed9dd0f851a0980d360a4492d0.zip |
Minor documentation improvements.
Diffstat (limited to 'LUFA')
-rw-r--r-- | LUFA/Common/CompilerSpecific.h | 2 | ||||
-rw-r--r-- | LUFA/Drivers/Misc/RingBuffer.h | 4 | ||||
-rw-r--r-- | LUFA/Drivers/Peripheral/AVR8/ADC_AVR8.h | 2 | ||||
-rw-r--r-- | LUFA/Drivers/USB/Class/Host/AudioClassHost.h | 2 | ||||
-rw-r--r-- | LUFA/Drivers/USB/Core/AVR8/Endpoint_AVR8.h | 2 | ||||
-rw-r--r-- | LUFA/Drivers/USB/Core/AVR8/Host_AVR8.h | 2 | ||||
-rw-r--r-- | LUFA/Drivers/USB/Core/UC3/Endpoint_UC3.h | 2 | ||||
-rw-r--r-- | LUFA/Drivers/USB/Core/UC3/Host_UC3.h | 2 | ||||
-rw-r--r-- | LUFA/Drivers/USB/Core/XMEGA/Endpoint_XMEGA.h | 2 |
9 files changed, 10 insertions, 10 deletions
diff --git a/LUFA/Common/CompilerSpecific.h b/LUFA/Common/CompilerSpecific.h index d3d7caa7e..b2818fa41 100644 --- a/LUFA/Common/CompilerSpecific.h +++ b/LUFA/Common/CompilerSpecific.h @@ -82,7 +82,7 @@ * * \param[in] x Value to check compile-time constantness of. * - * \return Boolean true if the given value is known to be a compile time constant, false otherwise. + * \return Boolean \c true if the given value is known to be a compile time constant, \c false otherwise. */ #define GCC_IS_COMPILE_CONST(x) __builtin_constant_p(x) #else diff --git a/LUFA/Drivers/Misc/RingBuffer.h b/LUFA/Drivers/Misc/RingBuffer.h index 07ae0cd12..0ab3e33ab 100644 --- a/LUFA/Drivers/Misc/RingBuffer.h +++ b/LUFA/Drivers/Misc/RingBuffer.h @@ -204,7 +204,7 @@ * * \param[in,out] Buffer Pointer to a ring buffer structure to insert into. * - * \return Boolean \c true if the buffer contains no free space, false otherwise. + * \return Boolean \c true if the buffer contains no free space, \c false otherwise. */ static inline bool RingBuffer_IsEmpty(RingBuffer_t* const Buffer) ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(1); static inline bool RingBuffer_IsEmpty(RingBuffer_t* const Buffer) @@ -218,7 +218,7 @@ * * \param[in,out] Buffer Pointer to a ring buffer structure to insert into. * - * \return Boolean \c true if the buffer contains no free space, false otherwise. + * \return Boolean \c true if the buffer contains no free space, \c false otherwise. */ static inline bool RingBuffer_IsFull(RingBuffer_t* const Buffer) ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(1); static inline bool RingBuffer_IsFull(RingBuffer_t* const Buffer) diff --git a/LUFA/Drivers/Peripheral/AVR8/ADC_AVR8.h b/LUFA/Drivers/Peripheral/AVR8/ADC_AVR8.h index 474f57087..1c3b60a51 100644 --- a/LUFA/Drivers/Peripheral/AVR8/ADC_AVR8.h +++ b/LUFA/Drivers/Peripheral/AVR8/ADC_AVR8.h @@ -369,7 +369,7 @@ /** Indicates if the current ADC conversion is completed, or still in progress. * - * \return Boolean false if the reading is still taking place, or true if the conversion is + * \return Boolean \c false if the reading is still taking place, or true if the conversion is * complete and ready to be read out with \ref ADC_GetResult(). */ static inline bool ADC_IsReadingComplete(void) ATTR_WARN_UNUSED_RESULT ATTR_ALWAYS_INLINE; diff --git a/LUFA/Drivers/USB/Class/Host/AudioClassHost.h b/LUFA/Drivers/USB/Class/Host/AudioClassHost.h index b58e5ba9a..a501868b9 100644 --- a/LUFA/Drivers/USB/Class/Host/AudioClassHost.h +++ b/LUFA/Drivers/USB/Class/Host/AudioClassHost.h @@ -131,7 +131,7 @@ * send and/or received. * * \param[in,out] AudioInterfaceInfo Pointer to a structure containing an Audio Class host configuration and state. - * \param[in] EnableStreaming Boolean true to enable streaming of the specified interface, false to disable + * \param[in] EnableStreaming Boolean true to enable streaming of the specified interface, \c false to disable * * \return A value from the \ref USB_Host_SendControlErrorCodes_t enum. */ diff --git a/LUFA/Drivers/USB/Core/AVR8/Endpoint_AVR8.h b/LUFA/Drivers/USB/Core/AVR8/Endpoint_AVR8.h index 985bc8090..7eaabae93 100644 --- a/LUFA/Drivers/USB/Core/AVR8/Endpoint_AVR8.h +++ b/LUFA/Drivers/USB/Core/AVR8/Endpoint_AVR8.h @@ -501,7 +501,7 @@ UECONX |= (1 << STALLRQC); } - /** Determines if the currently selected endpoint is stalled, false otherwise. + /** Determines if the currently selected endpoint is stalled, \c false otherwise. * * \ingroup Group_EndpointPacketManagement_AVR8 * diff --git a/LUFA/Drivers/USB/Core/AVR8/Host_AVR8.h b/LUFA/Drivers/USB/Core/AVR8/Host_AVR8.h index 07f3f3faf..4f7f0242a 100644 --- a/LUFA/Drivers/USB/Core/AVR8/Host_AVR8.h +++ b/LUFA/Drivers/USB/Core/AVR8/Host_AVR8.h @@ -236,7 +236,7 @@ } /** Determines if the attached device is currently issuing a Remote Wakeup request, requesting - * that the host resume the USB bus and wake up the device, false otherwise. + * that the host resume the USB bus and wake up the device, \c false otherwise. * * \return Boolean \c true if the attached device has sent a Remote Wakeup request, \c false otherwise. */ diff --git a/LUFA/Drivers/USB/Core/UC3/Endpoint_UC3.h b/LUFA/Drivers/USB/Core/UC3/Endpoint_UC3.h index a812c38c8..bcf6b64a5 100644 --- a/LUFA/Drivers/USB/Core/UC3/Endpoint_UC3.h +++ b/LUFA/Drivers/USB/Core/UC3/Endpoint_UC3.h @@ -501,7 +501,7 @@ (&AVR32_USBB.UECON0CLR)[USB_Endpoint_SelectedEndpoint].stallrqc = true; } - /** Determines if the currently selected endpoint is stalled, false otherwise. + /** Determines if the currently selected endpoint is stalled, \c false otherwise. * * \ingroup Group_EndpointPacketManagement_UC3 * diff --git a/LUFA/Drivers/USB/Core/UC3/Host_UC3.h b/LUFA/Drivers/USB/Core/UC3/Host_UC3.h index 0359e23bf..19169cea4 100644 --- a/LUFA/Drivers/USB/Core/UC3/Host_UC3.h +++ b/LUFA/Drivers/USB/Core/UC3/Host_UC3.h @@ -233,7 +233,7 @@ } /** Determines if the attached device is currently issuing a Remote Wakeup request, requesting - * that the host resume the USB bus and wake up the device, false otherwise. + * that the host resume the USB bus and wake up the device, \c false otherwise. * * \return Boolean \c true if the attached device has sent a Remote Wakeup request, \c false otherwise. */ diff --git a/LUFA/Drivers/USB/Core/XMEGA/Endpoint_XMEGA.h b/LUFA/Drivers/USB/Core/XMEGA/Endpoint_XMEGA.h index 916976b0d..184823c68 100644 --- a/LUFA/Drivers/USB/Core/XMEGA/Endpoint_XMEGA.h +++ b/LUFA/Drivers/USB/Core/XMEGA/Endpoint_XMEGA.h @@ -495,7 +495,7 @@ USB_Endpoint_SelectedHandle->CTRL &= ~USB_EP_STALL_bm; } - /** Determines if the currently selected endpoint is stalled, false otherwise. + /** Determines if the currently selected endpoint is stalled, \c false otherwise. * * \ingroup Group_EndpointPacketManagement_XMEGA * |