make cpset, pset_new API private
[libfirm] / include / libfirm / adt / pqueue.h
index 28081f2..35e585a 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 1995-2008 University of Karlsruhe.  All right reserved.
+ * Copyright (C) 1995-2011 University of Karlsruhe.  All right reserved.
  *
  * This file is part of libFirm.
  *
  * @author  Christian Wuerdig
  * @brief   Implementation of a priority queue. This is the ported version of
             the original Java implementation by Matthias Braun.
- * @version $Id$
  */
 #ifndef FIRM_ADT_PQUEUE_H
 #define FIRM_ADT_PQUEUE_H
 
 #include "../begin.h"
 
+/**
+ * @ingroup adt
+ * @defgroup pqueue  Priority Queue
+ * A priority queue.
+ * Implementation based on a heap datastructure
+ * @{
+ */
+
+/** priority queue */
 typedef struct pqueue_t pqueue_t;
 
 /**
@@ -64,7 +72,7 @@ FIRM_API void *pqueue_pop_front(pqueue_t *q);
  * @param q   The priority queue.
  * @return The length of the queue.
  */
-FIRM_API int pqueue_length(const pqueue_t *q);
+FIRM_API size_t pqueue_length(const pqueue_t *q);
 
 /**
  * Returns true if queue is empty.
@@ -73,6 +81,8 @@ FIRM_API int pqueue_length(const pqueue_t *q);
  */
 FIRM_API int pqueue_empty(const pqueue_t *q);
 
+/** @} */
+
 #include "../end.h"
 
 #endif