From 46596d67ec0d67d10b37c92ea9a59653a021d147 Mon Sep 17 00:00:00 2001 From: JP Martin Date: Wed, 6 Apr 2016 11:13:49 -0700 Subject: [PATCH] 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. --- gcloud-java-examples/README.md | 2 +- .../cloud/examples/bigquery/BigQueryExample.java | 11 ++++++----- .../cloud/examples/datastore/DatastoreExample.java | 12 ++++-------- .../java/com/google/cloud/examples/nio/Stat.java | 3 ++- .../resourcemanager/ResourceManagerExample.java | 13 +++++++------ .../cloud/examples/storage/StorageExample.java | 11 ++++++----- 6 files changed, 26 insertions(+), 26 deletions(-) diff --git a/gcloud-java-examples/README.md b/gcloud-java-examples/README.md index 6a2903eb2e9b..57a35d7ef9d5 100644 --- a/gcloud-java-examples/README.md +++ b/gcloud-java-examples/README.md @@ -33,7 +33,7 @@ libraryDependencies += "com.google.cloud" % "gcloud-java-examples" % "0.2.4" 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/cloud/examples/bigquery/BigQueryExample.java b/gcloud-java-examples/src/main/java/com/google/cloud/examples/bigquery/BigQueryExample.java index 3ac1335cca7a..3dc14f13a07c 100644 --- a/gcloud-java-examples/src/main/java/com/google/cloud/examples/bigquery/BigQueryExample.java +++ b/gcloud-java-examples/src/main/java/com/google/cloud/examples/bigquery/BigQueryExample.java @@ -60,11 +60,12 @@ * *

Steps needed for running the example: *

    - *
  1. login using gcloud SDK - {@code gcloud auth login}.
    2. - *
  2. compile using maven - {@code mvn compile}
    3. - *
  3. run using maven - - * 
    {@code mvn exec:java -Dexec.mainClass="com.google.cloud.examples.bigquery.BigQueryExample"
- *  -Dexec.args="[]
+ * 
  4. log in using gcloud SDK - {@code gcloud auth login}.
    5. 
+ * 
  5. compile using maven - {@code cd gcloud-java-examples;
+ * mvn package appassembler:assemble -DskipTests -Dmaven.javadoc.skip=true -Dmaven.source.skip=true}
+ * 
    6. 
+ * 
  6. run -
+ * 
    {@code target/appassembler/bin/BigQueryExample []
  *  list datasets |
  *  list tables  |
  *  list jobs |
diff --git a/gcloud-java-examples/src/main/java/com/google/cloud/examples/datastore/DatastoreExample.java b/gcloud-java-examples/src/main/java/com/google/cloud/examples/datastore/DatastoreExample.java
index 4b83f04e7165..15381ab05ba3 100644
--- a/gcloud-java-examples/src/main/java/com/google/cloud/examples/datastore/DatastoreExample.java
+++ b/gcloud-java-examples/src/main/java/com/google/cloud/examples/datastore/DatastoreExample.java
@@ -43,15 +43,11 @@
  *
  * 
    Steps needed for running the example:
      
  * 
    1. login using gcloud SDK - {@code gcloud auth login}.
      2. 
- * 
    2. compile using maven - {@code mvn compile}
      3. 
- * 
    3. run using maven -
- * 
      {@code mvn exec:java -Dexec.mainClass="com.google.cloud.examples.datastore.DatastoreExample"
- *  -Dexec.args=" 
- *  delete |
- *  display |
- *  add  |
- *  set  }
      
+ * 
    4. compile using maven - {@code cd gcloud-java-examples;
+ * mvn package appassembler:assemble -DskipTests -Dmaven.javadoc.skip=true -Dmaven.source.skip=true}
  * 
      5. 
+ * 
    5. run - {@code target/appassembler/bin/DatastoreExample
+ * [projectId] [user] [delete|display|add comment|set  ]}
      6. 
  * 
    
  *
  * 
    If no action is provided {@code display} is executed.
diff --git a/gcloud-java-examples/src/main/java/com/google/cloud/examples/nio/Stat.java b/gcloud-java-examples/src/main/java/com/google/cloud/examples/nio/Stat.java
index 39b4df39e89c..ee9c4387a71a 100644
--- a/gcloud-java-examples/src/main/java/com/google/cloud/examples/nio/Stat.java
+++ b/gcloud-java-examples/src/main/java/com/google/cloud/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).
  *
- * 
    See the README for a command line to run this example.
+ * 
    See the README for compilation instructions. Run this code with
+ * {@code target/appassembler/bin/Stat --help | --check | --list | }
  *
  * 
    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/cloud/examples/resourcemanager/ResourceManagerExample.java b/gcloud-java-examples/src/main/java/com/google/cloud/examples/resourcemanager/ResourceManagerExample.java
index fd2eb3ed6d91..57dc81f44e50 100644
--- a/gcloud-java-examples/src/main/java/com/google/cloud/examples/resourcemanager/ResourceManagerExample.java
+++ b/gcloud-java-examples/src/main/java/com/google/cloud/examples/resourcemanager/ResourceManagerExample.java
@@ -32,12 +32,13 @@
  *
  * 
    This example creates, deletes, gets, and lists projects.
  *
- * 
     Steps needed for running the example:
      
- * 
    1. login using gcloud SDK - {@code gcloud auth login}.
      2. 
- * 
    2. compile using maven - {@code mvn compile}
      3. 
- * 
    3. run using maven - {@code mvn exec:java
- * -Dexec.mainClass="com.google.cloud.examples.resourcemanager.ResourceManagerExample"
- * -Dexec.args="[list | [create | delete | get] projectId]"}
      4. 
+ * 
      Steps needed for running the example:
        
+ * 
      1. log in using gcloud SDK - {@code gcloud auth login}.
        2. 
+ * 
      2. compile using maven - {@code cd gcloud-java-examples;
+ * mvn package appassembler:assemble -DskipTests -Dmaven.javadoc.skip=true -Dmaven.source.skip=true}
+ * 
        3. 
+ * 
      3. run - {@code target/appassembler/bin/ResourceManagerExample
+ * [list | [create | delete | get] projectId]}
        4. 
  * 
      
  */
 public class ResourceManagerExample {
diff --git a/gcloud-java-examples/src/main/java/com/google/cloud/examples/storage/StorageExample.java b/gcloud-java-examples/src/main/java/com/google/cloud/examples/storage/StorageExample.java
index d8273e65797d..aea9dffd3f6b 100644
--- a/gcloud-java-examples/src/main/java/com/google/cloud/examples/storage/StorageExample.java
+++ b/gcloud-java-examples/src/main/java/com/google/cloud/examples/storage/StorageExample.java
@@ -66,11 +66,12 @@
  *
  * 
      Steps needed for running the example:
  * 
        
- * 
      1. login using gcloud SDK - {@code gcloud auth login}.
        2. 
- * 
      2. compile using maven - {@code mvn compile}
        3. 
- * 
      3. run using maven -
- * 
        {@code mvn exec:java -Dexec.mainClass="com.google.cloud.examples.storage.StorageExample"
- *  -Dexec.args="[]
+ * 
      4. log in using gcloud SDK - {@code gcloud auth login}.
        5. 
+ * 
      5. compile using maven - {@code cd gcloud-java-examples;
+ * mvn package appassembler:assemble -DskipTests -Dmaven.javadoc.skip=true -Dmaven.source.skip=true}
+ * 
        6. 
+ * 
      6. run -
+ * 
        {@code target/appassembler/bin/StorageExample []
  *  list [] |
  *  info [ []] |
  *  download   [local_file] |