X-Git-Url: https://git.auder.net/?p=cgds.git;a=blobdiff_plain;f=src%2FQueue.h;h=9aae379fbba78e740c9245cf836e12ca6f6e5825;hp=0cd97665b2ed0ad4cce98b3a1fa0296f68cb9190;hb=1ff641f9960fa6c6081817a5641afb22fad91dcd;hpb=71e16e325e3936549a5f3a140e6298fce333fd27 diff --git a/src/Queue.h b/src/Queue.h index 0cd9766..9aae379 100644 --- a/src/Queue.h +++ b/src/Queue.h @@ -30,24 +30,24 @@ void _queue_init( size_t dataSize ///< Size in bytes of a queue element. ); -/** +/** * @brief Return an allocated and initialized queue. */ Queue* _queue_new( size_t dataSize ///< Size in bytes of a queue element. ); -/** +/** * @brief Return an allocated and initialized queue. * @param type Type of a queue element (int, char*, ...). - * + * * Usage: Queue* queue_new( type) */ #define queue_new(type) \ _queue_new(sizeof(type)) /** - * @brief Copy constructor (works well if items do not have allocated sub-pointers). + * @brief Copy constructor (shallow copy, ok for basic types). */ Queue* queue_copy( Queue* queue ///< "this" pointer. @@ -56,7 +56,7 @@ Queue* queue_copy( /** * @brief Check if the queue is empty. */ -Bool queue_empty( +bool queue_empty( Queue* queue ///< "this" pointer. ); @@ -79,7 +79,7 @@ void _queue_push( * @brief Add something at the end of the queue. * @param queue "this" pointer * @param data Data to be pushed. - * + * * Usage: void queue_push(Queue* queue, void data) */ #define queue_push(queue, data) \ @@ -99,7 +99,7 @@ void* _queue_peek( * @brief Return what is at the beginning of the queue. * @param queue "this" pointer. * @param data Data to be assigned. - * + * * Usage: void queue_peek(Queue* queue, void data) */ #define queue_peek(queue, data) \