docs: Update function to Function in javadoc

Author: manthey

examples/blog-lines/main.js

@@ -245,7 +245,7 @@ function updateSelect() {
  * @param {string|number|undefined} defaultValue: the value to return if the
  *      specified value is null, undefined, or the empty string.
  * @param {boolean} isString: if falsy, convert values to floats.
- * @returns {string|number|function}: a converted value.
+ * @returns {string|number|Function}: a converted value.
  */
 function getStyleParam(val, defaultValue, isString) {
   'use strict';

examples/build-utils.js

@@ -103,7 +103,7 @@ function writeYamlList(dir, filename, records) {
  *
  * @param {string} sourceFile The path of the javascript file being processed.
  * @param {string} outputPath The output directory.
- * @returns {function} A function to call from docco to fix the results.
+ * @returns {Function} A function to call from docco to fix the results.
  */
 function fixupDocco(sourceFile, outputPath) {
   return function () {

examples/lines/main.js

@@ -256,7 +256,7 @@ $(function () {
    *    cycle across lines.  Without that prefix, these are applied in a cycle
    *    across vertices.  If neither { or , are in the value, then the value is
    *    used as is, uniformly.
-   * @return {string|function} the style string or function.
+   * @return {string|Function} the style string or function.
    */
   function getStyle(key, value) {
     if (value === undefined || value === null || value === '') {

karma-base.js

@@ -79,7 +79,7 @@ function getScreenImage(name, left, top, width, height) {
  * @param {string} image: a base64 encoded png image.
  * @param {number} threshold: allowed difference between this image and the
  *    base image.
- * @param {function} callback: a function to call when complete.
+ * @param {Function} callback: a function to call when complete.
  */
 function compareImage(name, image, threshold, callback) {
   var resemble = require('resemblejs');

src/annotation/annotation.js

@@ -994,7 +994,7 @@ var annotation = function (type, args) {
    * Apply a map function of a geo.polygon.
    *
    * @param {geo.polygon} coord The polygon to apply the function to.
-   * @param {function} func The function to apply.
+   * @param {Function} func The function to apply.
    * @returns {array} The map results.
    */
   this._coordinatesMapFunc = function (coord, func) {
@@ -1255,7 +1255,7 @@ var annotation = function (type, args) {
  *
  * @private
  * @param {object} m_this The current annotation instance.
- * @param {function} s_actions The parent actions method.
+ * @param {Function} s_actions The parent actions method.
  * @param {string|undefined} state The state to return actions for.  Defaults
  *    to the current state.
  * @param {string} name The name of this annotation.
@@ -1357,7 +1357,7 @@ function continuousVerticesProcessAction(m_this, evt, name) {
  *   that it is twice as wide as tall, [2, 1/2] would allow it to be twice as
  *   wide or half as wide as it is tall.  Sizes (e.g., {width: 400, height:
  *   500}) snap to that size.
- * @returns {function} A function that can be passed to the mapIterator
+ * @returns {Function} A function that can be passed to the mapIterator
  *   selectionConstraint or to an annotation constraint function.
  */
 function constrainAspectRatio(ratio) {

src/annotation/rectangleAnnotation.js

@@ -22,7 +22,7 @@ const annotationActionOwner = require('./annotation').annotationActionOwner;
  *    finished rectangle.  This uses styles for {@link geo.polygonFeature}.
  * @property {geo.polygonFeature.styleSpec} [editStyle] The style to apply to a
  *    rectangle in edit mode.
- * @property {number|number[]|function} [constraint] If specified, an aspect
+ * @property {number|number[]|Function} [constraint] If specified, an aspect
  *    ratio or list of aspect ratios to constraint the rectangle to.  If a
  *    function, a selection constraint function to call to adjust the
  *    rectangle.

src/choroplethFeature.js

@@ -8,12 +8,12 @@ var feature = require('./feature');
  * @extends geo.feature.spec
  * @property {geo.colorObject[]} [colorRange] Color lookup table.  Default is
  *   9-step color table.
- * @property {function} [scale] A scale converts a input domain into the
+ * @property {Function} [scale] A scale converts a input domain into the
  *   the colorRange.  Default is `d3.scaleQuantize()`.
- * @property {function} [geoId] Given a geometry feature, return an identifier.
- * @property {function} [scalarId] Given a scalar element, return an
+ * @property {Function} [geoId] Given a geometry feature, return an identifier.
+ * @property {Function} [scalarId] Given a scalar element, return an
  *   identifier.
- * @property {function} [scalarValue] Given a scalar element, return a numeric
+ * @property {Function} [scalarValue] Given a scalar element, return a numeric
  *   values.
  */
 
@@ -82,7 +82,7 @@ var choroplethFeature = function (arg) {
    * @param {object[]} [data] An array of objects that are passed to the
    *   `scalarId` and `scalarValue` functions to get the associated information
    *   for each scalar.
-   * @param {function} [aggregator] The aggregator aggregates the scalar when
+   * @param {Function} [aggregator] The aggregator aggregates the scalar when
    *   there are multiple values with the same id. The default is `d3.mean`.
    * @returns {object[]|this} Either the current scalar data or the feature
    *   instance.
@@ -165,7 +165,7 @@ var choroplethFeature = function (arg) {
    * @param {string} [key] If defined, return a function for the named
    *    property.  Otherwise, return an object with a function for all defined
    *    properties.
-   * @returns {function|object} Either a function for the named property or an
+   * @returns {Function|object} Either a function for the named property or an
    *    object with functions for all defined properties.
    */
   this.choropleth.get = function (key) {
@@ -228,7 +228,7 @@ var choroplethFeature = function (arg) {
   /**
    * Set a choropleth scale's domain and range.
    *
-   * @param {function} valueAccessor A function that can be passed to
+   * @param {Function} valueAccessor A function that can be passed to
    *    `d3.extent`.
    * @returns {this}
    */

src/contourFeature.js

@@ -19,17 +19,17 @@ var meshFeature = require('./meshFeature');
  *
  * @typedef {geo.feature.styleSpec} geo.contourFeature.styleSpec
  * @extends geo.feature.styleSpec
- * @property {geo.geoPosition|function} [position=data] The position of each
+ * @property {geo.geoPosition|Function} [position=data] The position of each
  *    data element.  This defaults to just using `x`, `y`, and `z` properties
  *    of the data element itself.  The position is in the feature's gcs
  *    coordinates.
- * @property {number|function} [value=data.z] The value of each data element.
+ * @property {number|Function} [value=data.z] The value of each data element.
  *    This defaults to the `z` property of the data elements.  If the value of
  *    a grid point is `null` or `undefined`, the point and elements that use
  *    that point won't be included in the results.
- * @property {number|function} [opacity=1] The opacity for the whole feature on
+ * @property {number|Function} [opacity=1] The opacity for the whole feature on
  *    a scale of 0 to 1.
- * @property {number[]|function} [origin] Origin in map gcs coordinates used
+ * @property {number[]|Function} [origin] Origin in map gcs coordinates used
  *   for to ensure high precision drawing in this location.  When called as a
  *   function, this is passed the vertex positions as a single continuous array
  *   in map gcs coordinates.  It defaults to the first vertex used in the

src/event.js

@@ -333,7 +333,7 @@ geo_event.keyaction = 'geo_keyaction';
  * @property {geo.geoPosition} center The target center.
  * @property {number} zoom The target zoom level.
  * @property {number} duration The duration of the transition in milliseconds.
- * @property {function} ease The easing function.
+ * @property {Function} ease The easing function.
  */
 geo_event.transitionstart = 'geo_transitionstart';
 
@@ -345,7 +345,7 @@ geo_event.transitionstart = 'geo_transitionstart';
  * @property {geo.geoPosition} center The target center.
  * @property {number} zoom The target zoom level.
  * @property {number} duration The duration of the transition in milliseconds.
- * @property {function} ease The easing function.
+ * @property {Function} ease The easing function.
  */
 geo_event.transitionend = 'geo_transitionend';
 
@@ -357,7 +357,7 @@ geo_event.transitionend = 'geo_transitionend';
  * @property {geo.geoPosition} center The target center.
  * @property {number} zoom The target zoom level.
  * @property {number} duration The duration of the transition in milliseconds.
- * @property {function} ease The easing function.
+ * @property {Function} ease The easing function.
  */
 geo_event.transitioncancel = 'geo_transitioncancel';
 

src/feature.js

@@ -563,7 +563,7 @@ var feature = function (arg) {
    * @instance
    * @param {string} [key] If defined, return a function for the named style.
    *    Otherwise, return an object with a function for all defined styles.
-   * @returns {function|object} Either a function for the named style or an
+   * @returns {Function|object} Either a function for the named style or an
    *    object with functions for all defined styles.
    */
   this.style.get = function (key) {
@@ -965,7 +965,7 @@ var feature = function (arg) {
    *
    * @param {string} event An event from {@link geo.event} or a user-defined
    *   value.
-   * @param {function} handler A function that is called when `event` is
+   * @param {Function} handler A function that is called when `event` is
    *   triggered.  The function is passed a {@link geo.event} object.
    * @returns {this}
    */