From 050f6b178ae092add6c6f1c0d30484737a331b78 Mon Sep 17 00:00:00 2001 From: Alvin Philips Date: Sun, 31 Oct 2021 05:57:24 +0530 Subject: [PATCH] Update doc --- operations_on_datastructures/circular_linked_list.cpp | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/operations_on_datastructures/circular_linked_list.cpp b/operations_on_datastructures/circular_linked_list.cpp index 5c9a465fe..6edf3a468 100644 --- a/operations_on_datastructures/circular_linked_list.cpp +++ b/operations_on_datastructures/circular_linked_list.cpp @@ -1,8 +1,7 @@ /** * @file - * @brief Implementation for the [Union of two sorted - * Arrays](https://en.wikipedia.org/wiki/Union_(set_theory)) - * algorithm. + * @brief Implementation for a [Circular Linked + * List](https://www.geeksforgeeks.org/circular-linked-list/). * @details The Union of two arrays is the collection of all the unique elements * in the first array, combined with all of the unique elements of a second * array. This implementation uses ordered arrays, and an algorithm to correctly @@ -48,12 +47,18 @@ struct Node { } }; +/** + * @brief A class that implements a Circular Linked List. + */ class CircularLinkedList { private: Node* root; ///< Pointer to the root node Node* end; ///< Pointer to the last node public: + /** + * @brief Creates an empty CircularLinkedList. + */ CircularLinkedList() { root = nullptr; end = nullptr;