From 2d7b8306cddd35e481825a3e3692298ab09e387d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?King=20K=C3=A9vin?= Date: Sat, 19 Aug 2017 13:33:00 +0200 Subject: [PATCH] doc: fix doc --- application.c | 8 ++++---- lib/radio_bluetooth.h | 2 +- lib/radio_gps.h | 2 +- lib/sensor_forumslader.h | 2 +- 4 files changed, 7 insertions(+), 7 deletions(-) diff --git a/application.c b/application.c index a171c23..eaa976d 100644 --- a/application.c +++ b/application.c @@ -13,7 +13,7 @@ * */ /** STM32F1 application example - * @file main.c + * @file application.c * @author King Kévin * @date 2016-2017 */ @@ -131,9 +131,9 @@ DSTATUS disk_initialize (BYTE pdrv) } /** control device specific features and miscellaneous functions other than generic read/write - * @param[in] pdrv physical drive number + * @param[in] drv physical drive number * @param[in] cmd control command code - * @param[io] buff pointer to the control data + * @param[out] buff pointer to the control data * @return RES_* * @note FatFs function to be implement by user */ @@ -199,7 +199,7 @@ DRESULT disk_read (BYTE pdrv, BYTE* buff, DWORD sector, UINT count) } /** write data to the sector(s) of storage device. - * @param[in] pdrv physical drive number + * @param[in] drv physical drive number * @param[out] buff pointer to the data to be written * @param[in] sector sector number to write from * @param[in] count number of sectors to write diff --git a/lib/radio_bluetooth.h b/lib/radio_bluetooth.h index 058f0ca..2413335 100644 --- a/lib/radio_bluetooth.h +++ b/lib/radio_bluetooth.h @@ -24,7 +24,7 @@ extern volatile bool radio_bluetooth_transmitted; /** has a message been received */ extern volatile bool radio_bluetooth_received; -/** last valid message received (including \r\n ending and \0) */ +/** last valid message received ((including Carriage Return and Line Feed ending and NULL termination) */ extern volatile char radio_bluetooth_message[82+1]; /** setup USART peripheral for Bluetooth communication */ diff --git a/lib/radio_gps.h b/lib/radio_gps.h index dd170e7..dc4bc31 100644 --- a/lib/radio_gps.h +++ b/lib/radio_gps.h @@ -22,7 +22,7 @@ /** has a NMEA-0183 GPS message been received */ extern volatile bool radio_gps_received; -/** last valid NMEA-0183 GPS message received (including \r\n ending and \0) */ +/** last valid NMEA-0183 GPS message received (including Carriage Return and Line Feed ending and NULL termination) */ extern volatile char radio_gps_message[82+1]; /** setup USART peripheral for GPS communication */ diff --git a/lib/sensor_forumslader.h b/lib/sensor_forumslader.h index e553aea..1b19640 100644 --- a/lib/sensor_forumslader.h +++ b/lib/sensor_forumslader.h @@ -24,7 +24,7 @@ extern volatile bool sensor_forumslader_transmitted; /** has a forumslader message been received */ extern volatile bool sensor_forumslader_received; -/** last valid forumslader message received (including \r\n ending and \0) */ +/** last valid forumslader message received (including Carriage Return and Line Feed ending and NULL termination) */ extern volatile char sensor_forumslader_message[82+1]; /** setup USART peripheral for forumslader communication */