ben/brouter-web
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 1

update JSDoc

Browse source 
add hyphens between parameter name and description
This commit is contained in:
Marcus Jaschen 2024-10-20 17:30:27 +02:00 • committed by Gautier P
parent a285751416
commit 8c21a88b15
1 changed files with 12 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

24
js/control/TrackAnalysis.js
View file

@ -82,7 +82,7 @@ BR.TrackAnalysis = L.Class.extend({
* table row for highlighting matching track segments * table row for highlighting matching track segments
* *
* @param {Polyline} polyline * @param {Polyline} polyline
* @param {Array} segments route segments between waypoints * @param {Array} segments - route segments between waypoints
*/ */
update(polyline, segments) { update(polyline, segments) {
if (!this.active) { if (!this.active) {
@ -219,8 +219,8 @@ BR.TrackAnalysis = L.Class.extend({
* `maxspeed:backward`. Depending on the existence of the `reversedirection` field * `maxspeed:backward`. Depending on the existence of the `reversedirection` field
* we can select the correct value. * we can select the correct value.
* *
* @param wayTags tags + values for a way segment * @param wayTags - tags + values for a way segment
* @param routingType currently only 'cycling' is supported, can be extended in the future (walking, driving, etc.) * @param routingType - currently only 'cycling' is supported, can be extended in the future (walking, driving, etc.)
* @returns {*[]} * @returns {*[]}
*/ */
normalizeWayTags(wayTags, routingType) { normalizeWayTags(wayTags, routingType) {
@ -502,9 +502,9 @@ BR.TrackAnalysis = L.Class.extend({
* track edge matches the search, create a Leaflet polyline * track edge matches the search, create a Leaflet polyline
* and add it to the result array. * and add it to the result array.
* *
* @param {string} dataType `highway`, `surface`, `smoothness` * @param {string} dataType - `highway`, `surface`, `smoothness`
* @param {string} dataName `primary`, `track, `asphalt`, etc. * @param {string} dataName - `primary`, `track, `asphalt`, etc.
* @param {string} trackType the tracktype is passed here (e.g. * @param {string} trackType - the tracktype is passed here (e.g.
* `grade3`), but only in the case that `dataName` is `track` * `grade3`), but only in the case that `dataName` is `track`
* *
* @returns {Polyline[]} * @returns {Polyline[]}
@ -535,11 +535,11 @@ BR.TrackAnalysis = L.Class.extend({
* which matches if a tag-pair is missing. Special handling for * which matches if a tag-pair is missing. Special handling for
* tracktypes again. * tracktypes again.
* *
* @param {string} wayTags The way tags as provided by brouter, e.g. * @param {string} wayTags - The way tags as provided by brouter, e.g.
* `highway=secondary surface=asphalt smoothness=good` * `highway=secondary surface=asphalt smoothness=good`
* @param {string} dataType `highway`, `surface`, `smoothness` * @param {string} dataType - `highway`, `surface`, `smoothness`
* @param {string} dataName `primary`, `track, `asphalt`, etc. * @param {string} dataName - `primary`, `track, `asphalt`, etc.
* @param {string} trackType the tracktype is passed here (e.g. * @param {string} trackType - the tracktype is passed here (e.g.
* `grade3`), but only in the case that `dataName` is `track` * `grade3`), but only in the case that `dataName` is `track`
* *
* @returns {boolean} * @returns {boolean}
@ -616,7 +616,7 @@ BR.TrackAnalysis = L.Class.extend({
* *
* 'highway=primary surface=asphalt' => { highway: 'primary', surface: 'asphalt' } * 'highway=primary surface=asphalt' => { highway: 'primary', surface: 'asphalt' }
* *
* @param wayTags The way tags as provided by brouter, e.g. * @param wayTags - The way tags as provided by brouter, e.g.
* `highway=secondary surface=asphalt smoothness=good` * `highway=secondary surface=asphalt smoothness=good`
* *
* @returns {object} * @returns {object}
@ -638,7 +638,7 @@ BR.TrackAnalysis = L.Class.extend({
* *
* { 'highway' : 'path', 'surface' : 'sand' } => ['highway=path', 'surface=sand'] * { 'highway' : 'path', 'surface' : 'sand' } => ['highway=path', 'surface=sand']
* *
* @param wayTags The way tags in object representation * @param wayTags - The way tags in object representation
* *
* @returns {object} * @returns {object}
*/ */