Skip to content

Commit 9805b48

Browse files
jean-philippe-martinmziccard
authored andcommitted
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.
1 parent edd0f21 commit 9805b48

File tree

6 files changed

+27
-22
lines changed

6 files changed

+27
-22
lines changed

gcloud-java-examples/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ libraryDependencies += "com.google.gcloud" % "gcloud-java-examples" % "0.1.5"
3333

3434
To run examples from your command line:
3535

36-
1. Login using gcloud SDK (`gcloud auth login` in command line)
36+
1. Log in using gcloud SDK (`gcloud auth login` in command line)
3737

3838
2. Set your current project using `gcloud config set project PROJECT_ID`. This step is not necessary for `ResourceManagerExample`.
3939

gcloud-java-examples/src/main/java/com/google/gcloud/examples/bigquery/BigQueryExample.java

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -60,11 +60,12 @@
6060
*
6161
* <p>Steps needed for running the example:
6262
* <ol>
63-
* <li>login using gcloud SDK - {@code gcloud auth login}.</li>
64-
* <li>compile using maven - {@code mvn compile}</li>
65-
* <li>run using maven -
66-
* <pre>{@code mvn exec:java -Dexec.mainClass="com.google.gcloud.examples.bigquery.BigQueryExample"
67-
* -Dexec.args="[<project_id>]
63+
* <li>log in using gcloud SDK - {@code gcloud auth login}.</li>
64+
* <li>compile using maven - {@code cd gcloud-java-examples;
65+
* mvn package appassembler:assemble -DskipTests -Dmaven.javadoc.skip=true -Dmaven.source.skip=true}
66+
* </li>
67+
* <li>run -
68+
* <pre>{@code target/appassembler/bin/BigQueryExample [<project_id>]
6869
* list datasets |
6970
* list tables <dataset> |
7071
* list jobs |

gcloud-java-examples/src/main/java/com/google/gcloud/examples/datastore/DatastoreExample.java

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -42,10 +42,11 @@
4242
*
4343
* <p>Steps needed for running the example:<ol>
4444
* <li>login using gcloud SDK - {@code gcloud auth login}.</li>
45-
* <li>compile using maven - {@code mvn compile}</li>
46-
* <li>run using maven - {@code mvn exec:java
47-
* -Dexec.mainClass="com.google.gcloud.examples.datastore.DatastoreExample"
48-
* -Dexec.args="[projectId] [user] [delete|display|add comment]"}</li>
45+
* <li>compile using maven - {@code cd gcloud-java-examples;
46+
* mvn package appassembler:assemble -DskipTests -Dmaven.javadoc.skip=true -Dmaven.source.skip=true}
47+
* </li>
48+
* <li>run - {@code target/appassembler/bin/DatastoreExample
49+
* [projectId] [user] [delete|display|add comment]}</li>
4950
* </ol>
5051
*/
5152
public class DatastoreExample {

gcloud-java-examples/src/main/java/com/google/gcloud/examples/nio/Stat.java

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,8 @@
1919
* or you can directly pass in a GCS file name to use. In that case you have to
2020
* be logged in (using e.g. the gcloud auth command).
2121
*
22-
* <p>See the README for a command line to run this example.
22+
* <p>See the README for compilation instructions. Run this code with
23+
* {@code target/appassembler/bin/Stat --help | --check | --list | <file>}
2324
*
2425
* <p>In short, this version (in gcloud-java-examples) is in a package that lists gcloud-java-nio
2526
* as a dependency, so it will work directly without having to do any special work.

gcloud-java-examples/src/main/java/com/google/gcloud/examples/resourcemanager/ResourceManagerExample.java

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -32,12 +32,13 @@
3232
*
3333
* <p>This example creates, deletes, gets, and lists projects.
3434
*
35-
* <p> Steps needed for running the example:<ol>
36-
* <li>login using gcloud SDK - {@code gcloud auth login}.</li>
37-
* <li>compile using maven - {@code mvn compile}</li>
38-
* <li>run using maven - {@code mvn exec:java
39-
* -Dexec.mainClass="com.google.gcloud.examples.resourcemanager.ResourceManagerExample"
40-
* -Dexec.args="[list | [create | delete | get] projectId]"}</li>
35+
* <p>Steps needed for running the example:<ol>
36+
* <li>log in using gcloud SDK - {@code gcloud auth login}.</li>
37+
* <li>compile using maven - {@code cd gcloud-java-examples;
38+
* mvn package appassembler:assemble -DskipTests -Dmaven.javadoc.skip=true -Dmaven.source.skip=true}
39+
* </li>
40+
* <li>run - {@code target/appassembler/bin/ResourceManagerExample
41+
* [list | [create | delete | get] projectId]}</li>
4142
* </ol>
4243
*/
4344
public class ResourceManagerExample {

gcloud-java-examples/src/main/java/com/google/gcloud/examples/storage/StorageExample.java

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -62,11 +62,12 @@
6262
*
6363
* <p>Steps needed for running the example:
6464
* <ol>
65-
* <li>login using gcloud SDK - {@code gcloud auth login}.</li>
66-
* <li>compile using maven - {@code mvn compile}</li>
67-
* <li>run using maven -
68-
* <pre>{@code mvn exec:java -Dexec.mainClass="com.google.gcloud.examples.storage.StorageExample"
69-
* -Dexec.args="[<project_id>]
65+
* <li>log in using gcloud SDK - {@code gcloud auth login}.</li>
66+
* <li>compile using maven - {@code cd gcloud-java-examples;
67+
* mvn package appassembler:assemble -DskipTests -Dmaven.javadoc.skip=true -Dmaven.source.skip=true}
68+
* </li>
69+
* <li>run -
70+
* <pre>{@code target/appassembler/bin/StorageExample [<project_id>]
7071
* list [<bucket>] |
7172
* info [<bucket> [<file>]] |
7273
* download <bucket> <path> [local_file] |

0 commit comments

Comments
 (0)