Merge pull request #142 from caternuson/fix_dox

Update CI for doxygen

.github/workflows/githubci.yml

@@ -29,4 +29,4 @@ jobs:
       env:
         GH_REPO_TOKEN: ${{ secrets.GH_REPO_TOKEN }}
         PRETTYNAME : "Adafruit GPS Library"
-      run: bash ci/doxy_gen_and_deploy.sh
+      run: bash ci/doxy_gen_and_deploy.sh src

README.md

@@ -1,5 +1,4 @@
-# Adafruit_GPS [![Build Status](https://travis-ci.com/adafruit/Adafruit_GPS.svg?branch=master)](https://travis-ci.com/adafruit/Adafruit_GPS)
+# Adafruit_GPS [![Build Status](https://travis-ci.com/adafruit/Adafruit_GPS.svg?branch=master)](https://travis-ci.com/adafruit/Adafruit_GPS) [![Documentation](https://github.com/adafruit/ci-arduino/blob/master/assets/doxygen_badge.svg)](http://adafruit.github.io/Adafruit_GPS/html/index.html)
-[![Documentation](https://github.com/adafruit/ci-arduino/blob/master/assets/doxygen_badge.svg)](http://adafruit.github.io/Adafruit_GPS/html/index.html)
 
 > **Warning**
 >

src/Adafruit_GPS.cpp

@@ -32,112 +32,6 @@
 
 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
-*/
-/**************************************************************************/
-// void Adafruit_GPS::parseLat(char *p) {
-//   char degreebuff[10];
-//   if (!isEmpty(p)) {
-//     strncpy(degreebuff, p, 2);
-//     p += 2;
-//     degreebuff[2] = '\0';
-//     long degree = atol(degreebuff) * 10000000;
-//     strncpy(degreebuff, p, 2); // minutes
-//     p += 3;                    // skip decimal point
-//     strncpy(degreebuff + 2, p, 4);
-//     degreebuff[6] = '\0';
-//     long minutes = 50 * atol(degreebuff) / 3;
-//     latitude_fixed = degree + minutes;
-//     latitude = degree / 100000 + minutes * 0.000006F;
-//     latitudeDegrees = (latitude - 100 * int(latitude / 100)) / 60.0f;
-//     latitudeDegrees += int(latitude / 100);
-//   }
-// }
-
-/**************************************************************************/
-/*!
-    @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';
-//     latitudeDegrees *= -1.0f;
-//     latitude_fixed *= -1;
-//   } else if (p[0] == 'N') {
-//     lat = 'N';
-//   } else if (p[0] == ',') {
-//     lat = 0;
-//   } else {
-//     return false;
-//   }
-//   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
-*/
-/**************************************************************************/
-// void Adafruit_GPS::parseLon(char *p) {
-//   int32_t degree;
-//   long minutes;
-//   char degreebuff[10];
-//   if (!isEmpty(p)) {
-//     strncpy(degreebuff, p, 3);
-//     p += 3;
-//     degreebuff[3] = '\0';
-//     degree = atol(degreebuff) * 10000000;
-//     strncpy(degreebuff, p, 2); // minutes
-//     p += 3;                    // skip decimal point
-//     strncpy(degreebuff + 2, p, 4);
-//     degreebuff[6] = '\0';
-//     minutes = 50 * atol(degreebuff) / 3;
-//     longitude_fixed = degree + minutes;
-//     longitude = degree / 100000 + minutes * 0.000006F;
-//     longitudeDegrees = (longitude - 100 * int(longitude / 100)) / 60.0f;
-//     longitudeDegrees += int(longitude / 100);
-//   }
-// }
-
-/**************************************************************************/
-/*!
-    @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') {
-//       lon = 'W';
-//       longitudeDegrees *= -1.0f;
-//       longitude_fixed *= -1;
-//     } else if (p[0] == 'E') {
-//       lon = 'E';
-//     } else if (p[0] == ',') {
-//       lon = 0;
-//     } else {
-//       return false;
-//     }
-//   }
-//   return true;
-// }
-
 /**************************************************************************/
 /*!
     @brief Start the HW or SW serial port

src/NMEA_build.cpp

@@ -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
+  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.
+  @copyright BSD license, check license.txt for more information
-
-  @section license License
-
-  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
 */
 /**************************************************************************/

src/NMEA_data.cpp

@@ -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.
+  @copyright CCBY license
-
-  @section license License
-
-  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
 */
 /**************************************************************************/

src/NMEA_parse.cpp

@@ -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.
+  @copyright BSD license, check license.txt for more information
-
-  @section license License
-
-  BSD license, check license.txt for more information
   All text above must be included in any redistribution
 */
 /**************************************************************************/