From f4c21abda6ab01b0cacbebedc6d83ca4b5f07bda Mon Sep 17 00:00:00 2001 From: Inderjeet Singh Date: Thu, 29 Jan 2009 02:43:36 +0000 Subject: [PATCH] updated javadoc in response to issue 97 --- gson/src/main/java/com/google/gson/JsonNull.java | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/gson/src/main/java/com/google/gson/JsonNull.java b/gson/src/main/java/com/google/gson/JsonNull.java index d5db280d..82b0c686 100755 --- a/gson/src/main/java/com/google/gson/JsonNull.java +++ b/gson/src/main/java/com/google/gson/JsonNull.java @@ -59,7 +59,10 @@ public final class JsonNull extends JsonElement { /** * Creation method used to return an instance of a {@link JsonNull}. To reduce the memory * footprint, a single object has been created for this class; therefore the same instance is - * being returned for each invocation of this method. + * being returned for each invocation of this method. This method is kept private since we + * prefer the users to use {@link JsonNull#JsonNull()} which is similar to how other JsonElements + * are created. Note that all instances of JsonNull return true for {@link #equals(Object)} + * when compared to each other. * * @return a instance of a {@link JsonNull} */