gitbot/qmk_firmware
0
0
Fork 0
mirror of https://github.com/qmk/qmk_firmware.git synced 2025-07-16 21:01:31 +00:00
Code Issues Packages Projects Releases Wiki Activity

Minor documentation improvements.

Browse Source
This commit is contained in:
Dean Camera 2012-02-12 20:39:57 +00:00
parent 09d2be0dc1
commit 5051df08d7
7 changed files with 45 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
LUFA/DoxygenPages/Groups.txt
View File

@ -4,22 +4,40 @@
* documentation pages. It is not a project source file. * documentation pages. It is not a project source file.
*/ */
/** @defgroup Group_BoardDrivers Board Drivers /** \defgroup Group_BoardDrivers Board Drivers
* *
* Functions, macros, variables, enums and types related to the control of physical board hardware. * Functions, macros, variables, enums and types related to the control of physical board hardware.
*/ */
/** @defgroup Group_PeripheralDrivers On-chip Peripheral Drivers /** \defgroup Group_PeripheralDrivers On-chip Peripheral Drivers
* *
* Functions, macros, variables, enums and types related to the control of AVR subsystems. * Functions, macros, variables, enums and types related to the control of AVR subsystems.
*/ */
/** @defgroup Group_MiscDrivers Miscellaneous Drivers /** \defgroup Group_MiscDrivers Miscellaneous Drivers
* *
* Miscellaneous driver Functions, macros, variables, enums and types. * Miscellaneous driver Functions, macros, variables, enums and types.
*/ */
/** @defgroup Group_PlatformDrivers System Platform Drivers /** \defgroup Group_PlatformDrivers System Platform Drivers
* *
* Drivers relating to the general architecture platform, such as clock setup and interrupt management. * Drivers relating to the general architecture platform, such as clock setup and interrupt management.
*/ */
/** \defgroup Group_PlatformDrivers_AVR8 AVR8
* \ingroup Group_PlatformDrivers
*
* Drivers relating to the AVR8 architecture platform, such as clock setup and interrupt management.
*/
/** \defgroup Group_PlatformDrivers_XMEGA XMEGA
* \ingroup Group_PlatformDrivers
*
* Drivers relating to the XMEGA architecture platform, such as clock setup and interrupt management.
*/
/** \defgroup Group_PlatformDrivers_UC3 UC3
* \ingroup Group_PlatformDrivers
*
* Drivers relating to the UC3 architecture platform, such as clock setup and interrupt management.
*/

2
LUFA/Drivers/Peripheral/AVR8/Serial_AVR8.h
View File

@ -43,7 +43,7 @@
* \section Sec_ModDescription Module Description * \section Sec_ModDescription Module Description
* On-chip serial USART driver for the 8-bit AVR microcontrollers. * On-chip serial USART driver for the 8-bit AVR microcontrollers.
* *
* \note This file should not be included directly. It is automatically included as needed by the ADC driver * \note This file should not be included directly. It is automatically included as needed by the USART driver
* dispatch header located in LUFA/Drivers/Peripheral/Serial.h. * dispatch header located in LUFA/Drivers/Peripheral/Serial.h.
* *
* \section Sec_ExampleUsage Example Usage * \section Sec_ExampleUsage Example Usage

12
LUFA/Drivers/Peripheral/XMEGA/SPI_XMEGA.h
View File

@ -159,7 +159,7 @@
/** Initializes the SPI subsystem, ready for transfers. Must be called before calling any other /** Initializes the SPI subsystem, ready for transfers. Must be called before calling any other
* SPI routines. * SPI routines.
* *
* \param[in, out] SPI Pointer to the base of the SPI peripheral within the device. * \param[in,out] SPI Pointer to the base of the SPI peripheral within the device.
* \param[in] SPIOptions SPI Options, a mask consisting of one of each of the \c SPI_SPEED_*, * \param[in] SPIOptions SPI Options, a mask consisting of one of each of the \c SPI_SPEED_*,
* \c SPI_SCK_*, \c SPI_SAMPLE_*, \c SPI_ORDER_* and \c SPI_MODE_* masks. * \c SPI_SCK_*, \c SPI_SAMPLE_*, \c SPI_ORDER_* and \c SPI_MODE_* masks.
*/ */
@ -171,7 +171,7 @@
/** Turns off the SPI driver, disabling and returning used hardware to their default configuration. /** Turns off the SPI driver, disabling and returning used hardware to their default configuration.
* *
* \param[in, out] SPI Pointer to the base of the SPI peripheral within the device. * \param[in,out] SPI Pointer to the base of the SPI peripheral within the device.
*/ */
static inline void SPI_Disable(SPI_t* const SPI) static inline void SPI_Disable(SPI_t* const SPI)
{ {
@ -180,7 +180,7 @@
/** Retrieves the currently selected SPI mode, once the SPI interface has been configured. /** Retrieves the currently selected SPI mode, once the SPI interface has been configured.
* *
* \param[in, out] SPI Pointer to the base of the SPI peripheral within the device. * \param[in,out] SPI Pointer to the base of the SPI peripheral within the device.
* *
* \return \ref SPI_MODE_MASTER if the interface is currently in SPI Master mode, \ref SPI_MODE_SLAVE otherwise * \return \ref SPI_MODE_MASTER if the interface is currently in SPI Master mode, \ref SPI_MODE_SLAVE otherwise
*/ */
@ -192,7 +192,7 @@
/** Sends and receives a byte through the SPI interface, blocking until the transfer is complete. /** Sends and receives a byte through the SPI interface, blocking until the transfer is complete.
* *
* \param[in, out] SPI Pointer to the base of the SPI peripheral within the device. * \param[in,out] SPI Pointer to the base of the SPI peripheral within the device.
* \param[in] Byte Byte to send through the SPI interface. * \param[in] Byte Byte to send through the SPI interface.
* *
* \return Response byte from the attached SPI device. * \return Response byte from the attached SPI device.
@ -210,7 +210,7 @@
/** Sends a byte through the SPI interface, blocking until the transfer is complete. The response /** 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. * byte sent to from the attached SPI device is ignored.
* *
* \param[in, out] SPI Pointer to the base of the SPI peripheral within the device. * \param[in,out] SPI Pointer to the base of the SPI peripheral within the device.
* \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(SPI_t* const SPI, static inline void SPI_SendByte(SPI_t* const SPI,
@ -225,7 +225,7 @@
/** Sends a dummy byte through the SPI interface, blocking until the transfer is complete. The response /** Sends a dummy byte through the SPI interface, blocking until the transfer is complete. The response
* byte from the attached SPI device is returned. * byte from the attached SPI device is returned.
* *
* \param[in, out] SPI Pointer to the base of the SPI peripheral within the device. * \param[in,out] SPI Pointer to the base of the SPI peripheral within the device.
* *
* \return The response byte from the attached SPI device. * \return The response byte from the attached SPI device.
*/ */

11
LUFA/Drivers/Peripheral/XMEGA/Serial_XMEGA.h
View File

@ -43,7 +43,7 @@
* \section Sec_ModDescription Module Description * \section Sec_ModDescription Module Description
* On-chip serial USART driver for the XMEGA AVR microcontrollers. * On-chip serial USART driver for the XMEGA AVR microcontrollers.
* *
* \note This file should not be included directly. It is automatically included as needed by the ADC driver * \note This file should not be included directly. It is automatically included as needed by the USART driver
* dispatch header located in LUFA/Drivers/Peripheral/Serial.h. * dispatch header located in LUFA/Drivers/Peripheral/Serial.h.
* *
* \section Sec_ExampleUsage Example Usage * \section Sec_ExampleUsage Example Usage
@ -52,13 +52,13 @@
* *
* \code * \code
* // Initialize the serial USART driver before first use, with 9600 baud (and no double-speed mode) * // Initialize the serial USART driver before first use, with 9600 baud (and no double-speed mode)
* Serial_Init(9600, false); * Serial_Init(&USARTD, 9600, false);
* *
* // Send a string through the USART * // Send a string through the USART
* Serial_TxString("Test String\r\n"); * Serial_TxString(&USARTD, "Test String\r\n");
* *
* // Receive a byte through the USART * // Receive a byte through the USART
* uint8_t DataByte = Serial_RxByte(); * uint8_t DataByte = Serial_RxByte(&USARTD);
* \endcode * \endcode
* *
* @{ * @{
@ -153,7 +153,7 @@
const uint32_t BaudRate, const uint32_t BaudRate,
const bool DoubleSpeed) const bool DoubleSpeed)
{ {
uint32_t BaudValue = (DoubleSpeed ? SERIAL_2X_UBBRVAL(BaudRate) : SERIAL_UBBRVAL(BaudRate)); uint16_t BaudValue = (DoubleSpeed ? SERIAL_2X_UBBRVAL(BaudRate) : SERIAL_UBBRVAL(BaudRate));
USART->BAUDCTRLB = (BaudValue >> 8); USART->BAUDCTRLB = (BaudValue >> 8);
USART->BAUDCTRLA = (BaudValue & 0xFF); USART->BAUDCTRLA = (BaudValue & 0xFF);
@ -263,6 +263,7 @@
if (!(Serial_IsCharReceived(USART))) if (!(Serial_IsCharReceived(USART)))
return -1; return -1;
USART->STATUS = USART_RXCIF_bm;
return USART->DATA; return USART->DATA;
} }

4
LUFA/Platform/UC3/ClockManagement.h
View File

@ -35,8 +35,8 @@
* of the various clocks within the device to clock the various peripherals. * of the various clocks within the device to clock the various peripherals.
*/ */
/** \ingroup Group_PlatformDrivers /** \ingroup Group_PlatformDrivers_UC3
* \defgroup Group_PlatformDrivers_UC3Clocks UC3 Clock Management Driver - LUFA/Platform/UC3/ClockManagement.h * \defgroup Group_PlatformDrivers_UC3Clocks Clock Management Driver - LUFA/Platform/UC3/ClockManagement.h
* \brief Module Clock Driver for the AVR32 UC3 microcontrollers. * \brief Module Clock Driver for the AVR32 UC3 microcontrollers.
* *
* \section Sec_Dependencies Module Source Dependencies * \section Sec_Dependencies Module Source Dependencies

4
LUFA/Platform/UC3/InterruptManagement.h
View File

@ -35,8 +35,8 @@
* handlers within the device. * handlers within the device.
*/ */
/** \ingroup Group_PlatformDrivers /** \ingroup Group_PlatformDrivers_UC3
* \defgroup Group_PlatformDrivers_UC3Interrupts UC3 Interrupt Controller Driver - LUFA/Platform/UC3/InterruptManagement.h * \defgroup Group_PlatformDrivers_UC3Interrupts Interrupt Controller Driver - LUFA/Platform/UC3/InterruptManagement.h
* \brief Interrupt Controller Driver for the AVR32 UC3 microcontrollers. * \brief Interrupt Controller Driver for the AVR32 UC3 microcontrollers.
* *
* \section Sec_Dependencies Module Source Dependencies * \section Sec_Dependencies Module Source Dependencies

4
LUFA/Platform/XMEGA/ClockManagement.h
View File

@ -35,8 +35,8 @@
* of the various clocks within the device to clock the various peripherals. * of the various clocks within the device to clock the various peripherals.
*/ */
/** \ingroup Group_PlatformDrivers /** \ingroup Group_PlatformDrivers_XMEGA
* \defgroup Group_PlatformDrivers_XMEGAClocks AVR USB XMEGA Clock Management Driver - LUFA/Platform/XMEGA/ClockManagement.h * \defgroup Group_PlatformDrivers_XMEGAClocks Clock Management Driver - LUFA/Platform/XMEGA/ClockManagement.h
* \brief Module Clock Driver for the AVR USB XMEGA microcontrollers. * \brief Module Clock Driver for the AVR USB XMEGA microcontrollers.
* *
* \section Sec_Dependencies Module Source Dependencies * \section Sec_Dependencies Module Source Dependencies