Fix javadoc in examples to match the README

Fix javadoc in examples to match the README Also use "log in" instead of "login" where a verb is needed instead of a noun.
googleapis · Apr 6, 2016 · 9805b48 · 9805b48
1 parent edd0f21
commit 9805b48
Show file tree

Hide file tree

Showing 6 changed files with 27 additions and 22 deletions.
diff --git 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
@@ -60,11 +60,12 @@
  *
  * <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/...ud-java-examples/src/main/java/com/google/gcloud/examples/datastore/DatastoreExample.java b/...ud-java-examples/src/main/java/com/google/gcloud/examples/datastore/DatastoreExample.java
@@ -42,10 +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 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
+ * [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
@@ -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/...ples/src/main/java/com/google/gcloud/examples/resourcemanager/ResourceManagerExample.java b/...ples/src/main/java/com/google/gcloud/examples/resourcemanager/ResourceManagerExample.java
@@ -32,12 +32,13 @@
  *
  * <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>
+ * <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>
  * </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
@@ -62,11 +62,12 @@
  *
  * <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] |