From df1dbe48b99a5c86345a58d6da5727cb39547727 Mon Sep 17 00:00:00 2001
From: Paul Buetow <paul@buetow.org>
Date: Thu, 29 May 2008 20:30:46 +0000
Subject: new package documented.

---
 sources/utils/VSPriorityQueue.java | 11 ++++++++---
 1 file changed, 8 insertions(+), 3 deletions(-)

(limited to 'sources/utils/VSPriorityQueue.java')

diff --git a/sources/utils/VSPriorityQueue.java b/sources/utils/VSPriorityQueue.java
index 5b6b765..b320c1d 100644
--- a/sources/utils/VSPriorityQueue.java
+++ b/sources/utils/VSPriorityQueue.java
@@ -7,17 +7,22 @@ package utils;
 import java.util.PriorityQueue;
 
 /**
- * The Class VSPriorityQueue.
+ * The Class VSPriorityQueue. This class is the same like the standard
+ * VSPriorityQueue of the Java API. It only overrides the get(int) method.
+ *
+ * @author Paul C. Buetow
  */
 public final class VSPriorityQueue<T> extends PriorityQueue<T> {
+    /** The serial version uid */
     private static final long serialVersionUID = 1L;
 
     /**
-     * Gets the element.
+     * Gets the specific element. If the index is out of bounds, it will return
+     * null.
      *
      * @param index the index
      *
-     * @return the element.
+     * @return the element, or null, if out of bounds
      */
     public T get(int index) {
         int i = 0;
-- 
cgit v1.2.3