Skip to content

Simplify package-info examples #376

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

Merged
mziccard merged 2 commits into from
Nov 13, 2015
Merged

Simplify package-info examples #376

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dc71a56
Simplify package-info examples
Nov 13, 2015
1bcdf4b
Make package info wording clearer
Nov 13, 2015
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
11 changes: 8 additions & 3 deletions gcloud-java-datastore/src/main/java/com/google/gcloud/datastore/package-info.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,9 @@
/**
* A client to the Google Cloud Datastore.
*
* <p>A simple usage example:
* <p>Here's a simple usage example for using gcloud-java from App/Compute Engine:
* <pre> {@code
* DatastoreOptions options = DatastoreOptions.builder().projectId(PROJECT_ID).build();
* Datastore datastore = options.service();
* Datastore datastore = DatastoreOptions.defaultInstance().service();
* KeyFactory keyFactory = datastore.newKeyFactory().kind(kind);
* Key key = keyFactory.newKey(keyName);
* Entity entity = datastore.get(key);
Expand All @@ -47,6 +46,12 @@
* }
* } </pre>
*
* <p>When using gcloud-java from outside of App/Compute Engine, you have to <a
* href="https://github.com/GoogleCloudPlatform/gcloud-java#specifying-a-project-id">specify a
* project ID</a> and
* <a href="https://github.com/GoogleCloudPlatform/gcloud-java#authentication">provide

This comment was marked as spam.

Sign in to view

This comment was marked as spam.

Sign in to view

* authentication</a>.
*

This comment was marked as spam.

Sign in to view

* @see <a href="https://cloud.google.com/datastore/">Google Cloud Datastore</a>
*/
package com.google.gcloud.datastore;
10 changes: 7 additions & 3 deletions gcloud-java-storage/src/main/java/com/google/gcloud/storage/package-info.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,9 @@
/**
* A client to Google Cloud Storage.
*
* <p>A simple usage example:
* <p>Here's a simple usage example for when running on App/Compute Engine:

This comment was marked as spam.

Sign in to view

* <pre>{@code
* StorageOptions options = StorageOptions.builder().projectId("project").build();
* Storage storage = options.service();
* Storage storage = StorageOptions.defaultInstance().service();
* BlobId blobId = BlobId.of("bucket", "blob_name");
* Blob blob = Blob.load(storage, blobId);
* if (blob == null) {
Expand All @@ -35,6 +34,11 @@
* channel.close();
* }}</pre>
*
* When using gcloud-java from outside of App/Compute Engine, you have to <a
* href="https://github.com/GoogleCloudPlatform/gcloud-java#specifying-a-project-id">specify a
* project ID</a> and
* <a href="https://github.com/GoogleCloudPlatform/gcloud-java#authentication">provide

This comment was marked as spam.

Sign in to view

* authentication</a>.
* @see <a href="https://cloud.google.com/storage/">Google Cloud Storage</a>
*/
package com.google.gcloud.storage;
Expand Down