ashatora/openlayers
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Merge pull request #142 from jorix/doc-links

Browse Source 
Docs: Set many links as {<...>}
This commit is contained in:
Éric Lemoine
2012-01-12 11:25:03 -08:00
parent cbfb68f397 5cbdd27706
commit 9ebb64edef
15 changed files with 25 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
lib/OpenLayers/Control/DragPan.js
View File

@@ -47,7 +47,7 @@ OpenLayers.Control.DragPan = OpenLayers.Class(OpenLayers.Control, {
/**
* Property: kinetic
* {OpenLayers.Kinetic} The OpenLayers.Kinetic object.
* {<OpenLayers.Kinetic>} The OpenLayers.Kinetic object.
*/
kinetic: null,

2
lib/OpenLayers/Control/Graticule.js
View File

@@ -98,7 +98,7 @@ OpenLayers.Control.Graticule = OpenLayers.Class(OpenLayers.Control, {
/**
* Property: gratLayer
* {OpenLayers.Layer.Vector} vector layer used to draw the graticule on
* {<OpenLayers.Layer.Vector>} vector layer used to draw the graticule on
*/
gratLayer: null,

8
lib/OpenLayers/Control/Snapping.js
View File

@@ -115,7 +115,7 @@ OpenLayers.Control.Snapping = OpenLayers.Class(OpenLayers.Control, {
* the control.
*
* Valid options:
* layer - {OpenLayers.Layer.Vector} The editable layer. Features from this
* layer - {<OpenLayers.Layer.Vector>} The editable layer. Features from this
* layer that are digitized or modified may have vertices snapped to
* features from any of the target layers.
* targets - {Array(Object | OpenLayers.Layer.Vector)} A list of objects for
@@ -141,7 +141,7 @@ OpenLayers.Control.Snapping = OpenLayers.Class(OpenLayers.Control, {
* continues after an eligible feature is found in a target layer.
*
* Valid target properties:
* layer - {OpenLayers.Layer.Vector} A target layer. Features from this
* layer - {<OpenLayers.Layer.Vector>} A target layer. Features from this
* layer will be eligible to act as snapping target for the editable
* layer.
* tolerance - {Float} The distance (in pixels) at which snapping may occur.
@@ -159,7 +159,7 @@ OpenLayers.Control.Snapping = OpenLayers.Class(OpenLayers.Control, {
* edgeTolerance - {Float} Optional distance at which snapping may occur
* for edges specifically. If none is provided, <tolerance> will be
* used.
* filter - {OpenLayers.Filter} Optional filter to evaluate to determine if
* filter - {<OpenLayers.Filter>} Optional filter to evaluate to determine if
* feature is eligible for snapping. If filter evaluates to true for a
* target feature a vertex may be snapped to the feature.
* minResolution - {Number} If a minResolution is provided, snapping to this
@@ -198,7 +198,7 @@ OpenLayers.Control.Snapping = OpenLayers.Class(OpenLayers.Control, {
* layer is set.
*
* Parameters:
* layer - {OpenLayers.Layer.Vector} The new editable layer.
* layer - {<OpenLayers.Layer.Vector>} The new editable layer.
*/
setLayer: function(layer) {
if(this.active) {

14
lib/OpenLayers/Control/Split.js
View File

@@ -106,7 +106,7 @@ OpenLayers.Control.Split = OpenLayers.Class(OpenLayers.Control, {
/**
* APIProperty: targetFilter
* {OpenLayers.Filter} Optional filter that will be evaluated
* {<OpenLayers.Filter>} Optional filter that will be evaluated
* to determine if a feature from the target layer is eligible for
* splitting.
*/
@@ -114,7 +114,7 @@ OpenLayers.Control.Split = OpenLayers.Class(OpenLayers.Control, {
/**
* APIProperty: sourceFilter
* {OpenLayers.Filter} Optional filter that will be evaluated
* {<OpenLayers.Filter>} Optional filter that will be evaluated
* to determine if a feature from the target layer is eligible for
* splitting.
*/
@@ -141,10 +141,10 @@ OpenLayers.Control.Split = OpenLayers.Class(OpenLayers.Control, {
* the control.
*
* Valid options:
* layer - {OpenLayers.Layer.Vector} The target layer. Features from this
* layer - {<OpenLayers.Layer.Vector>} The target layer. Features from this
* layer will be split by new or modified features on the source layer
* or temporary sketch layer.
* source - {OpenLayers.Layer.Vector} Optional source layer. If provided
* source - {<OpenLayers.Layer.Vector>} Optional source layer. If provided
* newly created features or modified features will be used to split
* features on the target layer. If not provided, a temporary sketch
* layer will be created for drawing lines.
@@ -158,10 +158,10 @@ OpenLayers.Control.Split = OpenLayers.Class(OpenLayers.Control, {
* mutual - {Boolean} If source and target are the same, split source
* features and target features where they intersect. Default is
* true. If false, only target features will be split.
* targetFilter - {OpenLayers.Filter} Optional filter that will be evaluated
* targetFilter - {<OpenLayers.Filter>} Optional filter that will be evaluated
* to determine if a feature from the target layer is eligible for
* splitting.
* sourceFilter - {OpenLayers.Filter} Optional filter that will be evaluated
* sourceFilter - {<OpenLayers.Filter>} Optional filter that will be evaluated
* to determine if a feature from the target layer is eligible for
* splitting.
*/
@@ -180,7 +180,7 @@ OpenLayers.Control.Split = OpenLayers.Class(OpenLayers.Control, {
* Set the source layer for edits layer.
*
* Parameters:
* layer - {OpenLayers.Layer.Vector} The new source layer layer. If
* layer - {<OpenLayers.Layer.Vector>} The new source layer layer. If
* null, a temporary sketch layer will be created.
*/
setSource: function(layer) {

2
lib/OpenLayers/Format/ArcXML.js
View File

@@ -205,7 +205,7 @@ OpenLayers.Format.ArcXML = OpenLayers.Class(OpenLayers.Format.XML, {
* data - {String} or {DOMElement} data to read/parse.
*
* Returns:
* {OpenLayers.Format.ArcXML.Response} An ArcXML response. Note that this response
* {<OpenLayers.Format.ArcXML.Response>} An ArcXML response. Note that this response
* data may change in the future.
*/
read: function(data) {

2
lib/OpenLayers/Geometry/LinearRing.js
View File

@@ -153,7 +153,7 @@ OpenLayers.Geometry.LinearRing = OpenLayers.Class(
* ratio - {Float} Optional x:y ratio for resizing. Default ratio is 1.
*
* Returns:
* {OpenLayers.Geometry} - The current geometry.
* {<OpenLayers.Geometry>} - The current geometry.
*/
resize: function(scale, origin, ratio) {
for(var i=0, len=this.components.length; i<len - 1; ++i) {

2
lib/OpenLayers/Geometry/Point.js
View File

@@ -212,7 +212,7 @@ OpenLayers.Geometry.Point = OpenLayers.Class(OpenLayers.Geometry, {
* ratio - {Float} Optional x:y ratio for resizing. Default ratio is 1.
*
* Returns:
* {OpenLayers.Geometry} - The current geometry.
* {<OpenLayers.Geometry>} - The current geometry.
*/
resize: function(scale, origin, ratio) {
ratio = (ratio == undefined) ? 1 : ratio;

2
lib/OpenLayers/Layer/ArcGISCache.js
View File

@@ -363,7 +363,7 @@ OpenLayers.Layer.ArcGISCache = OpenLayers.Class(OpenLayers.Layer.XYZ, {
* Get this layer's maximum extent.
*
* Returns:
* {OpenLayers.Bounds}
* {<OpenLayers.Bounds>}
*/
getMaxExtent: function() {
var resolution = this.map.getResolution();

2
lib/OpenLayers/Layer/Grid.js
View File

@@ -817,7 +817,7 @@ OpenLayers.Layer.Grid = OpenLayers.Class(OpenLayers.Layer.HTTPRequest, {
* potential specific implementations in sub-classes.)
*
* Returns:
* {OpenLayers.Bounds}
* {<OpenLayers.Bounds>}
*/
getMaxExtent: function() {
return this.maxExtent;

2
lib/OpenLayers/Layer/PointGrid.js
View File

@@ -69,7 +69,7 @@ OpenLayers.Layer.PointGrid = OpenLayers.Class(OpenLayers.Layer.Vector, {
/**
* APIProperty: origin
* {OpenLayers.LonLat} Grid origin. The grid lattice will be aligned with
* {<OpenLayers.LonLat>} Grid origin. The grid lattice will be aligned with
* the origin. If not set at construction, the center of the map's maximum
* extent is used. Read-only. Use the <setOrigin> method to modify this
* value.

2
lib/OpenLayers/Map.js
View File

@@ -359,7 +359,7 @@ OpenLayers.Map = OpenLayers.Class({
/**
* Property: panTween
* {OpenLayers.Tween} Animated panning tween object, see panTo()
* {<OpenLayers.Tween>} Animated panning tween object, see panTo()
*/
panTween: null,

4
lib/OpenLayers/Protocol.js
View File

@@ -36,7 +36,7 @@ OpenLayers.Protocol = OpenLayers.Class({
/**
* Property: defaultFilter
* {OpenLayers.Filter} Optional default filter to read requests
* {<OpenLayers.Filter>} Optional default filter to read requests
*/
defaultFilter: null,
@@ -59,7 +59,7 @@ OpenLayers.Protocol = OpenLayers.Class({
* Merge filter passed to the read method with the default one
*
* Parameters:
* filter - {OpenLayers.Filter}
* filter - {<OpenLayers.Filter>}
*/
mergeWithDefaultFilter: function(filter) {
var merged;

2
lib/OpenLayers/Protocol/WFS/v1.js
View File

@@ -384,7 +384,7 @@ OpenLayers.Protocol.WFS.v1 = OpenLayers.Class(OpenLayers.Protocol, {
* Send a request that deletes all features by their filter.
*
* Parameters:
* filter - {OpenLayers.Filter} filter
* filter - {<OpenLayers.Filter>} filter
*/
filterDelete: function(filter, options) {
options = OpenLayers.Util.extend({}, options);

2
lib/OpenLayers/Strategy/Fixed.js
View File

@@ -105,7 +105,7 @@ OpenLayers.Strategy.Fixed = OpenLayers.Class(OpenLayers.Strategy, {
* Add all features to the layer.
*
* Parameters:
* mapProjection - {OpenLayers.Projection} the map projection
* mapProjection - {<OpenLayers.Projection>} the map projection
* resp - {Object} options to pass to protocol read.
*/
merge: function(mapProjection, resp) {

2
lib/OpenLayers/Style.js
View File

@@ -202,7 +202,7 @@ OpenLayers.Style = OpenLayers.Class({
* Method: applySymbolizer
*
* Parameters:
* rule - {OpenLayers.Rule}
* rule - {<OpenLayers.Rule>}
* style - {Object}
* feature - {<OpenLayer.Feature.Vector>}
*