ahoneybun/qmk_firmware
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Minor documentation improvements.

Browse source
This commit is contained in:
Dean Camera 2013-03-18 19:24:55 +00:00
parent 88bcc6fde5
commit 03cdb09071
65 changed files with 126 additions and 126 deletions
Download patch file Download diff file Expand all files Collapse all files

2
LUFA/Common/CompilerSpecific.h
View file

@ -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

4
LUFA/Drivers/Misc/RingBuffer.h
View file

@ -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)

2
LUFA/Drivers/Peripheral/AVR8/ADC_AVR8.h
View file

@ -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;

2
LUFA/Drivers/USB/Class/Host/AudioClassHost.h
View file

@ -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.
*/

2
LUFA/Drivers/USB/Core/AVR8/Endpoint_AVR8.h
View file

@ -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
*

2
LUFA/Drivers/USB/Core/AVR8/Host_AVR8.h
View file

@ -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.
*/

2
LUFA/Drivers/USB/Core/UC3/Endpoint_UC3.h
View file

@ -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
*

2
LUFA/Drivers/USB/Core/UC3/Host_UC3.h
View file

@ -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.
*/

2
LUFA/Drivers/USB/Core/XMEGA/Endpoint_XMEGA.h
View file

@ -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
*