Make examples' javadoc more homogenous and minor html fixes

googleapis · Jun 27, 2016 · 0a6f958 · 0a6f958
1 parent dc566ba
commit 0a6f958
Show file tree

Hide file tree

Showing 6 changed files with 30 additions and 13 deletions.
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
@@ -84,7 +84,7 @@
  *  load <dataset> <table> <format> <sourceUri>+ |
  *  extract <dataset> <table> <format> <destinationUri>+ |
  *  query <query> |
- *  load-file <dataset> <table> <format> <filePath>"}</pre>
+ *  load-file <dataset> <table> <format> <filePath>}</pre>
  * </li>
  * </ol>
  *

diff --git a/gcloud-java-examples/src/main/java/com/google/cloud/examples/compute/ComputeExample.java b/gcloud-java-examples/src/main/java/com/google/cloud/examples/compute/ComputeExample.java
@@ -83,9 +83,14 @@
  *
  * <p>This example demonstrates a simple/typical Compute usage.
  *
- * <p>See the README for the steps needed for compiling and running the example.
- * <p>Possible command-line arguments are:
- * <pre>{@code [<project_id>]
+ * <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 -
+ * <pre>{@code target/appassembler/bin/ComputeExample [<project_id>]
  * list networks |
  * list region-operations <region> |
  * list instances <zone>? |
@@ -147,7 +152,9 @@
  * stop <zone> <instance> |
  * reset <zone> <instance> |
  * set-tags <zone> <instance> <tag>* |
- * set-metadata <zone> <instance> <key value>*"}</pre>
+ * set-metadata <zone> <instance> <key value>*}</pre>
+ * </li>
+ * </ol>
  *
  * <p>The first parameter is an optional {@code project_id} (logged-in project will be used if not
  * supplied). Second parameter is a Compute operation and can be used to demonstrate its usage. For

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
@@ -46,8 +46,10 @@
  * <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>
+ * <li>run -
+ * <pre>{@code target/appassembler/bin/DatastoreExample
+ * [projectId] [user] [delete|display|add comment]}</pre>
+ * </li>
  * </ol>
  *
  * <p>If no action is provided {@code display} is executed.

diff --git a/gcloud-java-examples/src/main/java/com/google/cloud/examples/dns/DnsExample.java b/gcloud-java-examples/src/main/java/com/google/cloud/examples/dns/DnsExample.java
@@ -42,16 +42,23 @@
  * <p>This example creates, deletes, gets, and lists zones. It also creates and deletes
  * record sets of type A, and lists record sets.
  *
- * <p>See the README for steps needed for running the example.
- * <p>The command-line arguments can be:
- * <pre>{@code [<project_id>]
+ * <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 -
+ * <pre>{@code target/appassembler/bin/DnsExample [<project_id>]
  * create <zone_name> <dns_name> <description> |
  * get <zone_name> |
  * delete <zone_name> |
  * list [<zone_name> [changes [descending | ascending] | records]] |
  * add-record <zone_name> <record_name> <ip> <ttl> |
  * delete-record <zone_name> <record_name> <ip> [<ttl>] |
  * quota}</pre>
+ * </li>
+ * </ol>
  *
  * <p>The first parameter is an optional {@code project_id}. The project specified in the Google
  * Cloud SDK configuration (see {@code gcloud config list}) will be used if the project ID is not

diff --git a/...mples/src/main/java/com/google/cloud/examples/resourcemanager/ResourceManagerExample.java b/...mples/src/main/java/com/google/cloud/examples/resourcemanager/ResourceManagerExample.java
@@ -37,8 +37,9 @@
  * <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>run - <pre>{@code target/appassembler/bin/ResourceManagerExample
+ * [list | [create | delete | get] projectId]}</pre>
+ * </li>
  * </ol>
  */
 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
@@ -84,7 +84,7 @@
  *  add-acl domain <bucket> <path>? <domain> OWNER|READER|WRITER |
  *  add-acl project <bucket> <path>? <projectId>:(OWNERS|EDITORS|VIEWERS) OWNER|READER|WRITER |
  *  add-acl user <bucket> <path>? <userEmail>|allUsers|allAuthenticatedUsers OWNER|READER|WRITER |
- *  add-acl group <bucket> <path>? <group> OWNER|READER|WRITER"}</pre>
+ *  add-acl group <bucket> <path>? <group> OWNER|READER|WRITER}</pre>
  * </li>
  * </ol>
  *