documentation checked and edit

for all files in lib folder
This commit is contained in:
2023-10-12 18:45:12 +02:00
parent 61a95e4601
commit db74898b72
41 changed files with 1030 additions and 569 deletions
+6 -7
View File
@@ -52,9 +52,10 @@ public:
};
/**
* @brief Construct a new Navigation object and using I2C
* @brief Construct a new Navigation object
*
* @param route with which to navigate
* @param sensorData
* @param route
*/
Navigation(const SensorData *sensorData, Route *route = nullptr);
@@ -89,11 +90,9 @@ public:
/**
* @brief Get the Course Correction object
*
* This should be called by the driver to get new instructions.
*
* @param correction passed as refernce to get the data
* @return true if new correction data provided
* @return false if route is finished
* @param correction
* @param forceUpdate
* @return Status
*/
Status getCourseCorrection(CourseCorrection &correction, bool forceUpdate = false);