update documetnation

This commit is contained in:
Krishna Vedala 2020-06-24 10:37:15 -04:00
parent 94a494edf5
commit 631b50cede
No known key found for this signature in database
GPG Key ID: BA19ACF8FC8792F7

View File

@ -1,18 +1,27 @@
/* This class specifies the basic operation on a stack as a linked list */ /**
* @file stack.h
* @author danghai
* @brief This class specifies the basic operation on a stack as a linked list
**/
#ifndef DATA_STRUCTURES_STACK_H_ #ifndef DATA_STRUCTURES_STACK_H_
#define DATA_STRUCTURES_STACK_H_ #define DATA_STRUCTURES_STACK_H_
#include <cassert> #include <cassert>
#include <iostream> #include <iostream>
/* Definition of the node */ /** Definition of the node as a linked-list
* \tparam Type type of data nodes of the linked list should contain
*/
template <class Type> template <class Type>
struct node { struct node {
Type data; Type data; ///< data at current node
node<Type> *next; node<Type> *next; ///< pointer to the next ::node instance
}; };
/* Definition of the stack class */ /** Definition of the stack class
* \tparam Type type of data nodes of the linked list in the stack should
* contain
*/
template <class Type> template <class Type>
class stack { class stack {
public: public:
@ -135,7 +144,7 @@ class stack {
private: private:
node<Type> *stackTop; /**< Pointer to the stack */ node<Type> *stackTop; /**< Pointer to the stack */
int size; int size; ///< size of stack
}; };
#endif // DATA_STRUCTURES_STACK_H_ #endif // DATA_STRUCTURES_STACK_H_