From 84f51063250534b2cb1a37cc2d1979ca61c3db47 Mon Sep 17 00:00:00 2001
From: JP Martin <jpmartin@google.com>
Date: Wed, 6 Apr 2016 09:45:14 -0700
Subject: [PATCH 1/2] Fix javadoc in examples to match the README

Also use "log in" instead of "login" where a verb is needed instead of a
noun.
---
 gcloud-java-examples/README.md                           | 2 +-
 .../google/gcloud/examples/bigquery/BigQueryExample.java | 9 ++++-----
 .../gcloud/examples/datastore/DatastoreExample.java      | 6 ++----
 .../main/java/com/google/gcloud/examples/nio/Stat.java   | 3 ++-
 .../examples/resourcemanager/ResourceManagerExample.java | 8 +++-----
 .../google/gcloud/examples/storage/StorageExample.java   | 9 ++++-----
 6 files changed, 16 insertions(+), 21 deletions(-)

diff --git a/gcloud-java-examples/README.md b/gcloud-java-examples/README.md
index 3226ab1fe725..f2bcc05d2047 100644
--- a/gcloud-java-examples/README.md
+++ b/gcloud-java-examples/README.md
@@ -33,7 +33,7 @@ libraryDependencies += "com.google.gcloud" % "gcloud-java-examples" % "0.1.5"
 
 To run examples from your command line:
 
-1. Login using gcloud SDK (`gcloud auth login` in command line)
+1. Log in using gcloud SDK (`gcloud auth login` in command line)
 
 2. Set your current project using `gcloud config set project PROJECT_ID`. This step is not necessary for `ResourceManagerExample`.
 
diff --git a/gcloud-java-examples/src/main/java/com/google/gcloud/examples/bigquery/BigQueryExample.java b/gcloud-java-examples/src/main/java/com/google/gcloud/examples/bigquery/BigQueryExample.java
index fe27ee3cf63b..b554cce1b6bb 100644
--- a/gcloud-java-examples/src/main/java/com/google/gcloud/examples/bigquery/BigQueryExample.java
+++ b/gcloud-java-examples/src/main/java/com/google/gcloud/examples/bigquery/BigQueryExample.java
@@ -60,11 +60,10 @@
  *
  * <p>Steps needed for running the example:
  * <ol>
- * <li>login using gcloud SDK - {@code gcloud auth login}.</li>
- * <li>compile using maven - {@code mvn compile}</li>
- * <li>run using maven -
- * <pre>{@code mvn exec:java -Dexec.mainClass="com.google.gcloud.examples.bigquery.BigQueryExample"
- *  -Dexec.args="[<project_id>]
+ * <li>log in using gcloud SDK - {@code gcloud auth login}.</li>
+ * <li>compile using maven - {@code cd gcloud-java-examples; mvn package appassembler:assemble -DskipTests -Dmaven.javadoc.skip=true -Dmaven.source.skip=true}</li>
+ * <li>run  -
+ * <pre>{@code target/appassembler/bin/BigQueryExample [<project_id>]
  *  list datasets |
  *  list tables <dataset> |
  *  list jobs |
diff --git a/gcloud-java-examples/src/main/java/com/google/gcloud/examples/datastore/DatastoreExample.java b/gcloud-java-examples/src/main/java/com/google/gcloud/examples/datastore/DatastoreExample.java
index cc4331734200..f4b6278e9409 100644
--- a/gcloud-java-examples/src/main/java/com/google/gcloud/examples/datastore/DatastoreExample.java
+++ b/gcloud-java-examples/src/main/java/com/google/gcloud/examples/datastore/DatastoreExample.java
@@ -42,10 +42,8 @@
  *
  * <p>Steps needed for running the example:<ol>
  * <li>login using gcloud SDK - {@code gcloud auth login}.</li>
- * <li>compile using maven - {@code mvn compile}</li>
- * <li>run using maven - {@code mvn exec:java
- * -Dexec.mainClass="com.google.gcloud.examples.datastore.DatastoreExample"
- * -Dexec.args="[projectId] [user] [delete|display|add comment]"}</li>
+ * <li>compile using maven - {@code cd gcloud-java-examples; mvn package appassembler:assemble -DskipTests -Dmaven.javadoc.skip=true -Dmaven.source.skip=true}</li>
+ * <li>run - {@code target/appassembler/bin/DatastoreExample your-project-id my_name [projectId] [user] [delete|display|add comment]}</li>
  * </ol>
  */
 public class DatastoreExample {
diff --git a/gcloud-java-examples/src/main/java/com/google/gcloud/examples/nio/Stat.java b/gcloud-java-examples/src/main/java/com/google/gcloud/examples/nio/Stat.java
index 054657d717ef..cb1cce018e59 100644
--- a/gcloud-java-examples/src/main/java/com/google/gcloud/examples/nio/Stat.java
+++ b/gcloud-java-examples/src/main/java/com/google/gcloud/examples/nio/Stat.java
@@ -19,7 +19,8 @@
  * or you can directly pass in a GCS file name to use. In that case you have to
  * be logged in (using e.g. the gcloud auth command).
  *
- * <p>See the README for a command line to run this example.
+ * <p>See the README for compilation instructions. Run this code with
+ * {@code target/appassembler/bin/Stat --help | --check | --list | <file>}
  *
  * <p>In short, this version (in gcloud-java-examples) is in a package that lists gcloud-java-nio
  * as a dependency, so it will work directly without having to do any special work.
diff --git a/gcloud-java-examples/src/main/java/com/google/gcloud/examples/resourcemanager/ResourceManagerExample.java b/gcloud-java-examples/src/main/java/com/google/gcloud/examples/resourcemanager/ResourceManagerExample.java
index 349c0eebe73d..14e9cda12a00 100644
--- a/gcloud-java-examples/src/main/java/com/google/gcloud/examples/resourcemanager/ResourceManagerExample.java
+++ b/gcloud-java-examples/src/main/java/com/google/gcloud/examples/resourcemanager/ResourceManagerExample.java
@@ -33,11 +33,9 @@
  * <p>This example creates, deletes, gets, and lists projects.
  *
  * <p> Steps needed for running the example:<ol>
- * <li>login using gcloud SDK - {@code gcloud auth login}.</li>
- * <li>compile using maven - {@code mvn compile}</li>
- * <li>run using maven - {@code mvn exec:java
- * -Dexec.mainClass="com.google.gcloud.examples.resourcemanager.ResourceManagerExample"
- * -Dexec.args="[list | [create | delete | get] projectId]"}</li>
+ * <li>log in using gcloud SDK - {@code gcloud auth login}.</li>
+ * <li>compile using maven - {@code cd gcloud-java-examples; mvn package appassembler:assemble -DskipTests -Dmaven.javadoc.skip=true -Dmaven.source.skip=true}</li>
+ * <li>run - {@code target/appassembler/bin/ResourceManagerExample [list | [create | delete | get] projectId]"}</li>
  * </ol>
  */
 public class ResourceManagerExample {
diff --git a/gcloud-java-examples/src/main/java/com/google/gcloud/examples/storage/StorageExample.java b/gcloud-java-examples/src/main/java/com/google/gcloud/examples/storage/StorageExample.java
index a7260134202d..951ae491d139 100644
--- a/gcloud-java-examples/src/main/java/com/google/gcloud/examples/storage/StorageExample.java
+++ b/gcloud-java-examples/src/main/java/com/google/gcloud/examples/storage/StorageExample.java
@@ -62,11 +62,10 @@
  *
  * <p>Steps needed for running the example:
  * <ol>
- * <li>login using gcloud SDK - {@code gcloud auth login}.</li>
- * <li>compile using maven - {@code mvn compile}</li>
- * <li>run using maven -
- * <pre>{@code mvn exec:java -Dexec.mainClass="com.google.gcloud.examples.storage.StorageExample"
- *  -Dexec.args="[<project_id>]
+ * <li>log in using gcloud SDK - {@code gcloud auth login}.</li>
+ * <li>compile using maven - {@code cd gcloud-java-examples; mvn package appassembler:assemble -DskipTests -Dmaven.javadoc.skip=true -Dmaven.source.skip=true}</li>
+ * <li>run -
+ * <pre>{@code target/appassembler/bin/StorageExample [<project_id>]
  *  list [<bucket>] |
  *  info [<bucket> [<file>]] |
  *  download <bucket> <path> [local_file] |

From e99f84e8ad26b9086098fc3b648d000dc2a2aa1e Mon Sep 17 00:00:00 2001
From: JP Martin <jpmartin@google.com>
Date: Wed, 6 Apr 2016 10:48:11 -0700
Subject: [PATCH 2/2] Minor reformatting

---
 .../google/gcloud/examples/bigquery/BigQueryExample.java | 6 ++++--
 .../gcloud/examples/datastore/DatastoreExample.java      | 7 +++++--
 .../examples/resourcemanager/ResourceManagerExample.java | 9 ++++++---
 .../google/gcloud/examples/storage/StorageExample.java   | 4 +++-
 4 files changed, 18 insertions(+), 8 deletions(-)

diff --git a/gcloud-java-examples/src/main/java/com/google/gcloud/examples/bigquery/BigQueryExample.java b/gcloud-java-examples/src/main/java/com/google/gcloud/examples/bigquery/BigQueryExample.java
index b554cce1b6bb..6555fbdc7ced 100644
--- a/gcloud-java-examples/src/main/java/com/google/gcloud/examples/bigquery/BigQueryExample.java
+++ b/gcloud-java-examples/src/main/java/com/google/gcloud/examples/bigquery/BigQueryExample.java
@@ -61,8 +61,10 @@
  * <p>Steps needed for running the example:
  * <ol>
  * <li>log in using gcloud SDK - {@code gcloud auth login}.</li>
- * <li>compile using maven - {@code cd gcloud-java-examples; mvn package appassembler:assemble -DskipTests -Dmaven.javadoc.skip=true -Dmaven.source.skip=true}</li>
- * <li>run  -
+ * <li>compile using maven - {@code cd gcloud-java-examples;
+ * mvn package appassembler:assemble -DskipTests -Dmaven.javadoc.skip=true -Dmaven.source.skip=true}
+ * </li>
+ * <li>run -
  * <pre>{@code target/appassembler/bin/BigQueryExample [<project_id>]
  *  list datasets |
  *  list tables <dataset> |
diff --git a/gcloud-java-examples/src/main/java/com/google/gcloud/examples/datastore/DatastoreExample.java b/gcloud-java-examples/src/main/java/com/google/gcloud/examples/datastore/DatastoreExample.java
index f4b6278e9409..73f0ebe5bab3 100644
--- a/gcloud-java-examples/src/main/java/com/google/gcloud/examples/datastore/DatastoreExample.java
+++ b/gcloud-java-examples/src/main/java/com/google/gcloud/examples/datastore/DatastoreExample.java
@@ -42,8 +42,11 @@
  *
  * <p>Steps needed for running the example:<ol>
  * <li>login using gcloud SDK - {@code gcloud auth login}.</li>
- * <li>compile using maven - {@code cd gcloud-java-examples; mvn package appassembler:assemble -DskipTests -Dmaven.javadoc.skip=true -Dmaven.source.skip=true}</li>
- * <li>run - {@code target/appassembler/bin/DatastoreExample your-project-id my_name [projectId] [user] [delete|display|add comment]}</li>
+ * <li>compile using maven - {@code cd gcloud-java-examples;
+ * mvn package appassembler:assemble -DskipTests -Dmaven.javadoc.skip=true -Dmaven.source.skip=true}
+ * </li>
+ * <li>run - {@code target/appassembler/bin/DatastoreExample
+ * [projectId] [user] [delete|display|add comment]}</li>
  * </ol>
  */
 public class DatastoreExample {
diff --git a/gcloud-java-examples/src/main/java/com/google/gcloud/examples/resourcemanager/ResourceManagerExample.java b/gcloud-java-examples/src/main/java/com/google/gcloud/examples/resourcemanager/ResourceManagerExample.java
index 14e9cda12a00..0762fc779620 100644
--- a/gcloud-java-examples/src/main/java/com/google/gcloud/examples/resourcemanager/ResourceManagerExample.java
+++ b/gcloud-java-examples/src/main/java/com/google/gcloud/examples/resourcemanager/ResourceManagerExample.java
@@ -32,10 +32,13 @@
  *
  * <p>This example creates, deletes, gets, and lists projects.
  *
- * <p> Steps needed for running the example:<ol>
+ * <p>Steps needed for running the example:<ol>
  * <li>log in using gcloud SDK - {@code gcloud auth login}.</li>
- * <li>compile using maven - {@code cd gcloud-java-examples; mvn package appassembler:assemble -DskipTests -Dmaven.javadoc.skip=true -Dmaven.source.skip=true}</li>
- * <li>run - {@code target/appassembler/bin/ResourceManagerExample [list | [create | delete | get] projectId]"}</li>
+ * <li>compile using maven - {@code cd gcloud-java-examples;
+ * mvn package appassembler:assemble -DskipTests -Dmaven.javadoc.skip=true -Dmaven.source.skip=true}
+ * </li>
+ * <li>run - {@code target/appassembler/bin/ResourceManagerExample
+ * [list | [create | delete | get] projectId]}</li>
  * </ol>
  */
 public class ResourceManagerExample {
diff --git a/gcloud-java-examples/src/main/java/com/google/gcloud/examples/storage/StorageExample.java b/gcloud-java-examples/src/main/java/com/google/gcloud/examples/storage/StorageExample.java
index 951ae491d139..6ca59e836f58 100644
--- a/gcloud-java-examples/src/main/java/com/google/gcloud/examples/storage/StorageExample.java
+++ b/gcloud-java-examples/src/main/java/com/google/gcloud/examples/storage/StorageExample.java
@@ -63,7 +63,9 @@
  * <p>Steps needed for running the example:
  * <ol>
  * <li>log in using gcloud SDK - {@code gcloud auth login}.</li>
- * <li>compile using maven - {@code cd gcloud-java-examples; mvn package appassembler:assemble -DskipTests -Dmaven.javadoc.skip=true -Dmaven.source.skip=true}</li>
+ * <li>compile using maven - {@code cd gcloud-java-examples;
+ * mvn package appassembler:assemble -DskipTests -Dmaven.javadoc.skip=true -Dmaven.source.skip=true}
+ * </li>
  * <li>run -
  * <pre>{@code target/appassembler/bin/StorageExample [<project_id>]
  *  list [<bucket>] |