From 4da79ad8f2dfa4e306a7efb2ee36655d5d7027d5 Mon Sep 17 00:00:00 2001
From: hns <hannesw@gmail.com>
Date: Fri, 25 Apr 2003 14:27:47 +0000
Subject: [PATCH] Just filled in a few javadocs

---
 src/helma/objectmodel/db/DbKey.java | 14 +++++++-------
 1 file changed, 7 insertions(+), 7 deletions(-)

diff --git a/src/helma/objectmodel/db/DbKey.java b/src/helma/objectmodel/db/DbKey.java
index 8f947bbb..bf7bb5a3 100644
--- a/src/helma/objectmodel/db/DbKey.java
+++ b/src/helma/objectmodel/db/DbKey.java
@@ -46,9 +46,9 @@ public final class DbKey implements Key, Serializable {
     /**
      *
      *
-     * @param what ...
+     * @param what the other key to be compared with this one
      *
-     * @return ...
+     * @return true if both keys are identical
      */
     public boolean equals(Object what) {
         if (what == this) {
@@ -69,7 +69,7 @@ public final class DbKey implements Key, Serializable {
     /**
      *
      *
-     * @return ...
+     * @return this key's hash code
      */
     public int hashCode() {
         if (hashcode == 0) {
@@ -84,7 +84,7 @@ public final class DbKey implements Key, Serializable {
     /**
      *
      *
-     * @return ...
+     * @return the key of this key's object's parent object
      */
     public Key getParentKey() {
         return null;
@@ -93,7 +93,7 @@ public final class DbKey implements Key, Serializable {
     /**
      *
      *
-     * @return ...
+     * @return the unique storage name for this key's object
      */
     public String getStorageName() {
         return storageName;
@@ -102,7 +102,7 @@ public final class DbKey implements Key, Serializable {
     /**
      *
      *
-     * @return ...
+     * @return this key's object's id
      */
     public String getID() {
         return id;
@@ -111,7 +111,7 @@ public final class DbKey implements Key, Serializable {
     /**
      *
      *
-     * @return ...
+     * @return a string representation for this key
      */
     public String toString() {
         return (storageName == null) ? ("[" + id + "]") : (storageName + "[" + id + "]");