Commit d096a5cf360c6665d0289948bad9079dc56102e3
2002-12-21T07:15:53
Docs
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76
diff --git a/include/FTList.h b/include/FTList.h
index c920ab9..23c3105 100644
--- a/include/FTList.h
+++ b/include/FTList.h
@@ -3,6 +3,9 @@
#include "FTGL.h"
+/**
+* Provides a non-STL alternative to the STL list
+ */
template <typename FT_LIST_ITEM_TYPE>
class FTGL_EXPORT FTList
{
@@ -12,6 +15,9 @@ class FTGL_EXPORT FTList
typedef const value_type& const_reference;
typedef size_t size_type;
+ /**
+ * Constructor
+ */
FTList()
: listSize(0),
tail(0)
@@ -19,7 +25,10 @@ class FTGL_EXPORT FTList
tail = NULL;
head = new Node;
}
-
+
+ /**
+ * Destructor
+ */
~FTList()
{
Node* temp = head;
@@ -30,12 +39,18 @@ class FTGL_EXPORT FTList
delete head;
}
}
-
+
+ /**
+ * Get the number of items in the list
+ */
size_type size() const
{
return listSize;
}
+ /**
+ * Add an item to the end of the list
+ */
void push_back( const value_type& item)
{
Node* node = new Node( item);
@@ -48,12 +63,18 @@ class FTGL_EXPORT FTList
tail = node;
++listSize;
}
-
+
+ /**
+ * Get the item at the front of the list
+ */
reference front() const
{
return head->next->payload;
}
+ /**
+ * Get the item at the end of the list
+ */
reference back() const
{
return tail->payload;