andreika-git
/
ChibiOS
mirror of https://github.com/andreika-git/ChibiOS.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Documentation-related fixes. 

git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@10092 35acf78f-673a-0410-8e92-d51de3d6d3f4
This commit is contained in:
Giovanni Di Sirio 2017-02-07 07:58:38 +00:00
parent 47a8438f5b
commit af22a2dcaf
6 changed files with 12 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/hal/Doxyfile_chm
View File

@ -38,7 +38,7 @@ PROJECT_NAME = ChibiOS/HAL
# could be handy for archiving the generated documentation or if some version
# control system is used.
PROJECT_NUMBER = 4.1.0
PROJECT_NUMBER = 5.0.0
# Using the PROJECT_BRIEF tag one can provide an optional one line description
# for a project that appears at the top of each page and should give viewer a

2
doc/hal/Doxyfile_html
View File

@ -38,7 +38,7 @@ PROJECT_NAME = ChibiOS/HAL
# could be handy for archiving the generated documentation or if some version
# control system is used.
PROJECT_NUMBER = 4.1.0
PROJECT_NUMBER = 5.0.0
# Using the PROJECT_BRIEF tag one can provide an optional one line description
# for a project that appears at the top of each page and should give viewer a

5
os/hal/ports/STM32/LLD/CANv1/hal_can_lld.c
View File

@ -68,6 +68,7 @@ CANDriver CAND3;
/**
* @brief Programs the filters of CAN 1 and CAN 2.
*
* @param[in] canp pointer to the @p CANDriver object
* @param[in] can2sb number of the first filter assigned to CAN2
* @param[in] num number of entries in the filters array, if zero then
* a default filter is programmed
@ -1006,6 +1007,7 @@ void can_lld_wakeup(CANDriver *canp) {
* @brief Programs the filters.
* @note This is an STM32-specific API.
*
* @param[in] canp pointer to the @p CANDriver object
* @param[in] can2sb number of the first filter assigned to CAN2
* @param[in] num number of entries in the filters array, if zero then
* a default filter is programmed
@ -1014,7 +1016,8 @@ void can_lld_wakeup(CANDriver *canp) {
*
* @api
*/
void canSTM32SetFilters(CANDriver *canp, uint32_t can2sb, uint32_t num, const CANFilter *cfp) {
void canSTM32SetFilters(CANDriver *canp, uint32_t can2sb,
uint32_t num, const CANFilter *cfp) {
#if STM32_CAN_USE_CAN2
osalDbgCheck((can2sb <= STM32_CAN_MAX_FILTERS) &&

2
os/hal/ports/STM32/LLD/USARTv2/hal_uart_lld.c
View File

@ -154,7 +154,7 @@ UARTDriver UARTD8;
/**
* @brief Status bits translation.
*
* @param[in] sr USART SR register value
* @param[in] isr USART SR register value
*
* @return The error flags.
*/

3
os/hal/ports/STM32/LLD/USBv1/hal_usb_lld.c
View File

@ -107,6 +107,7 @@ static void usb_pm_reset(USBDriver *usbp) {
*
* @param[in] usbp pointer to the @p USBDriver object
* @param[in] size size of the packet buffer to allocate
* @return The packet buffer address.
*/
static uint32_t usb_pm_alloc(USBDriver *usbp, size_t size) {
uint32_t next;
@ -120,7 +121,7 @@ static uint32_t usb_pm_alloc(USBDriver *usbp, size_t size) {
/**
* @brief Reads from a dedicated packet buffer.
*
* @param[in] udp pointer to a @p stm32_usb_descriptor_t
* @param[in] ep endpoint number
* @param[out] buf buffer where to copy the packet data
* @return The size of the receivee packet.
*

6
os/hal/src/hal_qspi.c
View File

@ -134,7 +134,7 @@ void qspiStop(QSPIDriver *qspip) {
* @post At the end of the operation the configured callback is invoked.
*
* @param[in] qspip pointer to the @p QSPIDriver object
* @param[in] cmd pointer to the command descriptor
* @param[in] cmdp pointer to the command descriptor
*
* @api
*/
@ -156,7 +156,7 @@ void qspiStartCommand(QSPIDriver *qspip, const qspi_command_t *cmdp) {
* @post At the end of the operation the configured callback is invoked.
*
* @param[in] qspip pointer to the @p QSPIDriver object
* @param[in] cmd pointer to the command descriptor
* @param[in] cmdp pointer to the command descriptor
* @param[in] n number of bytes to send
* @param[in] txbuf the pointer to the transmit buffer
*
@ -182,7 +182,7 @@ void qspiStartSend(QSPIDriver *qspip, const qspi_command_t *cmdp,
* @post At the end of the operation the configured callback is invoked.
*
* @param[in] qspip pointer to the @p QSPIDriver object
* @param[in] cmd pointer to the command descriptor
* @param[in] cmdp pointer to the command descriptor
* @param[in] n number of bytes to send
* @param[out] rxbuf the pointer to the receive buffer
*