Update examples in package-info

googleapis · Oct 8, 2015 · d8478d7 · d8478d7
1 parent bfae667
commit d8478d7
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 10 deletions.
diff --git a/gcloud-java-datastore/src/main/java/com/google/gcloud/datastore/testing/package-info.java b/gcloud-java-datastore/src/main/java/com/google/gcloud/datastore/testing/package-info.java
@@ -18,20 +18,22 @@
  * A testing helper for Google Cloud Datastore.
  *
  * <p>A simple usage example:
+ * <p>Before the test:
  * <pre> {@code
  * LocalGcdHelper gcdHelper = LocalGcdHelper.start(PROJECT_ID, PORT_NUMBER);
  * DatastoreOptions options = DatastoreOptions.builder()
  *     .projectId(PROJECT_ID)
  *     .host("localhost:8080")
  *     .build();
  * Datastore localDatastore = DatastoreFactory.instance().get(options);
+ * } </pre>
  * 
- * // Do tests
- * 
+ * <p>After the test:
+ * <pre> {@code
  * gcdHelper.stop();
  * } </pre>
  *
- * @see <a href="https://github.com/GoogleCloudPlatform/gcloud-java/blob/master/TESTING.md">
+ * @see <a href="https://github.com/GoogleCloudPlatform/gcloud-java/blob/master/TESTING.md#testing-code-that-uses-datastore">
  *     gcloud-java tools for testing</a>
  */
 package com.google.gcloud.datastore.testing;
diff --git a/gcloud-java-storage/src/main/java/com/google/gcloud/storage/testing/package-info.java b/gcloud-java-storage/src/main/java/com/google/gcloud/storage/testing/package-info.java
@@ -17,19 +17,21 @@
 /**
  * A testing helper for Google Cloud Storage.
  *
- * <p>A simple usage example, after setting the required environment variables (see the link below):
+ * <p>A simple usage example:
+ * <p>Before the test:
  * <pre> {@code
- * RemoteGcsHelper gcsHelper = RemoteGcsHelper.create();
+ * RemoteGcsHelper gcsHelper = RemoteGcsHelper.create(PROJECT_ID, "/path/to/JSON/key.json");
  * Storage storage = StorageFactory.instance().get(gcsHelper.options());
  * String bucket = RemoteGcsHelper.generateBucketName();
  * storage.create(BucketInfo.of(bucket));
- * 
- * // Do tests
- * 
+ * } </pre>
+ *
+ * <p>After the test:
+ * <pre> {@code
  * RemoteGcsHelper.forceDelete(storage, bucket, 5, TimeUnit.SECONDS);
  * } </pre>
  *
- * @see <a href="https://github.com/GoogleCloudPlatform/gcloud-java/blob/master/TESTING.md">
+ * @see <a href="https://github.com/GoogleCloudPlatform/gcloud-java/blob/master/TESTING.md#testing-code-that-uses-storage">
  *     gcloud-java tools for testing</a>
  */
-package com.google.gcloud.storage.testing;
+package com.google.gcloud.storage.testing;