Class:nsTDeque: Difference between revisions

Class:nsTDeque (view source)

Revision as of 17:51, 15 June 2006

1,510 bytes added , 15 June 2006

no edit summary

Darin

272

edits

@@ Line 21: / Line 21: @@
     &nbsp;
     /**
-     * Returns the number of elements in the deque.
+     * @returns
+    *   The number of elements in the deque.
      */
     PRUint32 Length();  // or Count() ?
+   &nbsp;
+   /**
+    * @returns
+    *   PR_TRUE if the deque contains no elements and PR_FALSE otherwise.
+    */
+   PRBool IsEmpty();
     &nbsp;
     /**
      * Adds a new element to the front of the deque.
      * @param obj
-     *    The object to be added.
+     *   The object to be added.
      */
     void PushFront(const T& obj);
     &nbsp;
     /**
-     * Adds a new element to the front of the deque.
+     * Adds a new element using T's default constructor to the front of the
-     * @returns the address of the newly added element.
+    * deque.
+     * @returns
+    *   The address of the newly added element or null if the object
+    *   could not be allocated.
      */
     T* PushFront();
     &nbsp;
+   /**
+    * Adds a new element to the back of the deque.
+    * @param obj
+    *   The object to be added.
+    */
     void PushBack(const T& obj);
+   &nbsp;
+   /**
+    * Adds a new element using T's default constructor to the back of the
+    * deque.
+    * @returns
+    *   The address of the newly added element or null if the object
+    *   could not be allocated.
+    */
     T* PushBack();
+   &nbsp;
+   /**
+    * @returns
+    *   A const reference to the element at the front of the deque.
+    *   It is an error to call this method on an empty deque.
+    */
     const T& Front() const;
+   &nbsp;
+   /**
+    * @returns
+    *   A reference to the element at the front of the deque.
+    *   It is an error to call this method on an empty deque.
+    */
     T& Front();
+   &nbsp;
+   /**
+    * @returns
+    *   A const reference to the element at the back of the deque.
+    *   It is an error to call this method on an empty deque.
+    */
     const T& Back() const;
+   &nbsp;
+   /**
+    * @returns
+    *   A reference to the element at the back of the deque.
+    *   It is an error to call this method on an empty deque.
+    */
     T& Back();
+   &nbsp;
+   /**
+    * Removes the element at the front of the deque.  This method
+    * has no effect if the deque is empty.
+    */
     void PopFront();
+   &nbsp;
+   /**
+    * Removes the element at the back of the deque.  This method
+    * has no effect if the deque is empty.
+    */
     void PopBack();
   };