Added documentation

Added documentation for each function of the code

Author: madhurimarawat

Class/Array-of-object-code.cpp

@@ -1,10 +1,28 @@
+/**
+ * @brief This program demonstrates the implementation of an array of objects in C++.
+ *
+ * The program defines a class `emp` to represent an employee with private attributes `id`, `name`, and `salary`.
+ * The class provides public member functions `getdata` and `putdata` to set and display the employee data, respectively.
+ *
+ * In the `main` function, an array of `emp` objects `e1` is declared with a size of 23.
+ * The user is prompted to enter the number of employee data to be stored.
+ * Then, a loop is used to get and display the employee data using the `getdata` and `putdata` functions.
+ *
+ */
+
+// Program in C++ to implement array of object
+// Including Header Files
 #include <iostream>
+
+// Using namespace
 using namespace std;
-//program to implement array of object
+
+// Employee class
 class emp
 {
 private:
   int id;
+
 public:
   string name;
   float salary;
@@ -22,6 +40,8 @@ class emp
     cout << "Salary is:" << salary << "" << endl;
   }
 };
+
+// Main function
 int main()
 {
   emp e1[23];

Class/Book-class-code.cpp

@@ -1,14 +1,47 @@
+/**
+ * @file book.cpp
+ * @brief This program demonstrates the usage of a book class in C++.
+ *
+ * The book class has private member variables for id, name, writer, subject, and course.
+ * It provides public member functions to insert and display book details. The main function
+ * demonstrates the usage of the book class by creating two book objects, allowing the user
+ * to input details for each book, inserting the details into the book objects using the
+ * insert() function, and displaying the details using the display() function.
+ */
+
+// Including Header File
 #include <iostream>
+
+// Using Namespace
 using namespace std;
+
+/// @brief Class for book
 class book
 {
 private:
   int id;
+
 public:
   string name;
   string writer;
   string subject;
   string course;
+
+  /**
+   * @brief Inserts book details into the object.
+   *
+   * This function takes five parameters and assigns them to the corresponding
+   * member variables of the book object.
+   *
+   * @param i An integer representing the book's unique identifier.
+   * @param n A string representing the book's name.
+   * @param w A string representing the book's writer.
+   * @param s A string representing the book's subject.
+   * @param c A string representing the course the book is associated with.
+   *
+   * @return void This function does not return any value.
+   */
+
   void insert(int i, string n, string w, string s, string c)
   {
     id = i;
@@ -17,18 +50,39 @@ class book
     subject = s;
     course = c;
   }
+
+  /**
+   * @brief Displays the book details.
+   *
+   * This function prints out the details of the book object, including its unique identifier, name, writer, subject, and course.
+   *
+   * @return void This function does not return any value.
+   */
+
   void display()
   {
     cout << "Book details are:" << endl;
     cout << "Id is:" << id << "" << endl;
     cout << "Name is:" << name << "" << endl;
-    cout << "writer is:" << writer << "" << endl;
-
-    cout << "subject is:" << subject << "" << endl;
-    cout << "course is:" << course << "" << endl;
+    cout << "Writer is:" << writer << "" << endl;
 
+    cout << "Subject is:" << subject << "" << endl;
+    cout << "Course is:" << course << "" << endl;
   }
 };
+
+/**
+ * @brief The main function of the program.
+ *
+ * This function demonstrates the usage of the book class by creating two book objects,
+ * b1 and b2, and allowing the user to input details for each book. The details are then
+ * inserted into the book objects using the insert() function, and displayed using the
+ * display() function.
+ *
+ * @return An integer representing the exit status of the program. A return value of 0
+ * indicates that the program executed successfully.
+ */
+
 int main()
 {
   book b1;

Class/Demo-class1.cpp

@@ -1,20 +1,67 @@
+/**
+ * @brief This file contains the implementation of a simple class 'demo' that demonstrates
+ * the usage of input and output operations on private member variables.
+ *
+ * The 'demo' class has two private integer member variables 'a' and 'b'. It provides
+ * two public member functions: 'input' to accept user input and store it in the private
+ * member variables, and 'show' to display the values of the private member variables.
+ *
+ * The main function creates an instance of the 'demo' class, calls the 'input' and 'show'
+ * methods, and then returns 0 to indicate successful program termination.
+ */
+
+// Including Header File
 #include <iostream>
+
+// Using Namespace
 using namespace std;
+
+/// @brief Class for demo
 class demo
 {
 private:
   int a, b;
+
 public:
+  /**
+   * @brief This function is used to input two integer values into the class object.
+   *
+   * This function prompts the user to enter two integer values and stores them in the
+   * private member variables 'a' and 'b' of the class.
+   *
+   * @return This function does not return any value.
+   */
+
   void input()
   {
     cout << "Enter value: ";
     cin >> a >> b;
   }
+
+  /**
+   * @brief This function is used to display the values of the private member variables 'a' and 'b'.
+   *
+   * This function outputs the values of the private member variables 'a' and 'b' to the standard output stream.
+   * The values are separated by a tab character.
+   *
+   * @return This function does not return any value.
+   */
+
   void show()
   {
     cout << a << "\t" << b;
   }
 };
+
+/**
+ * @brief The main function of the program.
+ *
+ * This function creates an instance of the 'demo' class, calls the 'input' and 'show' methods,
+ * and then returns 0 to indicate successful program termination.
+ *
+ * @return 0 - Indicates successful program termination.
+ */
+
 int main()
 {
   demo ob;

Class/Demo-class2.cpp

@@ -1,22 +1,68 @@
+/**
+ * @brief This program demonstrates the usage of a simple student class with attributes for id and name.
+ *        The class includes methods to insert and display student information.
+ *
+ * @details The student class has two public attributes: id (integer) and name (string).
+ *          It includes two public methods: insert and display.
+ *          The insert method sets the id and name attributes of the student object.
+ *          The display method prints the id and name attributes of the student object to the console.
+ *          The main function creates two student objects, s1 and s2, and calls the insert and display methods on them.
+ */
+
+// Including Header File
 #include <iostream>
+
+// Using Namespace
 using namespace std;
+
+/// @brief Class for student
 class student
 {
 public:
   int id;
   string name;
+
+  /**
+   * @brief Inserts values into the student object.
+   *
+   * This function sets the id and name attributes of the student object.
+   *
+   * @param i An integer representing the student's id.
+   * @param n A string representing the student's name.
+   *
+   * @return void
+   */
+
   void insert(int i, string n)
   {
     id = i;
     name = n;
   }
+
+  /**
+   * @brief Displays the student's id and name.
+   *
+   * This function prints the id and name attributes of the student object to the console.
+   *
+   * @return void
+   */
+
   void display()
   {
     cout << "Id is:" << id << "" << endl;
     cout << "Name is:" << name << "" << endl;
-
   }
 };
+
+/**
+ * @brief The main function of the program.
+ *
+ * This function creates two student objects, s1 and s2, and calls the insert and display methods on them.
+ *
+ * @return An integer representing the exit status of the program.
+ *         - 0: The program executed successfully.
+ */
+
 int main()
 {
   student s1;

Class/Employee-class-code.cpp

@@ -1,18 +1,56 @@
+/**
+ * @brief This program demonstrates the usage of a class to represent employee details.
+ *
+ * The emp class has private member variables for id, name, and salary. It provides public member functions
+ * to insert and display employee details. The main function demonstrates the usage of the emp class by
+ * creating two employee objects, prompting the user to enter employee details, inserting them into the
+ * objects, and displaying the employee details.
+ */
+
+// Including Header File
 #include <iostream>
+
+// Using Namespace
 using namespace std;
+
+/// @brief Class for employee
 class emp
 {
 private:
   int id;
+
 public:
   string name;
   float salary;
+
+  /**
+   * @brief Inserts employee details into the object.
+   *
+   * This function takes three parameters: id, name, and salary. It assigns these values to the corresponding
+   * member variables of the employee object.
+   *
+   * @param i An integer representing the employee's id.
+   * @param n A string representing the employee's name.
+   * @param s A float representing the employee's salary.
+   *
+   * @return void. This function does not return any value.
+   */
+
   void insert(int i, string n, float s)
   {
     id = i;
     name = n;
     salary = s;
   }
+
+  /**
+   * @brief Displays the employee details.
+   *
+   * This function prints the employee's id, name, and salary to the standard output stream.
+   *
+   * @return void. This function does not return any value.
+   */
+
   void display()
   {
     cout << "Employee details are:" << endl;
@@ -21,6 +59,17 @@ class emp
     cout << "Salary is:" << salary << "" << endl;
   }
 };
+
+/**
+ * @brief The main function of the program.
+ *
+ * This function demonstrates the usage of the emp class by creating two employee objects, e1 and e2.
+ * It prompts the user to enter employee details, inserts them into the objects using the insert function,
+ * and then displays the employee details using the display function.
+ *
+ * @return An integer representing the exit status of the program. A return value of 0 indicates successful execution.
+ */
+
 int main()
 {
   emp e1;