Added documentation for functions

Added documentation for functions

Author: madhurimarawat

Constructor/Copy-constructor-code.cpp

@@ -1,15 +1,47 @@
+/**
+ * @brief This program demonstrates the usage of constructors in a Student class.
+ *
+ * The Student class has member variables for roll number, name, and id.
+ * It includes a parameterized constructor and a copy constructor.
+ * The parameterized constructor initializes the roll number, name, and id.
+ * The copy constructor creates a new student object by copying the values from another student object.
+ *
+ * The main function prompts the user to enter roll number, name, and id number.
+ * It then creates two student objects: s1 using the parameterized constructor,
+ * and s2 using the copy constructor.
+ */
+
+// Including Header File
 #include <iostream>
-#include <stdio.h>
+
+// Using Namespace
 using namespace std;
+
+/// @brief Class for Student object.
 class student
 {
-//wap for  copy constructor
 public:
   int roll;
   string name;
+
 private:
   int id;
+
 public:
+  /**
+   * @brief Constructor for the student class that initializes the roll number, name, and id.
+   *
+   * This constructor takes three parameters: roll number (n1), name (n2), and id (n3).
+   * It assigns the values of n1, n2, and n3 to the corresponding member variables roll, name, and id.
+   * The id is assigned twice, which is redundant and can be optimized.
+   *
+   * @param n1 The roll number of the student.
+   * @param n2 The name of the student.
+   * @param n3 The id of the student.
+   *
+   * @return No return value.
+   */
+
   student(int n1, string n2, int n3)
   {
     roll = n1;
@@ -21,6 +53,23 @@ class student
     cout << "Name  is:" << name << endl;
     cout << "Id  is:" << id << endl;
   }
+
+  /**
+   * @brief Copy constructor for the student class.
+   *
+   * This copy constructor creates a new student object by copying the values of another student object.
+   * It initializes the roll number, name, and id of the new object with the corresponding values from the given student object.
+   *
+   * @param s1 The reference to the student object from which the values will be copied.
+   *
+   * @return No return value.
+   *
+   * @note The copy constructor is called when a new object is created as a copy of an existing object.
+   * @note The copy constructor is automatically called when an object is passed by value or returned by value.
+   * @note The copy constructor is not called when an object is passed by reference or returned by reference.
+   * @note The copy constructor can be explicitly called using the syntax: student s2(s1); or student s2 = s1;
+   */
+
   student(const student &s1)
   {
     roll = s1.roll;
@@ -32,6 +81,19 @@ class student
     cout << "Id  is:" << id << endl;
   }
 };
+
+/**
+ * @brief The main function of the program.
+ *
+ * This function prompts the user to enter roll number, name, and id number.
+ * It then creates two student objects: s1 using the parameterized constructor,
+ * and s2 using the copy constructor.
+ *
+ * @return 0 to indicate successful program execution.
+ *
+ * @note The main function demonstrates the usage of the student class constructors.
+ */
+
 int main()
 {
   int x, z;

Constructor/Count-number-of-object.cpp

@@ -1,24 +1,72 @@
+/**
+ * @brief This program demonstrates the usage of constructors and destructors in a C++ class.
+ *
+ * The calc class is defined with a constructor and a destructor.
+ * The constructor increments a static counter each time an object is created,
+ * and the destructor decrements the counter each time an object is destroyed.
+ * The main function creates four instances of the calc class,
+ * which triggers the constructor and destructor for each object.
+ *
+ * The program outputs the number of objects created and destroyed at each step.
+ * This helps illustrate the concept of object lifetime management in C++.
+ *
+ * @return 0 - Indicates successful program execution.
+ */
+
+/*WAP in C++ which defines a class with constructor and destructor
+which will count number of objects created and destroyed.*/
+
+// Including Header File
 #include <iostream>
+
+// Using Namespace
 using namespace std;
+
+// Declaring Static Variable
 int count = 0;
-/*WAP in C++ which defines a class with constructor and destructor
-which will count number of objects created and destroyed.*/
+
+/// @brief Class for Calculation
 class calc
 {
 public:
+  /**
+   * @brief Constructor for the calc class.
+   *
+   * This constructor increments the static count variable each time an object of the calc class is created.
+   * It then outputs the current number of objects created to the console.
+   */
+
   calc()
   {
     count++;
     cout << "Number of objects created:" << count << endl;
   }
+
+  /**
+   * @brief Destructor for the calc class.
+   *
+   * This destructor decrements the static count variable each time an object of the calc class is destroyed.
+   * It then outputs the current number of objects remaining to the console.
+   */
+
   ~calc()
   {
     cout << "Number of objects destroyed:" << count << endl;
     count--;
   }
 };
+
+/**
+ * @brief The main function of the program.
+ *
+ * This function creates four instances of the calc class and then exits.
+ * The calc class has a constructor and destructor that keep track of the number of objects created and destroyed.
+ *
+ * @return 0 - Indicates successful program execution.
+ */
+
 int main()
 {
-  calc c1, c2, c3, c4;
+  calc c1, c2, c3, c4; // Creating four instances of the calc class
   return 0;
 }

Constructor/Default-constructor-code.cpp

@@ -1,11 +1,36 @@
+/**
+ * @brief This program demonstrates the usage of a simple class representing flowers.
+ *
+ * The program defines a class called 'flower' with private member variables for two flower names.
+ * It includes a default constructor that initializes the flower names and prints out a message.
+ * The main function creates an instance of the flower class and terminates the program.
+ */
+
+// Including Header File
 #include <iostream>
+
+// Using Namespace
 using namespace std;
+
+// Defining the flower class
 class flower
 {
 private:
   string f1;
   string f2;
+
 public:
+  /**
+   * @brief Default constructor for the flower class.
+   *
+   * This constructor initializes the private member variables f1 and f2 with default values.
+   * It also prints out a message indicating that the default constructor has been called,
+   * along with the names of the two flowers.
+   *
+   * @param None
+   * @return None
+   */
+
   flower()
   {
     f1 = "Lily";
@@ -15,6 +40,17 @@ class flower
     cout << "Second flower is:" << f2 << endl;
   }
 };
+
+/**
+ * @brief The main function of the program.
+ *
+ * This function serves as the entry point for the program. It creates an instance of the flower class
+ * and then returns 0 to indicate successful program termination.
+ *
+ * @param None
+ * @return 0 - Indicates successful program termination.
+ */
+
 int main()
 {
   flower fl;

Constructor/Destructor-code.cpp

@@ -1,32 +1,127 @@
+/**
+ * @brief This program demonstrates the usage of a simple point class in C++.
+ *
+ * The point class has attributes for length and provides methods to set and retrieve the length value.
+ * The main function creates two point objects, sets their lengths, and prints their lengths.
+ */
+
+// Including Header File
 #include <iostream>
+
+// Using Namespace
 using namespace std;
+
+// Definition of Point Class
 class point
 {
 public:
+  /**
+   * @brief Sets the length of the point object.
+   *
+   * This function updates the Length attribute of the point object with the provided length value.
+   *
+   * @param len The new length value to be assigned to the point object.
+   *
+   * @return void
+   */
   void setLength(int len);
+
+  /**
+   * @brief Retrieves the length of the point object.
+   *
+   * This function retrieves the current length value of the point object.
+   *
+   * @return An integer representing the length of the point object.
+   */
+
   int getLength(void);
+
+  /**
+   * @brief Default constructor for the point class.
+   *
+   * This constructor initializes a new point object with default values.
+   * The Length attribute is set to 0.
+   *
+   * @return void
+   */
   point();
+
+  /**
+   * @brief Destructor for the point class.
+   *
+   * This destructor is responsible for cleaning up the resources allocated by the point object.
+   * It prints a message indicating that the object is being deleted and displays its current length.
+   *
+   * @return void
+   */
   ~point();
+
 private:
   double Length;
 };
+
+/**
+ * @brief Default constructor for the point class.
+ *
+ * This constructor initializes a new point object with default values.
+ * The Length attribute is set to 0.
+ *
+ * @return void
+ */
 point::point(void)
 {
   cout << "object is being created" << endl;
 }
+
+/**
+ * @brief Destructor for the point class.
+ *
+ * This destructor is responsible for cleaning up the resources allocated by the point object.
+ * It prints a message indicating that the object is being deleted and displays its current length.
+ *
+ * @return void
+ */
 point::~point(void)
 {
   cout << "object is being deleted:" << getLength() << endl;
 }
+
+/**
+ * @brief Sets the length of the point object.
+ *
+ * This function updates the Length attribute of the point object with the provided length value.
+ *
+ * @param len The new length value to be assigned to the point object. It should be a non-negative integer.
+ *
+ * @return void
+ */
 void point::setLength(int len)
 {
   Length = len;
 }
+
+/**
+ * @brief Retrieves the length of the point object.
+ *
+ * This function retrieves the current length value of the point object.
+ *
+ * @return An integer representing the length of the point object.
+ *         The length value is a non-negative integer.
+ */
 int point::getLength(void)
 {
   return Length;
 }
 
+/**
+ * @brief The main function of the program.
+ *
+ * This function demonstrates the usage of the point class by creating two point objects,
+ * setting their lengths, and printing their lengths.
+ *
+ * @return An integer representing the exit status of the program.
+ *         A return value of 0 indicates successful execution.
+ */
 int main()
 {
   point l;
@@ -36,4 +131,4 @@ int main()
   l1.setLength(60);
   cout << "Length of object is:" << l1.getLength() << endl;
   return 0;
-}
+}