Added documentation for the code

Added documentation for the code

Author: madhurimarawat

Overloading/Function/Area-circle-square-rectangle-triangle-Output.exe

@@ -0,0 +1,104 @@
+#include <iostream>
+using namespace std;
+
+// WAP in C++ to find out the area of circle,square, rectangle & triangle using function overloading.
+
+/**
+ * @brief Calculates and prints the area of a circle.
+ *
+ * This function takes a float value representing the radius of a circle,
+ * calculates the area using the formula π*r^2, and prints the result.
+ *
+ * @param r The radius of the circle. It must be a positive value.
+ *
+ * @return void. The function does not return a value.
+ */
+void area(float r)
+{
+  float c = 3.14 * r * r;
+  cout << "Area of circle is:" << c << endl;
+}
+
+/**
+ * @brief Calculates and prints the area of a square.
+ *
+ * This function takes an integer value representing the side of a square,
+ * calculates the area using the formula s^2, and prints the result.
+ *
+ * @param s The side of the square. It must be a positive value.
+ *
+ * @return void. The function does not return a value.
+ */
+void area(int s)
+{
+  int sq = s * s;
+  cout << "Area of square is:" << sq << endl;
+}
+
+/**
+ * @brief Calculates and prints the area of a rectangle.
+ *
+ * This function takes two integer values representing the length and breadth of a rectangle,
+ * calculates the area using the formula length*breadth, and prints the result.
+ *
+ * @param l The length of the rectangle. It must be a positive value.
+ * @param b The breadth of the rectangle. It must be a positive value.
+ *
+ * @return void. The function does not return a value.
+ */
+void area(int l, int b)
+{
+  int r = l * b;
+  cout << "Area of rectangle is:" << r << endl;
+}
+/**
+ * @brief Calculates and prints the area of a triangle.
+ *
+ * This function takes two float values representing the base and height of a triangle,
+ * calculates the area using the formula 0.5*base*height, and prints the result.
+ *
+ * @param b The base of the triangle. It must be a positive value.
+ * @param h The height of the triangle. It must be a positive value.
+ *
+ * @return void. The function does not return a value. It only prints the calculated area.
+ */
+void area(float b, float h)
+{
+  float t = 0.5 * b * h;
+  cout << "Area of triangle is:" << t << endl;
+}
+
+/**
+ * @brief The main function of the program.
+ *
+ * This function prompts the user to enter the dimensions of a square, rectangle, circle, and triangle,
+ * then calls the appropriate area function to calculate and print the area of each shape.
+ *
+ * @return 0. The function does not return a value.
+ */
+int main()
+{
+  int s, l, b;
+  float r, bs, ht;
+  cout << "Enter side of a square:";
+  cin >> s;
+  cout << "Enter length and breadth of rectangle:";
+  cin >> l >> b;
+  cout << "Enter radius of circle:";
+  cin >> r;
+  cout << "Enter base and height of triangle:";
+  cin >> bs >> ht;
+  area(r);
+  area(s);
+  area(l, b);
+  area(bs, ht);
+  /*Enter side of a square:10
+  Enter length and breadth of rectangle:12 13
+  Enter radius of circle:2.33
+  Enter base and height of triangle:15 67
+  Area of circle is:17.0467
+  Area of square is:100
+  Area of rectangle is:156
+  Area of triangle is:502.5 */
+  return 0;
+}

Overloading/Function/Area-circle-square-rectangle-triangle.cpp

@@ -0,0 +1,51 @@
+#include <iostream>
+using namespace std;
+class Cal
+{
+public:
+  /**
+   * @brief Adds two integers together.
+   *
+   * This function takes two integers as input and returns their sum.
+   *
+   * @param a The first integer to add.
+   * @param b The second integer to add.
+   *
+   * @return The sum of the two input integers.
+   */
+  int add(int a, int b)
+  {
+    return a + b;
+  }
+  /**
+   * @brief Adds three integers together.
+   *
+   * This function takes three integers as input and returns their sum.
+   *
+   * @param a The first integer to add.
+   * @param b The second integer to add.
+   * @param c The third integer to add.
+   *
+   * @return The sum of the three input integers.
+   */
+  int add(int a, int b, int c)
+  {
+    return a + b + c;
+  }
+};
+
+/**
+ * @brief Main function to demonstrate the usage of the Cal class.
+ *
+ * This function creates an instance of the Cal class, calls its add() method with two and three arguments,
+ * and prints the results to the console.
+ *
+ * @return 0 to indicate successful program execution.
+ */
+int main()
+{
+  Cal C;
+  cout << C.add(10, 20) << endl; // Prints the sum of 10 and 20.
+  cout << C.add(12, 20, 23);     // Prints the sum of 12, 20, and 23.
+  return 0;
+}

Overloading/Function/Integer-Addition-Using-Overloaded-Methods-Parameters-Output.exe

@@ -0,0 +1,51 @@
+#include <iostream>
+using namespace std;
+class calc
+{
+public:
+  /**
+   * @brief Adds two integers together.
+   *
+   * This function takes two integers as input and returns their sum.
+   *
+   * @param a The first integer to add.
+   * @param b The second integer to add.
+   *
+   * @return The sum of the two input integers.
+   */
+  int add(int a, int b)
+  {
+    return a + b;
+  }
+  /**
+   * @brief Adds three integers together.
+   *
+   * This function takes three integers as input and returns their sum.
+   *
+   * @param a The first integer to add.
+   * @param b The second integer to add.
+   * @param c The third integer to add.
+   *
+   * @return The sum of the three input integers.
+   */
+  float add(int a, int b, int c)
+  {
+    return a + b + c;
+  }
+};
+
+/**
+ * @brief Main function to demonstrate the usage of the calc class.
+ *
+ * This function creates an instance of the calc class, calls its add() method with two and three parameters,
+ * and prints the results to the console.
+ *
+ * @return 0 to indicate successful program execution.
+ */
+int main()
+{
+  calc c;
+  cout << c.add(12, 34) << endl;     // Calls the add() method with two parameters.
+  cout << c.add(10, 20, 90) << endl; // Calls the add() method with three parameters.
+  return 0;
+}

Overloading/Function/Integer-Addition-Using-Overloaded-Methods-Parameters.cpp

@@ -6,16 +6,41 @@ class Complex
 {
 private:
   int real, imag;
+
 public:
+  /**
+   * @brief Default constructor for the Complex class.
+   *
+   * Initializes the real and imaginary parts of the complex number to 0.
+   */
   Complex()
   {
     real = imag = 0;
   }
-  Complex (int r, int i)
+
+  /**
+   * @brief Constructor for the Complex class.
+   *
+   * Initializes a complex number with given real and imaginary parts.
+   *
+   * @param r The real part of the complex number.
+   * @param i The imaginary part of the complex number.
+   */
+  Complex(int r, int i)
   {
     real = r;
     imag = i;
   }
+
+  /**
+   * @brief Converts the complex number to a string representation.
+   *
+   * This function generates a string representation of the complex number in the format "(real+imaginaryi)".
+   * If the imaginary part is zero, it is omitted from the string.
+   * If the imaginary part is negative, its absolute value is used and a minus sign is added before it.
+   *
+   * @return A string representation of the complex number.
+   */
   string to_string()
   {
     stringstream ss;
@@ -33,10 +58,20 @@ class Complex
     return ret;
   }
 };
+
+/**
+ * @brief Main function to demonstrate the usage of the Complex class.
+ *
+ * This function creates two Complex objects, c1 and c2, with given real and imaginary parts.
+ * It then adds these two complex numbers using the overloaded '+' operator and stores the result in the 'res' variable.
+ * Finally, it prints the string representation of the result using the 'to_string' method of the Complex class.
+ *
+ * @return 0 to indicate successful program execution.
+ */
 int main()
 {
-  Complex c1(8, -5), c2(2, 3);
-  Complex res = c1 + c2;
-  cout << res.to_string();
+  Complex c1(8, -5), c2(2, 3); ///< Initialize two Complex objects with given real and imaginary parts.
+  Complex res = c1 + c2;       ///< Add the two complex numbers using the overloaded '+' operator.
+  cout << res.to_string();     ///< Print the string representation of the result.
+  return 0;
 }
-