Skip to content

Commit

Permalink
Better format for jsdoc
Browse files Browse the repository at this point in the history
  • Loading branch information
stephenmcd committed Apr 16, 2018
1 parent c104ffd commit 6800f7f
Show file tree
Hide file tree
Showing 8 changed files with 39 additions and 20 deletions.
3 changes: 2 additions & 1 deletion lib/apis/directions.js
Expand Up @@ -21,7 +21,8 @@ var v = require('../internal/validate');
/**
* Makes a directions request.
*
* @name GoogleMapsClient#directions
* @memberof! GoogleMapsClient
* @name GoogleMapsClient.directions
* @function
* @param {Object} query
* @param {LatLng} query.origin
Expand Down
3 changes: 2 additions & 1 deletion lib/apis/distance-matrix.js
Expand Up @@ -21,7 +21,8 @@ var v = require('../internal/validate');
/**
* Makes a distance matrix request.
*
* @name GoogleMapsClient#distanceMatrix
* @memberof! GoogleMapsClient
* @name GoogleMapsClient.distanceMatrix
* @function
* @param {Object} query
* @param {LatLng[]} query.origins
Expand Down
6 changes: 4 additions & 2 deletions lib/apis/elevation.js
Expand Up @@ -21,7 +21,8 @@ var v = require('../internal/validate');
/**
* Makes an elevation request.
*
* @name GoogleMapsClient#elevation
* @memberof! GoogleMapsClient
* @name GoogleMapsClient.elevation
* @function
* @param {Object} query
* @param {LatLng[]} query.locations
Expand All @@ -40,7 +41,8 @@ exports.elevation = {
/**
* Makes an elevation-along-path request.
*
* @name GoogleMapsClient#elevationAlongPath
* @memberof! GoogleMapsClient
* @name GoogleMapsClient.elevationAlongPath
* @function
* @param {Object} query
* @param {LatLng[]|string} query.path
Expand Down
6 changes: 4 additions & 2 deletions lib/apis/geocode.js
Expand Up @@ -21,7 +21,8 @@ var v = require('../internal/validate');
/**
* Makes a geocode request.
*
* @name GoogleMapsClient#geocode
* @memberof! GoogleMapsClient
* @name GoogleMapsClient.geocode
* @function
* @param {Object} query
* @param {string} [query.address]
Expand Down Expand Up @@ -52,7 +53,8 @@ exports.geocode = {
/**
* Makes a reverse geocode request.
*
* @name GoogleMapsClient#reverseGeocode
* @memberof! GoogleMapsClient
* @name GoogleMapsClient.reverseGeocode
* @function
* @param {Object} query
* @param {LatLng} [query.latlng]
Expand Down
5 changes: 3 additions & 2 deletions lib/apis/geolocation.js
Expand Up @@ -13,7 +13,7 @@
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
*/;

var utils = require('../internal/convert');
var v = require('../internal/validate');
Expand All @@ -23,7 +23,8 @@ var v = require('../internal/validate');
*
* For a detailed guide, see https://developers.google.com/maps/documentation/geolocation/intro
*
* @name GoogleMapsClient#geolocate
* @memberof! GoogleMapsClient
* @name GoogleMapsClient.geolocate
* @function
* @param {Object} query
* @param {number} [query.homeMobileCountryCode]
Expand Down
21 changes: 14 additions & 7 deletions lib/apis/places.js
Expand Up @@ -21,7 +21,8 @@ var v = require('../internal/validate');
/**
* Makes a places request.
*
* @name GoogleMapsClient#places
* @memberof! GoogleMapsClient
* @name GoogleMapsClient.places
* @function
* @param {Object} query
* @param {string} query.query
Expand Down Expand Up @@ -58,7 +59,8 @@ exports.places = {
/**
* Makes a nearby places request.
*
* @name GoogleMapsClient#placesNearby
* @memberof! GoogleMapsClient
* @name GoogleMapsClient.placesNearby
* @function
* @param {Object} query
* @param {LatLng} query.location
Expand Down Expand Up @@ -97,7 +99,8 @@ exports.placesNearby = {
/**
* Makes a places radar search request.
*
* @name GoogleMapsClient#placesRadar
* @memberof! GoogleMapsClient
* @name GoogleMapsClient.placesRadar
* @function
* @param {Object} query
* @param {LatLng} query.location
Expand Down Expand Up @@ -132,7 +135,8 @@ exports.placesRadar = {
/**
* Makes a place detail request.
*
* @name GoogleMapsClient#place
* @memberof! GoogleMapsClient
* @name GoogleMapsClient.place
* @function
* @param {Object} query
* @param {string} query.placeid
Expand All @@ -153,7 +157,8 @@ exports.place = {
/**
* Makes a place photos request.
*
* @name GoogleMapsClient#placesPhoto
* @memberof! GoogleMapsClient
* @name GoogleMapsClient.placesPhoto
* @function
* @param {Object} query
* @param {string} query.photoreference
Expand All @@ -176,7 +181,8 @@ exports.placesPhoto = {
/**
* Makes a places autocomplete request.
*
* @name GoogleMapsClient#placesAutoComplete
* @memberof! GoogleMapsClient
* @name GoogleMapsClient.placesAutoComplete
* @function
* @param {Object} query
* @param {string} query.input
Expand Down Expand Up @@ -210,7 +216,8 @@ exports.placesAutoComplete = {
/**
* Makes a places query autocomplete request.
*
* @name GoogleMapsClient#placesQueryAutoComplete
* @memberof! GoogleMapsClient
* @name GoogleMapsClient.placesQueryAutoComplete
* @function
* @param {Object} query
* @param {string} query.input
Expand Down
12 changes: 8 additions & 4 deletions lib/apis/roads.js
Expand Up @@ -21,7 +21,8 @@ var v = require('../internal/validate');
/**
* Makes a snap-to-roads request.
*
* @name GoogleMapsClient#snapToRoads
* @memberof! GoogleMapsClient
* @name GoogleMapsClient.snapToRoads
* @function
* @param {Object} query
* @param {LatLng[]} query.path
Expand All @@ -43,7 +44,8 @@ exports.snapToRoads = {
/**
* Makes a nearest roads request.
*
* @name GoogleMapsClient#nearestRoads
* @memberof! GoogleMapsClient
* @name GoogleMapsClient.nearestRoads
* @function
* @param {Object} query
* @param {LatLng[]} query.points
Expand All @@ -64,7 +66,8 @@ exports.nearestRoads = {
* Makes a speed-limits request for a place ID. For speed-limits
* requests using a path parameter, use the snappedSpeedLimits method.
*
* @name GoogleMapsClient#speedLimits
* @memberof! GoogleMapsClient
* @name GoogleMapsClient.speedLimits
* @function
* @param {Object} query
* @param {string[]} query.placeId
Expand All @@ -86,7 +89,8 @@ exports.speedLimits = {
/**
* Makes a speed-limits request for a path.
*
* @name GoogleMapsClient#snappedSpeedLimits
* @memberof! GoogleMapsClient
* @name GoogleMapsClient.snappedSpeedLimits
* @function
* @param {Object} query
* @param {LatLng[]} query.path
Expand Down
3 changes: 2 additions & 1 deletion lib/apis/timezone.js
Expand Up @@ -21,7 +21,8 @@ var v = require('../internal/validate');
/**
* Makes a timezone request.
*
* @name GoogleMapsClient#timezone
* @memberof! GoogleMapsClient
* @name GoogleMapsClient.timezone
* @function
* @param {Object} query
* @param {LatLng} query.location
Expand Down

0 comments on commit 6800f7f

Please sign in to comment.