Merge branch 'release/v02.00.00' into develop

Author: gigapod

README.md

@@ -9,7 +9,7 @@ Arduino Library for the SparkFun Pulsed Coherent Radar Sensor
 ![Release](https://img.shields.io/github/v/release/sparkfun/SparkFun_Qwiic_XM125_Arduino_Library)
 ![Release Date](https://img.shields.io/github/release-date/sparkfun/SparkFun_Qwiic_XM125_Arduino_Library)
 ![Documentation - build](https://img.shields.io/github/actions/workflow/status/sparkfun/SparkFun_Qwiic_XM125_Arduino_Library/build-deploy-ghpages.yml?label=doc%20build)
-![Compile - Test](https://img.shields.io/github/actions/workflow/status/sparkfun/SparkFun_Qwiic_XM125_Arduino_Library/test-compile-sketch.yml?label=compile%20test)
+![Compile - Test](https://img.shields.io/github/actions/workflow/status/sparkfun/SparkFun_Qwiic_XM125_Arduino_Library/compile-sketch.yml?label=compile%20test)
 ![GitHub issues](https://img.shields.io/github/issues/sparkfun/SparkFun_Qwiic_XM125_Arduino_Library)
 
 The [SparkFun Pulsed Coherent Radar Sensor - Acconeer XM125 (SEN-24540)](https://www.sparkfun.com/sparkfun-pulsed-coherent-radar-sensor-acconeer-xm125-qwiic.html) brings powerful 60 GHz radar technology to your projects. This sensor isn't limited to surface detection; it can see through walls, cabinets, and even pockets (depending on the material), making it perfect for unique applications. Measure distances with millimeter precision, detect motion, the speed of an object, or even gestures!
@@ -39,6 +39,17 @@ This library provides a extensive interface that enables the following functiona
 |Distance Detection | `i2c_distance_detector` | `SparkFunXM125Distance`|
 |Presence Detection | `i2c_presence_detector` | `SparkFunXM125Presence`|
 
+## Documentation
+
+|Reference | Description |
+|---|---|
+|[Quick Reference](https://docs.sparkfun.com/SparkFun_Qwiic_XM125_Arduino_Library/class_qw_dev_x_m125.html)| A quick reference API for the the main library object ```QwDevXM125```|
+|[Full Documentation](https://docs.sparkfun.com/SparkFun_Qwiic_XM125_Arduino_Library/)| The full documentation and API for this Arduino library|
+|[SparkFun Pulsed Coherent Radar Sensor](https://github.com/sparkfun/SparkFun_Qwiic_Pulsed_Radar_Sensor_XM125)| Hardware GitHub Repository|
+|[Hook Up Guide](https://docs.sparkfun.com/SparkFun_Qwiic_Pulsed_Radar_Sensor_XM125/introduction/) | Hardware Overview and Quick Start for the XM125 Qwiic Development Board |
+
+
+
 ## Examples
 
 The following examples are provided with the library
@@ -55,6 +66,7 @@ The following examples are provided with the library
 |[Distance Serial Plotter](examples/Example08_DistanceSerialPlotter/Example08_DistanceSerialPlotter.ino)|This example prints out the distance values of the 0 distance channels to the serial plotter tool in Arduino.|
 |[Distance Advanced Settings](examples/Example09_DistanceAdvancedSettings/Example09_DistanceAdvancedSettings.ino)|The sensor is initialized, then the distance (mm) and advanced values are output to the terminal. |
 
+
 ## Documentation
 
 The full API and use documentation for this library is provided [here](https://docs.sparkfun.com/SparkFun_Qwiic_XM125_Arduino_Library/). For a quick reference, the main methods available in the library are listed [here](https://docs.sparkfun.com/SparkFun_Qwiic_XM125_Arduino_Library/class_qw_dev_x_m125.html).

docs/doxygen/doxygen-config

@@ -171,7 +171,7 @@ ALWAYS_DETAILED_SEC    = YES
 # operators of the base classes will not be shown.
 # The default value is: NO.
 
-INLINE_INHERITED_MEMB  = NO
+INLINE_INHERITED_MEMB  = YES
 
 # If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path
 # before files name in the file list and in the header files. If set to NO the

library.properties

@@ -3,7 +3,7 @@ version=2.0.0
 author=SparkFun Electronics <techsupport@sparkfun.com>
 maintainer=SparkFun Electronics <sparkfun.com>
 sentence=An Arduino library to make use of the Qwiic XM125 A121 Pulsed Radar Module from Acconeer. 
-paragraph=This is the SparkFun library for the Acconeer Entry+ Module XM125 with the A121 60GHz Pulsed Coherent Radar sensor and I2C interface. NOTE: Version 2.0 or greater of this library is not backward compatiable with version 1 - the library object has changed - see examples
+paragraph=This is the SparkFun library for the Acconeer Entry+ Module XM125 with the A121 60GHz Pulsed Coherent Radar sensor and I2C interface. NOTE: Version 2.0 or greater of this library is not backward compatible with version 1 - the library object has changed - see examples
 category=Sensors
 url=https://github.com/sparkfun/SparkFun_Qwiic_XM125_Arduino_Library
 architectures=*

src/sfTk/sfDevXM125Core.cpp

@@ -19,7 +19,7 @@
 #include "sfDevXM125Core.h"
 
 //--------------------------------------------------------------------------------
-sfTkError_t sfDevXM125Core::begin(sfTkII2C *theBus)
+sfTkError_t sfDevXM125Core::init(sfTkII2C *theBus)
 {
     if (theBus == nullptr)
         return ksfTkErrBusNotInit;

src/sfTk/sfDevXM125Core.h

@@ -30,9 +30,7 @@ class sfDevXM125Core
 
     /// @brief This function begins the examples/communication.
     /// @return ksfTkErrOk on success, or error code (value < -1)
-    virtual sfTkError_t begin(sfTkII2C *theBus = nullptr);
-
-    virtual ~sfDevXM125Core() {};
+    sfTkError_t init(sfTkII2C *theBus = nullptr);
 
   protected:
     // our toolkit bus