docs: fix links. fixes #279

googleapis · Nov 5, 2014 · e5b1b6c · e5b1b6c
1 parent a551685
commit e5b1b6c
Show file tree

Hide file tree

Showing 10 changed files with 44 additions and 51 deletions.
diff --git a/lib/bigquery/dataset.js b/lib/bigquery/dataset.js
@@ -62,8 +62,7 @@ function Dataset(bigQuery, id) {
  *     "timestamp". If the type is omitted, it is assumed to be "string".
  *     Example: "name:string, age:integer". Schemas can also be specified as a
  *     JSON array of fields, which allows for nested and repeated fields. See
- *     a [Table resource]{@link http://goo.gl/sl8Dmg} for more detailed
- *     information.
+ *     a [Table resource](http://goo.gl/sl8Dmg) for more detailed information.
  * @param {function} callback - The callback function.
  *
  * @example

diff --git a/lib/bigquery/index.js b/lib/bigquery/index.js
@@ -102,7 +102,7 @@ var SCOPES = ['https://www.googleapis.com/auth/bigquery'];
  * //-
  * // In the following examples from this page and the other modules (Dataset,
  * // Table, etc.), we are going to be using a dataset from
- * // [data.gov]{@link http://goo.gl/f2SXcb} of higher education institutions.
+ * // [data.gov](http://goo.gl/f2SXcb) of higher education institutions.
  * //
  * // We will create a table with the correct schema, import the public CSV file
  * // into that table, and query it for data.
@@ -453,9 +453,9 @@ BigQuery.prototype.query = function(options, callback) {
  * check on the status of the job.
  *
  * @param {object|string} options - The configuration object. This must be in
- *     the format of the [`configuration.query`]{@link http://goo.gl/wRpHvR}
- *     property of a Jobs resource. If a string is provided, this is used as the
- *     query string, and all other options are defaulted.
+ *     the format of the [`configuration.query`](http://goo.gl/wRpHvR) property
+ *     of a Jobs resource. If a string is provided, this is used as the query
+ *     string, and all other options are defaulted.
  * @param {module:bigquery/table=} options.destination - The table to save the
  *     query's results to. If omitted, a new table will be created.
  * @param {string} options.query - A query string, following the BigQuery query

diff --git a/lib/bigquery/table.js b/lib/bigquery/table.js
@@ -118,8 +118,7 @@ Table.mergeSchemaWithRows_ = function(schema, rows) {
  * @param {module:bigquery/table} destination - The destination table.
  * @param {object=} metadata - Metadata to set with the copy operation. The
  *     metadata object should be in the format of the
- *     [`configuration.copy`]{@link http://goo.gl/dKWIyS} property of a Jobs
- *     resource.
+ *     [`configuration.copy`](http://goo.gl/dKWIyS) property of a Jobs resource.
  * @param {function} callback - The callback function.
  *
  * @throws {Error} If a destination other than a Table object is provided.
@@ -128,7 +127,7 @@ Table.mergeSchemaWithRows_ = function(schema, rows) {
  * table.copy(dataset.table('institution_data'), function(err, job) {});
  *
  * //-
- * // See the [`configuration.copy`]{@link http://goo.gl/dKWIyS} object for all
+ * // See the [`configuration.copy`](http://goo.gl/dKWIyS) object for all
  * // available options.
  * //-
  * var metadata = {
@@ -228,8 +227,8 @@ Table.prototype.createReadStream = function() {
  *
  * @param {string|object=} metadata - Metadata to set with the load operation.
  *     The metadata object should be in the format of the
- *     [`configuration.load`]{@link http://goo.gl/BVcXk4} property of a Jobs
- *     resource. If a string is given, it will be used as the filetype.
+ *     [`configuration.load`](http://goo.gl/BVcXk4) property of a Jobs resource.
+ *     If a string is given, it will be used as the filetype.
  * @return {WriteStream}
  *
  * @throws {Error} If source format isn't recognized.
@@ -569,8 +568,7 @@ Table.prototype.getRows = function(options, callback) {
  * @param {string|module:storage/file} source - The source file to import.
  * @param {object=} metadata - Metadata to set with the load operation. The
  *     metadata object should be in the format of the
- *     [`configuration.load`]{@link http://goo.gl/BVcXk4} property of a Jobs
- *     resource.
+ *     [`configuration.load`](http://goo.gl/BVcXk4) property of a Jobs resource.
  * @param {function} callback - The callback function.
  *
  * @throws {Error} If the source isn't a string file name or a File instance.
@@ -583,7 +581,7 @@ Table.prototype.getRows = function(options, callback) {
  *
  * //-
  * // You may also pass in metadata in the format of a Jobs resource. See
- * // {@link http://goo.gl/BVcXk4} for a full list of supported values.
+ * // (http://goo.gl/BVcXk4) for a full list of supported values.
  * //-
  * var metadata = {
  *   encoding: 'ISO-8859-1',
@@ -789,8 +787,7 @@ Table.prototype.query = function(query, callback) {
  *     "timestamp". If the type is omitted, it is assumed to be "string".
  *     Example: "name:string, age:integer". Schemas can also be specified as a
  *     JSON array of fields, which allows for nested and repeated fields. See
- *     a [Table resource]{@link http://goo.gl/sl8Dmg} for more detailed
- *     information.
+ *     a [Table resource](http://goo.gl/sl8Dmg) for more detailed information.
  * @param {function} callback - The callback function.
  */
 Table.prototype.setMetadata = function(metadata, callback) {

diff --git a/lib/datastore/dataset.js b/lib/datastore/dataset.js
@@ -70,7 +70,7 @@ var SCOPES = [
 
 /**
  * Interact with a dataset from the
- * [Google Cloud Datastore]{@link https://developers.google.com/datastore/}.
+ * [Google Cloud Datastore](https://developers.google.com/datastore/).
  *
  * @constructor
  * @alias module:datastore/dataset
@@ -155,7 +155,7 @@ Dataset.prototype.key = function(options) {
  * Create a query from the current dataset to query the specified kinds, scoped
  * to the namespace provided at the initialization of the dataset.
  *
- * *Dataset query reference: {@link http://goo.gl/Cag0r6}*
+ * *Dataset query reference: (http://goo.gl/Cag0r6)*
  *
  * @borrows {module:datastore/query} as createQuery
  * @see {module:datastore/query}

diff --git a/lib/datastore/query.js b/lib/datastore/query.js
@@ -35,7 +35,7 @@ var util = require('../common/util.js');
  * {@linkcode module:datastore/dataset#createQuery} and run via
  * {@linkcode module:datastore/dataset#runQuery}.**
  *
- * *Reference: {@link http://goo.gl/Cag0r6}*
+ * *Reference: (http://goo.gl/Cag0r6)*
  *
  * @constructor
  * @alias module:datastore/query
@@ -82,7 +82,7 @@ function Query(namespace, kinds) {
  *
  * *To filter by ancestors, see {@linkcode module:datastore/query#hasAncestor}.*
  *
- * *Reference: {@link http://goo.gl/ENCx7e}*
+ * *Reference: (http://goo.gl/ENCx7e)*
  *
  * @param {string} filter - Property + Operator (=, <, >, <=, >=).
  * @param {*} value - Value to compare property to.
@@ -116,7 +116,7 @@ Query.prototype.filter = function(filter, value) {
 /**
  * Filter a query by ancestors.
  *
- * *Reference: {@link http://goo.gl/1qfpkZ}*
+ * *Reference: (http://goo.gl/1qfpkZ)*
  *
  * @param {Key} key - Key object to filter by.
  * @return {module:datastore/query}
@@ -134,7 +134,7 @@ Query.prototype.hasAncestor = function(key) {
  * Sort the results by a property name in ascending or descending order. By
  * default, an ascending sort order will be used.
  *
- * *Reference: {@link http://goo.gl/mfegFR}*
+ * *Reference: (http://goo.gl/mfegFR)*
  *
  * @param {string} property - Optional operator (+, -) and property to order by.
  * @return {module:datastore/query}
@@ -176,7 +176,7 @@ Query.prototype.groupBy = function(fieldNames) {
 /**
  * Retrieve only select properties from the matched entities.
  *
- * *Reference: [Projection Queries]{@link http://goo.gl/EfsrJl}*
+ * *[Reference](http://goo.gl/EfsrJl).*
  *
  * @param {array} fieldNames - Properties to return from the matched entities.
  * @return {module:datastore/query}
@@ -194,7 +194,7 @@ Query.prototype.select = function(fieldNames) {
 /**
  * Set a starting cursor to a query.
  *
- * *Reference: {@link http://goo.gl/WuTGRI}*
+ * *[Reference](http://goo.gl/WuTGRI).*
  *
  * @param {string} cursorToken - The starting cursor token.
  * @return {module:datastore/query}
@@ -214,7 +214,7 @@ Query.prototype.start = function(start) {
 /**
  * Set an ending cursor to a query.
  *
- * *Reference: {@link http://goo.gl/WuTGRI}*
+ * *Reference: (http://goo.gl/WuTGRI)*
  *
  * @param {string} cursorToken - The ending cursor token.
  * @return {module:datastore/query}
@@ -234,7 +234,7 @@ Query.prototype.end = function(end) {
 /**
  * Set a limit on a query.
  *
- * *Reference: {@link http://goo.gl/f0VZ0n}*
+ * *Reference: (http://goo.gl/f0VZ0n)*
  *
  * @param {number} n - The number of results to limit the query to.
  * @return {module:datastore/query}
@@ -252,7 +252,7 @@ Query.prototype.limit = function(n) {
 /**
  * Set an offset on a query.
  *
- * *Reference: {@link http://goo.gl/f0VZ0n}*
+ * *Reference: (http://goo.gl/f0VZ0n)*
  *
  * @param {number} n - The offset to start from after the start cursor.
  * @return {module:datastore/query}

diff --git a/lib/datastore/transaction.js b/lib/datastore/transaction.js
@@ -47,7 +47,7 @@ var DatastoreRequest = require('./request.js');
  * {@linkcode module:datastore/dataset}. When you need to run a transactional
  * operation, use {@linkcode module:datastore/dataset#runInTransaction}.
  *
- * *Reference: {@link http://goo.gl/n4oSjt}*
+ * *[Reference](http://goo.gl/n4oSjt).*
  *
  * @constructor
  * @alias module:datastore/transaction

diff --git a/lib/index.js b/lib/index.js
@@ -122,9 +122,9 @@ function gcloud(config) {
 
 /**
  * Analyze Big Data in the cloud with
- * [Google BigQuery]{@link https://cloud.google.com/bigquery}. Run fast,
- * SQL-like queries against multi-terabyte datasets in seconds. Scalable and
- * easy to use, BigQuery gives you real-time insights about your data.
+ * [Google BigQuery](https://cloud.google.com/bigquery). Run fast, SQL-like
+ * queries against multi-terabyte datasets in seconds. Scalable and easy to use,
+ * BigQuery gives you real-time insights about your data.
  *
  * @type {module:bigquery}
  *
@@ -140,10 +140,10 @@ function gcloud(config) {
 gcloud.bigquery = BigQuery;
 
 /**
- * [Google Cloud Datastore]{@link https://developers.google.com/datastore/} is
- * a fully managed, schemaless database for storing non-relational data. Use
- * this object to create a Dataset to interact with your data, an "Int", and a
- * "Double" representation.
+ * [Google Cloud Datastore](https://developers.google.com/datastore/) is a fully
+ * managed, schemaless database for storing non-relational data. Use this object
+ * to create a Dataset to interact with your data, an "Int", and a "Double"
+ * representation.
  *
  * @type {module:datastore}
  *
@@ -162,16 +162,15 @@ gcloud.datastore = Datastore;
 /**
  * **Experimental**
  *
- * [Google Cloud Pub/Sub]{@link https://developers.google.com/pubsub/overview}
- * is a reliable, many-to-many, asynchronous messaging service from Google
- * Cloud Platform.
+ * [Google Cloud Pub/Sub](https://developers.google.com/pubsub/overview) is a
+ * reliable, many-to-many, asynchronous messaging service from Google Cloud
+ * Platform.
  *
  * Note: Google Cloud Pub/Sub API is available as a Limited Preview and the
  * client library we provide is currently experimental. The API and/or the
  * client might be changed in backward-incompatible ways. This API is not
  * subject to any SLA or deprecation policy. Request to be whitelisted to use it
- * by filling the
- * [Limited Preview application form]{@link http://goo.gl/sO0wTu}.
+ * by filling the [Limited Preview application form](http://goo.gl/sO0wTu).
  *
  * @type {module:pubsub}
  *
@@ -190,8 +189,7 @@ gcloud.pubsub = function(config) {
 
 /**
  * Google Cloud Storage allows you to store data on Google infrastructure.
- * Read
- * [Google Cloud Storage API docs]{@link https://developers.google.com/storage/}
+ * Read [Google Cloud Storage API docs](https://developers.google.com/storage/)
  * for more information.
  *
  * @type {module:storage}

diff --git a/lib/pubsub/index.js b/lib/pubsub/index.js
@@ -60,16 +60,15 @@ var SCOPES = [
 ];
 
 /**
- * [Google Cloud Pub/Sub]{@link https://developers.google.com/pubsub/overview}
- * is a reliable, many-to-many, asynchronous messaging service from Google
- * Cloud Platform.
+ * [Google Cloud Pub/Sub](https://developers.google.com/pubsub/overview) is a
+ * reliable, many-to-many, asynchronous messaging service from Google Cloud
+ * Platform.
  *
  * Note: Google Cloud Pub/Sub API is available as a Limited Preview and the
  * client library we provide is currently experimental. The API and/or the
  * client might be changed in backward-incompatible ways. This API is not
  * subject to any SLA or deprecation policy. Request to be whitelisted to use
- * it by filling the
- * [Limited Preview application form]{@link http://goo.gl/sO0wTu}.
+ * it by filling the [Limited Preview application form](http://goo.gl/sO0wTu).
  *
  * @constructor
  * @alias module:pubsub

diff --git a/lib/pubsub/subscription.js b/lib/pubsub/subscription.js
@@ -54,9 +54,9 @@ var util = require('../common/util.js');
  * - {@linkcode module:pubsub/topic#subscription}
  *
  * All Subscription objects are instances of an
- * [EventEmitter]{@link http://nodejs.org/api/events.html}. The subscription
- * will pull for messages automatically as long as there is at least one
- * listener assigned for the `message` event.
+ * [EventEmitter](http://nodejs.org/api/events.html). The subscription will pull
+ * for messages automatically as long as there is at least one listener assigned
+ * for the `message` event.
  *
  * @alias pubsub/subscription
  * @constructor

diff --git a/lib/storage/file.js b/lib/storage/file.js
@@ -323,7 +323,7 @@ File.prototype.getMetadata = function(callback) {
 /**
  * Get a signed URL to allow limited time access to the file.
  *
- * {@link https://developers.google.com/storage/docs/accesscontrol#Signed-URLs}
+ * *[Reference](http://goo.gl/LcqhjU).*
  *
  * @throws {Error} if an expiration timestamp from the past is given.
  *