LiXiaoqi/minmea
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

minmea.h: fix comment for minmea_scan()

Browse Source
This commit is contained in:
Kosma Moczek 2022-08-04 11:56:24 +01:00
parent d6ad155319
commit 9ae3e50947
1 changed files with 5 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
minmea.h
View File

@ -199,11 +199,14 @@ enum minmea_sentence_id minmea_sentence_id(const char *sentence, bool strict);
* Scanf-like processor for NMEA sentences. Supports the following formats: * Scanf-like processor for NMEA sentences. Supports the following formats:
* c - single character (char *) * c - single character (char *)
* d - direction, returned as 1/-1, default 0 (int *) * d - direction, returned as 1/-1, default 0 (int *)
* f - fractional, returned as value + scale (int *, int *) * f - fractional, returned as value + scale (struct minmea_float *)
* i - decimal, default zero (int *) * i - decimal, default zero (int *)
* s - string (char *) * s - string (char *)
* t - talker identifier and type (char *) * t - talker identifier and type (char *)
* T - date/time stamp (int *, int *, int *) * D - date (struct minmea_date *)
* T - time stamp (struct minmea_time *)
* _ - ignore this field
* ; - following fields are optional
* Returns true on success. See library source code for details. * Returns true on success. See library source code for details.
*/ */
bool minmea_scan(const char *sentence, const char *format, ...); bool minmea_scan(const char *sentence, const char *format, ...);