Version 0.6 (#4)

* Added missing keywords

* Updated tutorial

* fix for memory problem on item removing

* Fixed comments

* Removed doxygen

* New version

Author: SloCompTech

README.md

@@ -1,7 +1,7 @@
 # QList
 Linked list library for Arduino
 
-Purpose of this library is to enable programers to create lists of things
+Purpose of this library is to enable programmers to create lists of things
 
 Before we can start using library, we need to include library to our sketch
 ``` C++
@@ -48,6 +48,7 @@ Items on the list can accessed:
   */
   int val3 = list.at(index);
   int val3 = list.get(index);
+  int val3 = list[index];
 ```
 
 Values of items that are already in the list, can be changed:

keywords.txt

@@ -9,3 +9,5 @@ get KEYWORD2
 size  KEYWORD2
 clear KEYWORD2
 at  KEYWORD2
+length  KEYWORD2
+indexOf KEYWORD2

library.properties

@@ -1,5 +1,5 @@
 name=QList
-version=0.5.1
+version=0.6.0
 author=SloCompTech
 maintainer=SloCompTech <[email protected]>
 sentence=Library implements linked lists

src/QList.cpp

@@ -129,7 +129,7 @@ void QList<T>::clear()
   {
     tmp = start;
     start = start->next;
-    delete tmp;
+    delete tmp; // Delete item
     len--; // Decrease counter
   }
   end = NULL;
@@ -153,6 +153,7 @@ void QList<T>::clear(unsigned int index)
         end = tmp->prev;
 
       len--; // Decrease counter
+      delete tmp; // Delete item
       break;
     }
   }

src/QList.h

@@ -1,22 +1,10 @@
-/**
- * @file
- * @author  SloCompTech <[email protected]>
- * @version 1.0
- *
- * @section DESCRIPTION
- *
- * This class enables to use linked lists
- */
-
 #ifndef LIB_SCP_QLIST
 #define LIB_SCP_QLIST
 
 #ifndef NULL
-#define NULL 0
+  #define NULL 0
 #endif
 
-
-
 template<class T>
 class QList
 {
@@ -27,24 +15,24 @@ class QList
     node *next,*prev;
   }node;
 
-  int len; //!< Size of list >
-  node *start,*end; //!< Pointers to start and end >
+  int len; // Size of list 
+  node *start,*end; // Pointers to start and end
 
 public:
-  QList(); //!< Class constructor >
-  ~QList(); //!< Class destructor >
-
-  void push_back(const T i); //!< Push item at the back of list >
-  void push_front(const T i);//!< Push item at the front of the list >
-  void pop_back(); //!< Pops item from back >
-  void pop_front(); //!< Pops item from front >
-  T front(); //!< get item from front >
-  T back(); //!< get item from back >
-  int size(); //!< Returns size of list >
-  void clear(); //!< Clears list >
-  void clear(unsigned int index); //!< Clears list >
-  T get(unsigned int index); //!< Get item at given index >
-  T& at(unsigned int index); //!< Get item at given index >
+  QList(); // Class constructor
+  ~QList(); // Class destructor
+
+  void push_back(const T i); // Push item at the back of list
+  void push_front(const T i);// Push item at the front of the list
+  void pop_back(); // Pops item from back 
+  void pop_front(); // Pops item from front
+  T front(); // get item from front
+  T back(); // get item from back
+  int size(); // Returns size of list
+  void clear(); // Clears list
+  void clear(unsigned int index); // Clears list
+  T get(unsigned int index); // Get item at given index 
+  T& at(unsigned int index); // Get item at given index 
 
   // Array operator
   T& operator[](unsigned int index);