Enhance documentation to document what the key is for.
authorDavid ‘Bombe’ Roden <bombe@pterodactylus.net>
Wed, 23 Mar 2011 19:23:32 +0000 (20:23 +0100)
committerDavid ‘Bombe’ Roden <bombe@pterodactylus.net>
Wed, 23 Mar 2011 19:23:32 +0000 (20:23 +0100)
src/main/java/net/pterodactylus/sone/data/Image.java

index 587c15e..e7f28d8 100644 (file)
@@ -34,7 +34,7 @@ public class Image implements Fingerprintable {
        /** The Sone the image belongs to. */
        private Sone sone;
 
-       /** The key of the image. */
+       /** The request key of the image. */
        private String key;
 
        /** The creation time of the image. */
@@ -107,20 +107,20 @@ public class Image implements Fingerprintable {
        }
 
        /**
-        * Returns the key of this image.
+        * Returns the request key of this image.
         *
-        * @return The key of this image
+        * @return The request key of this image
         */
        public String getKey() {
                return key;
        }
 
        /**
-        * Sets the key of this image. The key can only be set as long as no key has
-        * yet been set.
+        * Sets the request key of this image. The request key can only be set as
+        * long as no request key has yet been set.
         *
         * @param key
-        *            The new key of this image
+        *            The new request key of this image
         * @return This image
         */
        public Image setKey(String key) {