[CircularBuffer] Comments

src/shared/utils/collections/CircularBuffer.h

@@ -62,12 +62,15 @@ public:
 
     /**
      * Gets an element from the buffer, without removing it
-     * Index starts at the element returned by get() or pop(): get(0) is
-     * the same as get()
+     * Index starts from the oldest element in the buffer: get(0) returns the
+     * same element as get()
      *
      * @warning Remember to catch the exception!
+     * @throw range_error if index >= count()
+     *
+     * @param i Index of the elemnt to get, starting from the oldest
+     *
      * @return the element
-     * @throws range_error if buffer is empty
      */
     virtual T& get(unsigned int i)
     {
@@ -81,21 +84,19 @@ public:
     }
 
     /**
-     * @brief Returns the last element added in the buffer
+     * @brief Returns the last element added in the buffer.
+     *
+     * @throw range_error if buffer is empty
      * @warning Remember to catch the exception!
      * @return the element
-     * @throws range_error if buffer is empty
      */
-    virtual T& last()
-    {
-        return get(count() - 1);
-    }
+    virtual T& last() { return get(count() - 1); }
 
     /**
      * Gets the first element from the buffer, without removing it
+     * @throw range_error if buffer is empty
      * @warning Remember to catch the exception!
      * @return the element
-     * @throws range_error if buffer is empty
      */
     virtual T& get()
     {
@@ -109,9 +110,9 @@ public:
 
     /**
      * Pops the first element in the buffer.
+     * @throw range_error if buffer is empty
      * @warning Remember to catch the exception!
      * @return the element that has been popped
-     * @throws range_error if buffer is empty
      */
     virtual const T& pop()
     {