fixed javadocs documentation

Author: cristidragomir97

.gitignore

@@ -0,0 +1,3 @@
+.vscode/*
+.github/*
+.DS_Store

src/ArduinoCellular.h

@@ -1,3 +1,11 @@
+/**
+ * @file ArduinoCellular.h
+ * @brief Header file for the ArduinoCellular library.
+ * 
+ * This library provides methods to interact with the Arduino Pro Modem, such as connecting to the network,
+ * sending SMS messages, getting GPS location, and more.
+ */
+
 #ifndef ARDUINO_CELLULAR_MODEM_H
 #define ARDUINO_CELLULAR_MODEM_H
 
@@ -18,34 +26,50 @@ enum ModemModel {
     Unsupported
 };
 
+/**
+ * Represents an SMS message.
+ */
 class SMS {
     public:
-        String number;
-        String message;
-        Time timestamp;
+        String number; /**< The phone number associated with the SMS. */
+        String message; /**< The content of the SMS message. */
+        Time timestamp; /**< The timestamp when the SMS was received. */
 
+        /**
+         * Default constructor for SMS.
+         * Initializes the number, message, and timestamp to empty values.
+         */
         SMS() {
             this->number = "";
             this->message = "";
             this->timestamp = Time();
         }
 
+        /**
+         * Constructor for SMS.
+         * @param number The phone number associated with the SMS.
+         * @param message The content of the SMS message.
+         * @param timestamp The timestamp when the SMS was received.
+         */
         SMS(String number, String message, Time timestamp) {
             this->number = number;
             this->message = message;
             this->timestamp = timestamp;
         }
 };
-// TODO: move time implementation to Time class
 
+
+/**
+ * @struct Location
+ * @brief Represents a geographic location with latitude and longitude coordinates.
+ */
 struct Location {
-    float latitude;
-    float longitude;
+    float latitude; /**< The latitude coordinate of the location. */
+    float longitude; /**< The longitude coordinate of the location. */
 };
 
 /**
- * @class ArduinoPro_Modem
- * @brief Represents an Arduino Pro Modem.
+ * @class ArduinoCellular
  * 
  * This class provides methods to interact with the Arduino Pro Modem, such as connecting to the network,
  * sending SMS messages, getting GPS location, and more.

src/ModemInterface.h

@@ -1,3 +1,8 @@
+/**
+ * @file ModemInterface.h
+ * @brief Header file for the ModemInterface class.
+ */
+
 #ifndef ARDUINO_4G_MODULE_H
 #define ARDUINO_4G_MODULE_H
 
@@ -12,11 +17,26 @@
 #include <TinyGsmClient.h>
 #include <ArduinoHttpClient.h>
 
+/**
+ * @class ModemInterface
+ * @brief Represents the interface to the 4G modem module.
+ */
 class ModemInterface : public TinyGsmBG96 {
 public:
+  /**
+   * @brief Constructor for the ModemInterface class.
+   * @param stream The stream object for communication with the modem.
+   * @param power_pin The pin number for controlling the power of the modem.
+   */
   explicit ModemInterface(Stream& stream, int power_pin) : TinyGsmBG96(stream),stream(&stream),power_pin(power_pin) {
 
   };
+
+  /**
+   * @brief Initializes the modem interface.
+   * @param pin The PIN code for the SIM card (optional).
+   * @return True if initialization is successful, false otherwise.
+   */
   bool init(const char* pin = NULL) {
     pinMode(power_pin, OUTPUT);
     digitalWrite(power_pin, HIGH);
@@ -31,13 +51,12 @@ class ModemInterface : public TinyGsmBG96 {
     #endif
     return TinyGsmBG96::init();
   };
+
 public:
-  Stream* stream;
-  int power_pin;
+  Stream* stream; /**< The stream object for communication with the modem. */
+  int power_pin; /**< The pin number for controlling the power of the modem. */
 };
 
 extern ModemInterface modem;
 
-
-
 #endif