Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix javadoc in examples to match the README #865

Merged
merged 2 commits into from
Apr 6, 2016
Merged

Fix javadoc in examples to match the README #865

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
84f5106
Fix javadoc in examples to match the README
jean-philippe-martin Apr 6, 2016
e99f84e
Minor reformatting
jean-philippe-martin Apr 6, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion gcloud-java-examples/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`.

Expand Down
11 changes: 6 additions & 5 deletions gcloud-java-examples/src/main/java/com/google/gcloud/examples/bigquery/BigQueryExample.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
Expand Down
9 changes: 5 additions & 4 deletions ...ud-java-examples/src/main/java/com/google/gcloud/examples/datastore/DatastoreExample.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
Expand Down
3 changes: 2 additions & 1 deletion gcloud-java-examples/src/main/java/com/google/gcloud/examples/nio/Stat.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
13 changes: 7 additions & 6 deletions ...ples/src/main/java/com/google/gcloud/examples/resourcemanager/ResourceManagerExample.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>

This comment was marked as spam.

Sign in to view

This comment was marked as spam.

Sign in to view

* <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 {
Expand Down
11 changes: 6 additions & 5 deletions gcloud-java-examples/src/main/java/com/google/gcloud/examples/storage/StorageExample.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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] |
Expand Down