Param name on same line as type

This commit is contained in:
Tim Schaub
2018-07-23 15:26:01 -07:00
parent 6cdfbe3116
commit 6f22f1b7ac
7 changed files with 9 additions and 18 deletions

View File

@@ -1745,8 +1745,7 @@ function readStyle(node, objectStack) {
/** /**
* Reads an array of geometries and creates arrays for common geometry * Reads an array of geometries and creates arrays for common geometry
* properties. Then sets them to the multi geometry. * properties. Then sets them to the multi geometry.
* @param {module:ol/geom/MultiPoint|module:ol/geom/MultiLineString|module:ol/geom/MultiPolygon} * @param {module:ol/geom/MultiPoint|module:ol/geom/MultiLineString|module:ol/geom/MultiPolygon} multiGeometry A multi-geometry.
* multiGeometry A multi-geometry.
* @param {Array.<module:ol/geom/Geometry>} geometries List of geometries. * @param {Array.<module:ol/geom/Geometry>} geometries List of geometries.
*/ */
function setCommonGeometryProperties(multiGeometry, geometries) { function setCommonGeometryProperties(multiGeometry, geometries) {

View File

@@ -734,8 +734,7 @@ function writeProperty(node, pair, objectStack) {
/** /**
* @param {Node} node Node. * @param {Node} node Node.
* @param {{vendorId: string, safeToIgnore: boolean, value: string}} * @param {{vendorId: string, safeToIgnore: boolean, value: string}} nativeElement The native element.
* nativeElement The native element.
* @param {Array.<*>} objectStack Node stack. * @param {Array.<*>} objectStack Node stack.
*/ */
function writeNative(node, nativeElement, objectStack) { function writeNative(node, nativeElement, objectStack) {

View File

@@ -242,8 +242,7 @@ class VectorLayer extends Layer {
* it is `null` the layer has no style (a `null` style), so only features * it is `null` the layer has no style (a `null` style), so only features
* that have their own styles will be rendered in the layer. See * that have their own styles will be rendered in the layer. See
* {@link module:ol/style} for information on the default style. * {@link module:ol/style} for information on the default style.
* @param {module:ol/style/Style|Array.<module:ol/style/Style>|module:ol/style/Style~StyleFunction|null|undefined} * @param {module:ol/style/Style|Array.<module:ol/style/Style>|module:ol/style/Style~StyleFunction|null|undefined} style Layer style.
* style Layer style.
* @api * @api
*/ */
setStyle(style) { setStyle(style) {

View File

@@ -533,8 +533,7 @@ class CanvasReplay extends VectorContext {
* @param {Object.<string, boolean>} skippedFeaturesHash Ids of features * @param {Object.<string, boolean>} skippedFeaturesHash Ids of features
* to skip. * to skip.
* @param {Array.<*>} instructions Instructions array. * @param {Array.<*>} instructions Instructions array.
* @param {function((module:ol/Feature|module:ol/render/Feature)): T|undefined} * @param {function((module:ol/Feature|module:ol/render/Feature)): T|undefined} featureCallback Feature callback.
* featureCallback Feature callback.
* @param {module:ol/extent~Extent=} opt_hitExtent Only check features that intersect this * @param {module:ol/extent~Extent=} opt_hitExtent Only check features that intersect this
* extent. * extent.
* @return {T|undefined} Callback result. * @return {T|undefined} Callback result.

View File

@@ -223,8 +223,7 @@ class LayerRenderer extends Observable {
* @param {module:ol/coordinate~Coordinate} coordinate Coordinate. * @param {module:ol/coordinate~Coordinate} coordinate Coordinate.
* @param {module:ol/PluggableMap~FrameState} frameState Frame state. * @param {module:ol/PluggableMap~FrameState} frameState Frame state.
* @param {number} hitTolerance Hit tolerance in pixels. * @param {number} hitTolerance Hit tolerance in pixels.
* @param {function(this: S, (module:ol/Feature|module:ol/render/Feature), module:ol/layer/Layer): T} * @param {function(this: S, (module:ol/Feature|module:ol/render/Feature), module:ol/layer/Layer): T} callback Feature callback.
* callback Feature callback.
* @param {S} thisArg Value to use as `this` when executing `callback`. * @param {S} thisArg Value to use as `this` when executing `callback`.
* @return {T|undefined} Callback result. * @return {T|undefined} Callback result.
* @template S,T * @template S,T

View File

@@ -176,8 +176,7 @@ class AtlasManager {
* @param {number} height The height. * @param {number} height The height.
* @param {function(CanvasRenderingContext2D, number, number)} renderCallback * @param {function(CanvasRenderingContext2D, number, number)} renderCallback
* Called to render the new image onto an atlas image. * Called to render the new image onto an atlas image.
* @param {function(CanvasRenderingContext2D, number, number)=} * @param {function(CanvasRenderingContext2D, number, number)=} opt_renderHitCallback Called to render a hit-detection image onto a hit
* opt_renderHitCallback Called to render a hit-detection image onto a hit
* detection atlas image. * detection atlas image.
* @param {Object=} opt_this Value to use as `this` when executing * @param {Object=} opt_this Value to use as `this` when executing
* `renderCallback` and `renderHitCallback`. * `renderCallback` and `renderHitCallback`.

View File

@@ -131,8 +131,7 @@ export function parse(xml) {
/** /**
* Make an array extender function for extending the array at the top of the * Make an array extender function for extending the array at the top of the
* object stack. * object stack.
* @param {function(this: T, Node, Array.<*>): (Array.<*>|undefined)} * @param {function(this: T, Node, Array.<*>): (Array.<*>|undefined)} valueReader Value reader.
* valueReader Value reader.
* @param {T=} opt_this The object to use as `this` in `valueReader`. * @param {T=} opt_this The object to use as `this` in `valueReader`.
* @return {module:ol/xml~Parser} Parser. * @return {module:ol/xml~Parser} Parser.
* @template T * @template T
@@ -262,8 +261,7 @@ export function makeObjectPropertySetter(valueReader, opt_property, opt_this) {
* Create a serializer that appends nodes written by its `nodeWriter` to its * Create a serializer that appends nodes written by its `nodeWriter` to its
* designated parent. The parent is the `node` of the * designated parent. The parent is the `node` of the
* {@link module:ol/xml~NodeStackItem} at the top of the `objectStack`. * {@link module:ol/xml~NodeStackItem} at the top of the `objectStack`.
* @param {function(this: T, Node, V, Array.<*>)} * @param {function(this: T, Node, V, Array.<*>)} nodeWriter Node writer.
* nodeWriter Node writer.
* @param {T=} opt_this The object to use as `this` in `nodeWriter`. * @param {T=} opt_this The object to use as `this` in `nodeWriter`.
* @return {module:ol/xml~Serializer} Serializer. * @return {module:ol/xml~Serializer} Serializer.
* @template T, V * @template T, V
@@ -285,8 +283,7 @@ export function makeChildAppender(nodeWriter, opt_this) {
* designed to serialize a single item. An example would be a LineString * designed to serialize a single item. An example would be a LineString
* geometry writer, which could be reused for writing MultiLineString * geometry writer, which could be reused for writing MultiLineString
* geometries. * geometries.
* @param {function(this: T, Node, V, Array.<*>)} * @param {function(this: T, Node, V, Array.<*>)} nodeWriter Node writer.
* nodeWriter Node writer.
* @param {T=} opt_this The object to use as `this` in `nodeWriter`. * @param {T=} opt_this The object to use as `this` in `nodeWriter`.
* @return {module:ol/xml~Serializer} Serializer. * @return {module:ol/xml~Serializer} Serializer.
* @template T, V * @template T, V