Cansat
/
esp32_Adafruit_GPS
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

dox fixes for ci

This commit is contained in:
caternuson 2022-09-20 09:11:22 -07:00
parent 8f64b4dd64
commit 237f7b26eb
4 changed files with 45 additions and 63 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

68
src/Adafruit_GPS.cpp
View File

@ -32,20 +32,20 @@
static bool strStartsWith(const char *str, const char *prefix);
/**************************************************************************/
/*!
@brief Is the field empty, or should we try conversion? Won't work
for a text field that starts with an asterisk or a comma, but that
probably violates the NMEA-183 standard.
@param pStart Pointer to the location of the token in the NMEA string
@return true if empty field, false if something there
*/
/**************************************************************************/
/*!
@brief Parse a part of an NMEA string for latitude angle
@param p Pointer to the location of the token in the NMEA string
*/
/**************************************************************************/
// /**************************************************************************/
// /*!
// @brief Is the field empty, or should we try conversion? Won't work
// for a text field that starts with an asterisk or a comma, but that
// probably violates the NMEA-183 standard.
// @param pStart Pointer to the location of the token in the NMEA string
// @return true if empty field, false if something there
// */
// /**************************************************************************/
// /*!
// @brief Parse a part of an NMEA string for latitude angle
// @param p Pointer to the location of the token in the NMEA string
// */
// /**************************************************************************/
// void Adafruit_GPS::parseLat(char *p) {
// char degreebuff[10];
// if (!isEmpty(p)) {
@ -65,13 +65,13 @@ static bool strStartsWith(const char *str, const char *prefix);
// }
// }
/**************************************************************************/
/*!
@brief Parse a part of an NMEA string for latitude direction
@param p Pointer to the location of the token in the NMEA string
@return True if we parsed it, false if it has invalid data
*/
/**************************************************************************/
// /**************************************************************************/
// /*!
// @brief Parse a part of an NMEA string for latitude direction
// @param p Pointer to the location of the token in the NMEA string
// @return True if we parsed it, false if it has invalid data
// */
// /**************************************************************************/
// bool Adafruit_GPS::parseLatDir(char *p) {
// if (p[0] == 'S') {
// lat = 'S';
@ -87,12 +87,12 @@ static bool strStartsWith(const char *str, const char *prefix);
// return true;
// }
/**************************************************************************/
/*!
@brief Parse a part of an NMEA string for longitude angle
@param p Pointer to the location of the token in the NMEA string
*/
/**************************************************************************/
// /**************************************************************************/
// /*!
// @brief Parse a part of an NMEA string for longitude angle
// @param p Pointer to the location of the token in the NMEA string
// */
// /**************************************************************************/
// void Adafruit_GPS::parseLon(char *p) {
// int32_t degree;
// long minutes;
@ -114,13 +114,13 @@ static bool strStartsWith(const char *str, const char *prefix);
// }
// }
/**************************************************************************/
/*!
@brief Parse a part of an NMEA string for longitude direction
@param p Pointer to the location of the token in the NMEA string
@return True if we parsed it, false if it has invalid data
*/
/**************************************************************************/
// /**************************************************************************/
// /*!
// @brief Parse a part of an NMEA string for longitude direction
// @param p Pointer to the location of the token in the NMEA string
// @return True if we parsed it, false if it has invalid data
// */
// /**************************************************************************/
// bool Adafruit_GPS::parseLonDir(char *p) {
// if (!isEmpty(p)) {
// if (p[0] == 'W') {

17
src/NMEA_build.cpp
View File

@ -2,28 +2,22 @@
/*!
@file NMEA_build.cpp
@mainpage Adafruit Ultimate GPS Breakout
@section intro Introduction
This is the Adafruit GPS library - the ultimate GPS library
for the ultimate GPS module!
Tested and works great with the Adafruit Ultimate GPS module
using MTK33x9 chipset
------> http://www.adafruit.com/products/746
------> http://www.adafruit.com/products/746
Pick one up today at the Adafruit electronics shop
and help support open source hardware & software! -ada
Adafruit invests time and resources providing this open source code,
please support Adafruit and open-source hardware by purchasing
products from Adafruit!
@section author Author
@author Limor Fried/Ladyada for Adafruit Industries.
Written by Limor Fried/Ladyada for Adafruit Industries.
@section license License
BSD license, check license.txt for more information
@copyright BSD license, check license.txt for more information
All text above must be included in any redistribution
*/
/**************************************************************************/
@ -67,6 +61,7 @@
@param thisSource Pointer to the source name string (2 upper case)
@param thisSentence Pointer to the sentence name string (3 upper case)
@param ref Reference for the sentence, usually relative (R) or true (T)
@param noCRLF set true to disable adding CR/LF to comply with NMEA-183
@return Pointer to sentence if successful, NULL if fails
*/
/**************************************************************************/

11
src/NMEA_data.cpp
View File

@ -2,8 +2,6 @@
/*!
@file NMEA_data.cpp
@section intro Introduction
Code for tracking values that change with time so that history can be
examined for recent trends in real time. This code will only generate the
stubs for newDataValue() and data_init(), adding essentially nothing to
@ -25,13 +23,9 @@
records. It updates all the same variables as the GPS object, so you could
skip the GPS parsing step.
@section author Author
@author Rick Sellens.
Written by Rick Sellens.
@section license License
CCBY license
@copyright CCBY license
*/
/**************************************************************************/
@ -377,6 +371,7 @@ void Adafruit_GPS::initDataValue(nmea_index_t idx, char *label, char *fmt,
@param offset Value for scaling the integer history list
@param historyInterval Approximate Time in seconds between historical
values.
@param historyN Set size of data buffer.
@return pointer to the history
*/
/**************************************************************************/

12
src/NMEA_parse.cpp
View File

@ -2,10 +2,6 @@
/*!
@file NMEA_parse.cpp
@mainpage Adafruit Ultimate GPS Breakout
@section intro Introduction
This is the Adafruit GPS library - the ultimate GPS library
for the ultimate GPS module!
@ -17,13 +13,9 @@
please support Adafruit and open-source hardware by purchasing
products from Adafruit!
@section author Author
@author Limor Fried/Ladyada for Adafruit Industries.
Written by Limor Fried/Ladyada for Adafruit Industries.
@section license License
BSD license, check license.txt for more information
@copyright BSD license, check license.txt for more information
All text above must be included in any redistribution
*/
/**************************************************************************/