fixed last warnings for render documentation

Author: cristidragomir97

README.md

@@ -20,9 +20,9 @@ This library provides a toolkit for interacting with the official Arduino 4G Mod
 1. Insert your Arduino 4G module to the Arduino Portenta Mid Carrier
 2. Insert a valid SIM card either on the back of the Arduino 4G miniPCI board, or the **PCIE_SIM** connector on the Portenta Mid Carrier
 3. Connect the 6 **SERIAL1** header pins to their corresponding pins on the **PCIE_BREAKOUT** header using jumpers
-![](https://raw.githubusercontent.com/arduino-libraries/Arduino_Cellular/main/extras/connection_img/header.jpg)
+![](https://raw.githubusercontent.com/arduino-libraries/Arduino_Cellular/main/extras/connection_img/header.jpg?token=GHSAT0AAAAAACNPRJPUBHNVP3J3KMRPUULUZQVDLKQ)
 4. Connect the **3V3 PCIE** pin to the **3V3 Buck** 
-![](https://raw.githubusercontent.com/cristidragomir97/Arduino_Cellular/main/extras/connection_img/buck.jpg)
+![](https://raw.githubusercontent.com/arduino-libraries/Arduino_Cellular/main/extras/connection_img/buck.jpg?token=GHSAT0AAAAAACNPRJPUBUCALG2FUCDZ7AVCZQVDLJA)
 5. Connect external power to the Mid Carrier, via the **VIN** (5-12V) because modem use a lot of power when connecting or getting a GPS location. Make sure your supply can handle around 3A. 
 6. Get the APN settings from your network operator and add them to the "ArduinoSecrets.h" file for each sketch
 ```c

src/ArduinoCellular.h

@@ -20,10 +20,14 @@
 #include <ModemInterface.h>
 #include <TimeUtils.h>
 
+/**
+ * @enum ModemModel
+ * @brief Represents the model of the modem.
+*/
 enum ModemModel {
-    EC200,
-    EG95,
-    Unsupported
+    EC200, /**< Quectel EC200 modem. */
+    EG95,  /**< Quectel EG95 modem. */
+    Unsupported /**< Unsupported modem model. */
 };
 
 /**
@@ -124,6 +128,7 @@ class ArduinoCellular {
         /**
          * @brief Gets the cellular location. (Blocking call) 
          * @param timeout The timeout (In milliseconds) to wait for the cellular location. 
+         * @return The cellular location. If the location is not retrieved, the latitude and longitude will be 0.0.
          */
         Location getCellularLocation(unsigned long timeout = 10000);
 
@@ -141,9 +146,8 @@ class ArduinoCellular {
 
         /**
          * @brief Sends an SMS message to the specified number.
-         * @param number The phone number to send the SMS to. (TODO: find out number format)
+         * @param number The phone number to send the SMS to.
          * @param message The message to send.
-         * @return True if the SMS is sent successfully, false otherwise.
          */
         void sendSMS(String number, String message);
 
@@ -162,6 +166,7 @@ class ArduinoCellular {
         /**
          * @brief Sends an AT command to the modem and waits for a response, then returns the response.
          * @param command The AT command to send.
+         * @param timeout The timeout (In milliseconds) to wait for the response.
          * @return The response from the modem.
          */
         String sendATCommand(char * command, unsigned long timeout = 1000);
@@ -187,9 +192,26 @@ class ArduinoCellular {
          */
         HttpClient getHTTPClient(const char * server, const int port);
 
+        /**
+         * @brief Gets the HTTPS client for the specified server and port.
+         * @param server The server address.
+         * @param port The server port.
+         * @return The HTTPS client.
+         */
         HttpClient getHTTPSClient(const char * server, const int port);
+        
+        /**
+         * @brief Gets the local IP address.
+         * @return The local IP address.
+         */
+        IPAddress getIPAddress();
+
+        /**
+         * @brief Gets the signal quality.
+         * @return The signal quality.
+         */
+        int getSignalQuality();
 
-        void getConnectionStatus();
     private:
         bool connectToGPRS(const char * apn, const char * gprsUser, const char * gprsPass);
 
@@ -217,7 +239,6 @@ class ArduinoCellular {
          * @param latitude Pointer to store the latitude. (0.0 if not retrieved)
          * @param longitude Pointer to store the longitude. (0.0 if not retrieved)
          * @param timeout The timeout (In milliseconds) to wait for the GPS location.
-         * @return True if the GPS location is retrieved, false otherwise.
          */
         void getGPSLocation(float* latitude, float* longitude, unsigned long timeout = 60000);
 
@@ -226,7 +247,7 @@ class ArduinoCellular {
 
         ModemModel model; /**< The modem model. */
 
-        static unsigned long getTime();
+        static unsigned long getTime(); /** Callback for getting the current time as an unix timestamp. */
 };
 
 

src/ArdunioCellular.cpp

@@ -110,11 +110,12 @@ void ArduinoCellular::sendSMS(String number, String message){
   }
 
 
-void ArduinoCellular::getConnectionStatus(){
+IPAddress ArduinoCellular::getLocalIP(){
+    return modem.localIP();
+}
 
-   IPAddress local = modem.localIP();
-   Serial.print("Local IP:"); Serial.println(local.toString());
-   Serial.println("Signal quality:"); Serial.println(modem.getSignalQuality());
+int ArduinoCellular::getSignalQuality(){
+    return modem.getSignalQuality();
 }
 
 TinyGsmClient ArduinoCellular::getNetworkClient(){

src/ModemInterface.h

@@ -57,6 +57,9 @@ class ModemInterface : public TinyGsmBG96 {
   int power_pin; /**< The pin number for controlling the power of the modem. */
 };
 
-extern ModemInterface modem;
+/**
+ * @brief The global modem object.
+ */
+extern ModemInterface modem; 
 
 #endif

src/TimeUtils.h

@@ -56,6 +56,13 @@ class Time {
 
         /**
          * Initialises the time components with the given values.
+         * @param year The year component of the time.
+         * @param month The month component of the time.
+         * @param day The day component of the time.
+         * @param hour The hour component of the time.
+         * @param minute The minute component of the time.
+         * @param second The second component of the time.
+         * @param offset The timezone offset in hours (default is 0).
          */
         void fromComponents(int year, int month, int day, int hour, int minute, int second, int offset = 0) {
             this->year = year;
@@ -100,7 +107,8 @@ class Time {
         }
 
         /**
-         * Returns the year component of the time.
+         * Returns the year component of the time.\
+         * @param iso8601 The ISO8601 formatted string to parse. 
          * @return The year component of the time.
          */
         void parseISO8601(String iso8601) {