Fix jsdoc formating

This commit is contained in:
Frederic Junod
2013-09-24 11:47:55 +02:00
parent 2610e9e0c3
commit ef929e9a72
13 changed files with 35 additions and 29 deletions

View File

@@ -18,7 +18,7 @@ goog.require('ol.css');
* Create a new attribution control to show all the attributions associated
* with the layer sources in the map. A default map has this control included.
* By default it will show in the bottom right portion of the map, but it can
* be changed by using a css selector for .ol-attribution.
* be changed by using a css selector for `.ol-attribution`.
* @constructor
* @extends {ol.control.Control}
* @param {ol.control.AttributionOptions=} opt_options Attribution options.

View File

@@ -14,7 +14,7 @@ goog.require('ol.css');
* Shows a logo for all the layer sources in the map that have a logo
* associated with them, such as Bing. This control is part of a default map.
* By default it will show in the bottom-left portion of the map, but it can
* be styled by using a css selector for .ol-logo.
* be styled by using a css selector for `.ol-logo`.
* @constructor
* @extends {ol.control.Control}
* @param {ol.control.LogoOptions=} opt_options Logo options.

View File

@@ -32,7 +32,7 @@ ol.control.MousePositionProperty = {
* Create a new control to show the position of the mouse in the map's
* projection (or any other supplied projection). By default the control is
* shown in the top right corner of the map but this can be changed by using
* a css selector .ol-mouse-position.
* a css selector `.ol-mouse-position`.
*
* @constructor
* @extends {ol.control.Control}

View File

@@ -42,6 +42,8 @@ ol.control.ScaleLineUnits = {
/**
* Create a control to help users estimate distances on a map.
* By default it will show in the bottom left portion of the map, but it can
* be changed by using a css selector for `.ol-scale-line`.
*
* @constructor
* @extends {ol.control.Control}

View File

@@ -22,7 +22,7 @@ ol.control.ZOOM_DURATION = 250;
/**
* Create a new control with 2 buttons, one for zoom in and one for zoom out.
* This control is part of the default controls of a map. To style this control
* use css selectors .ol-zoom-in and .ol-zoom-out.
* use css selectors `.ol-zoom-in` and `.ol-zoom-out`.
* @constructor
* @extends {ol.control.Control}
* @param {ol.control.ZoomOptions=} opt_options Zoom options.

View File

@@ -14,7 +14,7 @@ goog.require('ol.css');
/**
* Create a control that adds a button, which, when pressed, changes
* the map view to a specific extent. To style this control use the
* css selector .ol-zoom-extent.
* css selector `.ol-zoom-extent`.
* @constructor
* @extends {ol.control.Control}
* @param {ol.control.ZoomToExtentOptions=} opt_options Options.

View File

@@ -7,13 +7,14 @@ goog.require('goog.math');
/**
* A function that formats a {@link ol.Coordinate} into a string.
* @typedef {function((ol.Coordinate|undefined)): string}
*/
ol.CoordinateFormatType;
/**
* An array representing a coordinate.
* An array of numbers representing a coordinate.
* @typedef {Array.<number>} ol.Coordinate
*/
ol.Coordinate;

View File

@@ -18,7 +18,7 @@ ol.dom.InputProperty = {
/**
* Helper class for binding HTML input to an ol.Object
* Helper class for binding HTML input to an {@link ol.Object}.
*
* Example:
*

View File

@@ -8,6 +8,7 @@ goog.require('ol.TransformFunction');
/**
* An array of numbers representing an extent: `[minx, miny, maxx, maxy]`.
* @typedef {Array.<number>}
*/
ol.Extent;

View File

@@ -45,6 +45,7 @@ ol.OverlayPositioning = {
* element: document.getElementById('popup')
* });
* popup.setPosition(coordinate);
* map.addOverlay(popup);
*
* @constructor
* @extends {ol.Object}

View File

@@ -43,7 +43,8 @@ ol.proj.Units = {
/**
* @const {Object.<ol.proj.Units, number>} Meters per unit lookup table.
* Meters per unit lookup table.
* @const {Object.<ol.proj.Units, number>}
*/
ol.METERS_PER_UNIT = {};
ol.METERS_PER_UNIT[ol.proj.Units.DEGREES] =

View File

@@ -3,7 +3,7 @@ goog.provide('ol.size');
/**
* An array representing a size: [width, height].
* An array of numbers representing a size: `[width, height]`.
* @typedef {Array.<number>} ol.Size
*/
ol.Size;