Diff: queue.h

Revision:

1:2670ac23765f

Parent:

0:a03810d46457

--- a/queue.h	Fri Oct 22 22:07:25 2010 +0000
+++ b/queue.h	Thu Nov 17 04:02:11 2016 +0000
@@ -1,4 +1,4 @@
-/* mbed Queue Library
+/* mbed queue Library
  * Copyright (c) 2010 William Basser ( wbasser [at] gmail [dot] com )
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -36,60 +36,60 @@
  * #include "queue.h"
  *
  * Serial myPc( USBTX, USBRX );
- * Queue myQueue( 1, 5 );
+ * queue myqueue( 1, 5 );
  *
  * int main() 
  * {
  *    unsigned char   nTemp;
  *   
  *    // display the number of items in the queue
- *    myPc.printf( "Items in queue: %d\r", myQueue.GetNumberOfItems( ));
+ *    myPc.printf( "Items in queue: %d\r", myqueue.GetNumberOfItems( ));
  *    
  *    // add item to queue
  *    nTemp = 5;
- *    myQueue.Put( &nTemp );
+ *    myqueue.Put( &nTemp );
  *    nTemp = 6;
- *    myQueue.Put( &nTemp );
+ *    myqueue.Put( &nTemp );
  *    nTemp = 7;
- *    myQueue.Put( &nTemp );
+ *    myqueue.Put( &nTemp );
  *    
  *    // display the number of items in the queue
- *    myPc.printf( "Items in queue: %d\r", myQueue.GetNumberOfItems( ));
+ *    myPc.printf( "Items in queue: %d\r", myqueue.GetNumberOfItems( ));
  *    
  *    // peek at item at the top of the queue
- *    myQueue.Peek( &nTemp );
+ *    myqueue.Peek( &nTemp );
  *    myPc.printf( "Peek: %d\r", nTemp );
  *    
  *    // get an item from queue
- *    myQueue.Get( &nTemp );
+ *    myqueue.Get( &nTemp );
  *    myPc.printf( "Item 0 = %d\r", nTemp );
- *    myQueue.Get( &nTemp );
+ *    myqueue.Get( &nTemp );
  *    myPc.printf( "Item 1 = %d\r", nTemp );
  *    
  *    // queue should be empty
- *    if ( !myQueue.Get( &nTemp ))
+ *    if ( !myqueue.Get( &nTemp ))
  *    {
  *        // queue is empty
- *        myPc.printf( "Queue empty!\r" );
+ *        myPc.printf( "queue empty!\r" );
  *    }
  * }
  *
  * @endcode
  */
 
-class Queue {
+class queue {
 public:
-    /** Create a Queue object
+    /** Create a queue object
      *
      * @param iSize size of the object in queue
      * @param iCount number of items in the queue
      */
-    Queue( int iSize, int iCount );
+    queue( int iSize, int iCount );
 
     /** destruction
      *
      */
-    virtual ~Queue( void );
+    virtual ~queue( void );
 
     /** Add item to queue
      *