Make examples' javadoc more homogenous and minor html fixes

googleapis · Jun 28, 2016 · cf32fb4 · cf32fb4
1 parent dc566ba
commit cf32fb4
Show file tree

Hide file tree

Showing 9 changed files with 57 additions and 65 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
@@ -58,35 +58,29 @@
  *
  * <p>This example demonstrates a simple/typical BigQuery usage.
  *
- * <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 -
+ * <p>See the
+ * <a href="https://github.com/GoogleCloudPlatform/gcloud-java/blob/master/gcloud-java-examples/README.md">
+ * README</a> for compilation instructions. Run this code with
  * <pre>{@code target/appassembler/bin/BigQueryExample [<project_id>]
- *  list datasets |
- *  list tables <dataset> |
- *  list jobs |
- *  list data <dataset> <table> |
- *  info dataset <dataset> |
- *  info table <dataset> <table> |
- *  info job <job> |
- *  create dataset <dataset> |
- *  create table <dataset> <table> (<fieldName>:<primitiveType>)+ |
- *  create view <dataset> <table> <query> |
- *  create external-table <dataset> <table> <format> (<fieldName>:<primitiveType>)+ <sourceUri> |
- *  delete dataset <dataset> |
- *  delete table <dataset> <table> |
- *  cancel <job> |
- *  copy <sourceDataset> <sourceTable> <destinationDataset> <destinationTable> |
- *  load <dataset> <table> <format> <sourceUri>+ |
- *  extract <dataset> <table> <format> <destinationUri>+ |
- *  query <query> |
- *  load-file <dataset> <table> <format> <filePath>"}</pre>
- * </li>
- * </ol>
+ * list datasets |
+ * list tables <dataset> |
+ * list jobs |
+ * list data <dataset> <table> |
+ * info dataset <dataset> |
+ * info table <dataset> <table> |
+ * info job <job> |
+ * create dataset <dataset> |
+ * create table <dataset> <table> (<fieldName>:<primitiveType>)+ |
+ * create view <dataset> <table> <query> |
+ * create external-table <dataset> <table> <format> (<fieldName>:<primitiveType>)+ <sourceUri> |
+ * delete dataset <dataset> |
+ * delete table <dataset> <table> |
+ * cancel <job> |
+ * copy <sourceDataset> <sourceTable> <destinationDataset> <destinationTable> |
+ * load <dataset> <table> <format> <sourceUri>+ |
+ * extract <dataset> <table> <format> <destinationUri>+ |
+ * query <query> |
+ * load-file <dataset> <table> <format> <filePath>}</pre>
  *
  * <p>The first parameter is an optional {@code project_id} (logged-in project will be used if not
  * supplied). Second parameter is a BigQuery operation and can be used to demonstrate its usage. For

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,10 @@
  *
  * <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>See the
+ * <a href="https://github.com/GoogleCloudPlatform/gcloud-java/blob/master/gcloud-java-examples/README.md">
+ * README</a> for compilation instructions. Run this code with
+ * <pre>{@code target/appassembler/bin/ComputeExample [<project_id>]
  * list networks |
  * list region-operations <region> |
  * list instances <zone>? |
@@ -147,7 +148,7 @@
  * 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>
  *
  * <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
@@ -41,14 +41,11 @@
  * <p>This example adds, displays or clears comments for a given user. This example also sets
  * contact information for a user.
  *
- * <p>Steps needed for running the example:<ol>
- * <li>login 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/DatastoreExample
- * [projectId] [user] [delete|display|add comment]}</li>
- * </ol>
+ * <p>See the
+ * <a href="https://github.com/GoogleCloudPlatform/gcloud-java/blob/master/gcloud-java-examples/README.md">
+ * README</a> for compilation instructions. Run this code with
+ * <pre>{@code target/appassembler/bin/DatastoreExample
+ * [projectId] [user] [delete|display|add comment]}</pre>
  *
  * <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,9 +42,10 @@
  * <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>See the
+ * <a href="https://github.com/GoogleCloudPlatform/gcloud-java/blob/master/gcloud-java-examples/README.md">
+ * README</a> for compilation instructions. Run this code with
+ * <pre>{@code target/appassembler/bin/DnsExample [<project_id>]
  * create <zone_name> <dns_name> <description> |
  * get <zone_name> |
  * delete <zone_name> |

diff --git a/gcloud-java-examples/src/main/java/com/google/cloud/examples/nio/CountBytes.java b/gcloud-java-examples/src/main/java/com/google/cloud/examples/nio/CountBytes.java
@@ -37,8 +37,10 @@
  * This class also shows how to read all of the file's contents using NIO,
  * computes a MD5 hash, and reports how long it took.
  *
- * <p>See the README for compilation instructions. Run this code with
- * {@code target/appassembler/bin/CountBytes <file>}
+ * <p>See the
+ * <a href="https://github.com/GoogleCloudPlatform/gcloud-java/blob/master/gcloud-java-examples/README.md">
+ * README</a> for compilation instructions. Run this code with
+ * <pre>{@code target/appassembler/bin/CountBytes <file>}</pre>
  */
 public class CountBytes {
 

diff --git a/gcloud-java-examples/src/main/java/com/google/cloud/examples/nio/ParallelCountBytes.java b/gcloud-java-examples/src/main/java/com/google/cloud/examples/nio/ParallelCountBytes.java
@@ -43,8 +43,10 @@
  * in order, using multithreaded NIO reads.
  * It prints a MD5 hash and reports how long it took.
  *
- * <p>See the README for compilation instructions. Run this code with
- * {@code target/appassembler/bin/ParallelCountBytes <file>}
+ * <p>See the
+ * <a href="https://github.com/GoogleCloudPlatform/gcloud-java/blob/master/gcloud-java-examples/README.md">
+ * README</a> for compilation instructions. Run this code with
+ * <pre>{@code target/appassembler/bin/ParallelCountBytes <file>}</pre>
  */
 public class ParallelCountBytes {
 

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
@@ -35,8 +35,10 @@
  * 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 compilation instructions. Run this code with
- * {@code target/appassembler/bin/Stat --help | --check | --list | <file>}
+ * <p>See the
+ * <a href="https://github.com/GoogleCloudPlatform/gcloud-java/blob/master/gcloud-java-examples/README.md">
+ * README</a> for compilation instructions. Run this code with
+ * <pre>{@code target/appassembler/bin/Stat --help | --check | --list | <file>}</pre>
  *
  * <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/...mples/src/main/java/com/google/cloud/examples/resourcemanager/ResourceManagerExample.java b/...mples/src/main/java/com/google/cloud/examples/resourcemanager/ResourceManagerExample.java
@@ -32,14 +32,11 @@
  *
  * <p>This example creates, deletes, gets, and lists projects.
  *
- * <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>
+ * <p>See the
+ * <a href="https://github.com/GoogleCloudPlatform/gcloud-java/blob/master/gcloud-java-examples/README.md">
+ * README</a> for compilation instructions. Run this code with
+ * <pre>{@code target/appassembler/bin/ResourceManagerExample
+ * [list | [create | delete | get] projectId]}</pre>
  */
 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
@@ -64,13 +64,9 @@
  *
  * <p>This example demonstrates a simple/typical storage usage.
  *
- * <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 -
+ * <p>See the
+ * <a href="https://github.com/GoogleCloudPlatform/gcloud-java/blob/master/gcloud-java-examples/README.md">
+ * README</a> for compilation instructions. Run this code with
  * <pre>{@code target/appassembler/bin/StorageExample [<project_id>]
  *  list [<bucket>] |
  *  info [<bucket> [<file>]] |
@@ -84,7 +80,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>
  *