Add documentation to FakeStorageRpc and LocalStorageHelper (googleapis#2906)

yihanzhen · web-flow · commit 18bdfb64f1df · 2018-02-20T16:41:12.000-08:00
* Add documentation to FakeStorageRpc and LocalStorageHelper to reduce confusions
on method list(String bucket, Map options)
diff --git a/google-cloud-contrib/google-cloud-nio/src/main/java/com/google/cloud/storage/contrib/nio/testing/FakeStorageRpc.java b/google-cloud-contrib/google-cloud-nio/src/main/java/com/google/cloud/storage/contrib/nio/testing/FakeStorageRpc.java
@@ -41,7 +41,7 @@
 import javax.annotation.concurrent.NotThreadSafe;
 
 /**
- * A bare-bones in-memory implementation of Storage, meant for testing.
+ * A bare-bones in-memory implementation of StorageRpc, meant for testing.
  *
  * <p>This class is <i>not</i> thread-safe. It's also (currently) limited in the following ways:
  * <ul>
diff --git a/google-cloud-contrib/google-cloud-nio/src/main/java/com/google/cloud/storage/contrib/nio/testing/LocalStorageHelper.java b/google-cloud-contrib/google-cloud-nio/src/main/java/com/google/cloud/storage/contrib/nio/testing/LocalStorageHelper.java
@@ -48,6 +48,10 @@
  *   <li>IAM operations</li>
  *   </ul>
  * </ul>
+ * 
+ * {@link FakeStorageRpc#list(String, Map<Option, ?>)} lists all the objects that have been created rather than
+ * the objects in the provided bucket. Since this class does not support creating, listing and deleting buckets, 
+ * the parameter bucket here is not actually used and on serves as a placeholder.
  */
 public final class LocalStorageHelper {
 

Original file line number	Diff line number	Diff line change
`@@ -41,7 +41,7 @@`
`41`	`41`	`import javax.annotation.concurrent.NotThreadSafe;`
`42`	`42`
`43`	`43`	`/**`
`44`		`- * A bare-bones in-memory implementation of Storage, meant for testing.`
	`44`	`+ * A bare-bones in-memory implementation of StorageRpc, meant for testing.`
`45`	`45`	`*`
`46`	`46`	`* <p>This class is <i>not</i> thread-safe. It's also (currently) limited in the following ways:`
`47`	`47`	`* <ul>`