[FEATURE REQUEST] Enhance In-Code Documentation with Algorithm and Complexity Analysis of SLL

[FatinShadab]

Describe the feature

The current in-code documentation (using Doxygen-style comments, as seen in sll.h) is excellent for describing what a function does. However, to make C-STRUCTURE a more comprehensive educational and resource-full repository for developers, we should enhance the documentation to explain how the function works, its performance characteristics, and its resource usage.

I request that we update the in-code documentation template to include the Algorithm, Time Complexity, and Space Complexity for every function implementation across all header files (starting with sll.h and dll.h).

It should be implemented because

Using the "insertAtHead__int" function as an example, the documentation should be extended as follows:

// sll.c
 * @brief Inserts a new node with the given data at the head of the singly linked list.
 *
 * [Existing detailed description...]
 *
 * @param sll Pointer to the singly linked list structure.
 * @param data data to be inserted into the linked list.
 *
 * @return void
 *
 * // --- NEW SECTIONS BELOW ---
 * @algorithm
 * 1. Allocate memory for a new node.
 * 2. Assign the input data to the new node.
 * 3. If the list is empty (head is NULL), set the new node as both head and tail.
 * 4. If the list is not empty, set the new node's next pointer to the current head.
 * 5. Update the list's head to be the new node.
 * 6. Increment the list size.
 *
 * @complexity
 * - Time: O(1) - The operation involves a fixed number of steps (memory allocation, pointer manipulation) regardless of the list size.
 * - Space: O(1) - A single new node is allocated, making the space requirement constant relative to the list size.
 *
 * @note The function updates the size, head, and tail pointers of the linked list accordingly.
 */
void insertAtHead__int(SLL__int* sll, int data) {
    // ... function implementation ...
}

Benefits

Educational Value: Developers, especially beginners, can immediately understand the efficiency and underlying mechanism of the data structure operation.

Performance Insight: Provides experienced developers with quick performance characteristics for integrating the functions into their projects.

Consistency: Establishes a higher standard for documentation throughout the repository.

Additional context

No response

Would you like to work on this issue?

None

[Salmashopna]

Thanks I'll start working on the issue.