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

Fixing links in documentation. Other Natural Docs changes. (closes #1504)

Browse Source 
git-svn-id: http://svn.openlayers.org/trunk/openlayers@6833 dc9f47b5-9b13-0410-9fdd-eb0c1a62fdaf
This commit is contained in:
Tim Schaub
2008-04-09 16:52:08 +00:00
parent ffab22ba19
commit 209f8f68f8
29 changed files with 87 additions and 75 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
apidoc_config/Menu.txt
View File

@@ -69,7 +69,7 @@ Group: OpenLayers {
File: Control (no auto-title, OpenLayers/Control.js)
File: ArgParser (no auto-title, OpenLayers/Control/ArgParser.js)
File: Attribution (no auto-title, OpenLayers/Control/Attribution.js)
File: Control.Button (no auto-title, OpenLayers/Control/Button.js)
File: Button (no auto-title, OpenLayers/Control/Button.js)
File: DragFeature (no auto-title, OpenLayers/Control/DragFeature.js)
File: DragPan (no auto-title, OpenLayers/Control/DragPan.js)
File: DrawFeature (no auto-title, OpenLayers/Control/DrawFeature.js)
@@ -104,6 +104,14 @@ Group: OpenLayers {
File: WFS (no auto-title, OpenLayers/Feature/WFS.js)
} # Group: Feature
Group: Filter {
File: Filter (no auto-title, OpenLayers/Filter.js)
File: Comparison (no auto-title, OpenLayers/Filter/Comparison.js)
File: FeatureId (no auto-title, OpenLayers/Filter/FeatureId.js)
File: Logical (no auto-title, OpenLayers/Filter/Logical.js)
} # Group: Filter
Group: Format {
File: Format (no auto-title, OpenLayers/Format.js)
@@ -113,10 +121,18 @@ Group: OpenLayers {
File: JSON (no auto-title, OpenLayers/Format/JSON.js)
File: KML (no auto-title, OpenLayers/Format/KML.js)
File: OSM (no auto-title, OpenLayers/Format/OSM.js)
Group: SLD {
File: SLD (no auto-title, OpenLayers/Format/SLD.js)
File: v1 (no auto-title, OpenLayers/Format/SLD/v1.js)
File: v1_0_0 (no auto-title, OpenLayers/Format/SLD/v1_0_0.js)
} # Group: SLD
File: Text (no auto-title, OpenLayers/Format/Text.js)
File: WFS (no auto-title, OpenLayers/Format/WFS.js)
File: WKT (no auto-title, OpenLayers/Format/WKT.js)
File: XML (no auto-title, OpenLayers/Format/XML.js)
Group: WMC {
@@ -126,7 +142,6 @@ Group: OpenLayers {
File: v1_1_0 (no auto-title, OpenLayers/Format/WMC/v1_1_0.js)
} # Group: WMC
File: XML (no auto-title, OpenLayers/Format/XML.js)
} # Group: Format
Group: Geometry {
@@ -142,7 +157,6 @@ Group: OpenLayers {
File: Point (no auto-title, OpenLayers/Geometry/Point.js)
File: Polygon (no auto-title, OpenLayers/Geometry/Polygon.js)
File: Rectangle (no auto-title, OpenLayers/Geometry/Rectangle.js)
File: Surface (no auto-title, OpenLayers/Geometry/Surface.js)
} # Group: Geometry
Group: Handler {
@@ -166,6 +180,7 @@ Group: OpenLayers {
Group: Lang {
File: Lang (no auto-title, OpenLayers/Lang.js)
File: Lang["cs-CZ"] (OpenLayers/Lang/cs-CZ.js)
File: Lang["de"] (no auto-title, OpenLayers/Lang/de.js)
File: Lang["en"] (no auto-title, OpenLayers/Lang/en.js)
File: Lang["en-CA"] (no auto-title, OpenLayers/Lang/en-CA.js)
@@ -217,6 +232,8 @@ Group: OpenLayers {
File: Popup (no auto-title, OpenLayers/Popup.js)
File: Anchored (no auto-title, OpenLayers/Popup/Anchored.js)
File: AnchoredBubble (no auto-title, OpenLayers/Popup/AnchoredBubble.js)
File: Framed (OpenLayers/Popup/Framed.js)
File: FramedCloud (OpenLayers/Popup/FramedCloud.js)
} # Group: Popup
File: Projection (no auto-title, OpenLayers/Projection.js)
@@ -229,14 +246,7 @@ Group: OpenLayers {
File: VML (no auto-title, OpenLayers/Renderer/VML.js)
} # Group: Renderer
Group: Rule {
File: Rule (no auto-title, OpenLayers/Rule.js)
File: Comparison (no auto-title, OpenLayers/Rule/Comparison.js)
File: FeatureId (no auto-title, OpenLayers/Rule/FeatureId.js)
File: Logical (no auto-title, OpenLayers/Rule/Logical.js)
} # Group: Rule
File: Style (no auto-title, OpenLayers/Style.js)
File: StyleMap (no auto-title, OpenLayers/StyleMap.js)

30
doc_config/Menu.txt
View File

@@ -69,7 +69,7 @@ Group: OpenLayers {
File: Control (no auto-title, OpenLayers/Control.js)
File: ArgParser (no auto-title, OpenLayers/Control/ArgParser.js)
File: Attribution (no auto-title, OpenLayers/Control/Attribution.js)
File: Control.Button (no auto-title, OpenLayers/Control/Button.js)
File: Button (no auto-title, OpenLayers/Control/Button.js)
File: DragFeature (no auto-title, OpenLayers/Control/DragFeature.js)
File: DragPan (no auto-title, OpenLayers/Control/DragPan.js)
File: DrawFeature (no auto-title, OpenLayers/Control/DrawFeature.js)
@@ -104,6 +104,14 @@ Group: OpenLayers {
File: WFS (no auto-title, OpenLayers/Feature/WFS.js)
} # Group: Feature
Group: Filter {
File: Filter (no auto-title, OpenLayers/Filter.js)
File: Comparison (no auto-title, OpenLayers/Filter/Comparison.js)
File: FeatureId (no auto-title, OpenLayers/Filter/FeatureId.js)
File: Logical (no auto-title, OpenLayers/Filter/Logical.js)
} # Group: Filter
Group: Format {
File: Format (no auto-title, OpenLayers/Format.js)
@@ -113,10 +121,18 @@ Group: OpenLayers {
File: JSON (no auto-title, OpenLayers/Format/JSON.js)
File: KML (no auto-title, OpenLayers/Format/KML.js)
File: OSM (no auto-title, OpenLayers/Format/OSM.js)
Group: SLD {
File: SLD (no auto-title, OpenLayers/Format/SLD.js)
File: v1 (no auto-title, OpenLayers/Format/SLD/v1.js)
File: v1_0_0 (no auto-title, OpenLayers/Format/SLD/v1_0_0.js)
} # Group: SLD
File: Text (no auto-title, OpenLayers/Format/Text.js)
File: WFS (no auto-title, OpenLayers/Format/WFS.js)
File: WKT (no auto-title, OpenLayers/Format/WKT.js)
File: XML (no auto-title, OpenLayers/Format/XML.js)
Group: WMC {
@@ -126,7 +142,6 @@ Group: OpenLayers {
File: v1_1_0 (no auto-title, OpenLayers/Format/WMC/v1_1_0.js)
} # Group: WMC
File: XML (no auto-title, OpenLayers/Format/XML.js)
} # Group: Format
Group: Geometry {
@@ -142,7 +157,6 @@ Group: OpenLayers {
File: Point (no auto-title, OpenLayers/Geometry/Point.js)
File: Polygon (no auto-title, OpenLayers/Geometry/Polygon.js)
File: Rectangle (no auto-title, OpenLayers/Geometry/Rectangle.js)
File: Surface (no auto-title, OpenLayers/Geometry/Surface.js)
} # Group: Geometry
Group: Handler {
@@ -166,6 +180,7 @@ Group: OpenLayers {
Group: Lang {
File: Lang (no auto-title, OpenLayers/Lang.js)
File: Lang["cs-CZ"] (OpenLayers/Lang/cs-CZ.js)
File: Lang["de"] (no auto-title, OpenLayers/Lang/de.js)
File: Lang["en"] (no auto-title, OpenLayers/Lang/en.js)
File: Lang["en-CA"] (no auto-title, OpenLayers/Lang/en-CA.js)
@@ -217,6 +232,8 @@ Group: OpenLayers {
File: Popup (no auto-title, OpenLayers/Popup.js)
File: Anchored (no auto-title, OpenLayers/Popup/Anchored.js)
File: AnchoredBubble (no auto-title, OpenLayers/Popup/AnchoredBubble.js)
File: Framed (OpenLayers/Popup/Framed.js)
File: FramedCloud (OpenLayers/Popup/FramedCloud.js)
} # Group: Popup
File: Projection (no auto-title, OpenLayers/Projection.js)
@@ -229,14 +246,7 @@ Group: OpenLayers {
File: VML (no auto-title, OpenLayers/Renderer/VML.js)
} # Group: Renderer
Group: Rule {
File: Rule (no auto-title, OpenLayers/Rule.js)
File: Comparison (no auto-title, OpenLayers/Rule/Comparison.js)
File: FeatureId (no auto-title, OpenLayers/Rule/FeatureId.js)
File: Logical (no auto-title, OpenLayers/Rule/Logical.js)
} # Group: Rule
File: Style (no auto-title, OpenLayers/Style.js)
File: StyleMap (no auto-title, OpenLayers/StyleMap.js)

14
lib/OpenLayers/BaseTypes/Bounds.js
View File

@@ -18,25 +18,25 @@ OpenLayers.Bounds = OpenLayers.Class({
/**
* Property: left
* {Number}
* {Number} Minimum horizontal coordinate.
*/
left: null,
/**
* Property: bottom
* {Number}
* {Number} Minimum vertical coordinate.
*/
bottom: null,
/**
* Property: right
* {Number}
* {Number} Maximum horizontal coordinate.
*/
right: null,
/**
* Property: top
* {Number}
* {Number} Maximum vertical coordinate.
*/
top: null,
@@ -349,7 +349,7 @@ OpenLayers.Bounds = OpenLayers.Class({
*
* Parameters:
* bounds - {<OpenLayers.Bounds>}
* inclusive - {<Boolean>} Whether or not to include the border. Default
* inclusive - {Boolean} Whether or not to include the border. Default
* is true.
*
* Returns:
@@ -384,10 +384,10 @@ OpenLayers.Bounds = OpenLayers.Class({
* APIMethod: containsBounds
*
* bounds - {<OpenLayers.Bounds>}
* partial - {<Boolean>} If true, only part of passed-in bounds needs be
* partial - {Boolean} If true, only part of passed-in bounds needs be
* within this bounds. If false, the entire passed-in bounds must be
* within. Default is false
* inclusive - {<Boolean>} Whether or not to include the border. Default is
* inclusive - {Boolean} Whether or not to include the border. Default is
* true.
*
* Returns:

2
lib/OpenLayers/Control.js
View File

@@ -103,7 +103,7 @@ OpenLayers.Control = OpenLayers.Class({
/**
* Property: active
* {boolean} null
* {Boolean} The control is active.
*/
active: null,

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

@@ -30,8 +30,8 @@ OpenLayers.Control.DragPan = OpenLayers.Class(OpenLayers.Control, {
/**
* Method: draw
* Creates a Drag handler, using <OpenLayers.Control.PanMap.panMap> and
* <OpenLayers.Control.PanMap.panMapDone> as callbacks.
* Creates a Drag handler, using <panMap> and
* <panMapDone> as callbacks.
*/
draw: function() {
this.handler = new OpenLayers.Handler.Drag(this,

4
lib/OpenLayers/Control/ModifyFeature.js
View File

@@ -72,7 +72,7 @@ OpenLayers.Control.ModifyFeature = OpenLayers.Class(OpenLayers.Control, {
/**
* Property: selectControl
* {<OpenLayers.Control.Select>}
* {<OpenLayers.Control.SelectFeature>}
*/
selectControl: null,
@@ -99,7 +99,7 @@ OpenLayers.Control.ModifyFeature = OpenLayers.Class(OpenLayers.Control, {
/**
* APIProperty: virtualStyle
* {<OpenLayers.Feature.Vector.Style>}
* {Object} A symbolizer to be used for virtual vertices.
*/
virtualStyle: null,

3
lib/OpenLayers/Control/NavToolbar.js
View File

@@ -10,6 +10,9 @@
/**
* Class: OpenLayers.Control.NavToolbar
*
* Inherits from:
* - <OpenLayers.Control.Panel>
*/
OpenLayers.Control.NavToolbar = OpenLayers.Class(OpenLayers.Control.Panel, {

6
lib/OpenLayers/Control/NavigationHistory.js
View File

@@ -16,7 +16,7 @@
* when there are no states to restore.
*
* Inherits from:
* - <OpenLayers.Control.Control>
* - <OpenLayers.Control>
*/
OpenLayers.Control.NavigationHistory = OpenLayers.Class(OpenLayers.Control, {
@@ -32,7 +32,7 @@ OpenLayers.Control.NavigationHistory = OpenLayers.Class(OpenLayers.Control, {
/**
* APIProperty: previous
* {OpenLayers.Control} A button type control whose trigger method restores
* {<OpenLayers.Control>} A button type control whose trigger method restores
* the previous state managed by this control.
*/
previous: null,
@@ -46,7 +46,7 @@ OpenLayers.Control.NavigationHistory = OpenLayers.Class(OpenLayers.Control, {
/**
* APIProperty: next
* {OpenLayers.Control} A button type control whose trigger method restores
* {<OpenLayers.Control>} A button type control whose trigger method restores
* the next state managed by this control.
*/
next: null,

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

@@ -8,7 +8,7 @@
*/
/**
* Class: OpenLayers.PanZoom
* Class: OpenLayers.Control.PanZoom
*
* Inherits from:
* - <OpenLayers.Control>

3
lib/OpenLayers/Control/PanZoomBar.js
View File

@@ -12,7 +12,6 @@
*
* Inherits from:
* - <OpenLayers.Control.PanZoom>
* - <OpenLayers.Control>
*/
OpenLayers.Control.PanZoomBar = OpenLayers.Class(OpenLayers.Control.PanZoom, {
@@ -56,7 +55,7 @@ OpenLayers.Control.PanZoomBar = OpenLayers.Class(OpenLayers.Control.PanZoom, {
zoomWorldIcon: false,
/**
* Constructor: <OpenLayers.Control.PanZoomBar>
* Constructor: OpenLayers.Control.PanZoomBar
*/
initialize: function() {
OpenLayers.Control.PanZoom.prototype.initialize.apply(this, arguments);

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

@@ -15,7 +15,7 @@
OpenLayers.Control.Panel = OpenLayers.Class(OpenLayers.Control, {
/**
* Property: controls
* Array({<OpenLayers.Control>})
* {Array(<OpenLayers.Control>)}
*/
controls: null,

5
lib/OpenLayers/Filter/Comparison.js
View File

@@ -68,9 +68,6 @@ OpenLayers.Filter.Comparison = OpenLayers.Class(OpenLayers.Filter, {
* Creates a comparison rule.
*
* Parameters:
* params - {Object} Hash of parameters for this rule:
* -
* - value:
* options - {Object} An optional object with properties to set on the
* rule
*
@@ -204,7 +201,7 @@ OpenLayers.Filter.Comparison = OpenLayers.Class(OpenLayers.Filter, {
* value - {String} or {Number}, same as property
*
* Returns:
* {boolean}
* {Boolean}
*/
binaryCompare: function(context, property, value) {
switch (this.type) {

4
lib/OpenLayers/Filter/FeatureId.js
View File

@@ -19,7 +19,7 @@ OpenLayers.Filter.FeatureId = OpenLayers.Class(OpenLayers.Filter, {
/**
* APIProperty: fids
* {Array(<String>)} Feature Ids to evaluate this rule against. To be passed
* {Array(String)} Feature Ids to evaluate this rule against. To be passed
* To be passed inside the params object.
*/
fids: null,
@@ -50,7 +50,7 @@ OpenLayers.Filter.FeatureId = OpenLayers.Class(OpenLayers.Filter, {
* for plain features against the id.
*
* Returns:
* {boolean} true if the rule applies, false if it does not
* {Boolean} true if the rule applies, false if it does not
*/
evaluate: function(feature) {
for (var i=0; i<this.fids.length; i++) {

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

@@ -267,7 +267,7 @@ OpenLayers.Format.GeoRSS = OpenLayers.Class(OpenLayers.Format.XML, {
* Accept Feature Collection, and return a string.
*
* Parameters:
* features - Array({<OpenLayers.Feature.Vector>}) List of features to serialize into a string.
* features - {Array(<OpenLayers.Feature.Vector>)} List of features to serialize into a string.
*/
write: function(features) {
var georss;

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

@@ -283,7 +283,7 @@ OpenLayers.Format.OSM = OpenLayers.Class(OpenLayers.Format.XML, {
* in tools like JOSM.
*
* Parameters:
* features - Array({<OpenLayers.Feature.Vector>})
* features - {Array(<OpenLayers.Feature.Vector>)}
*/
write: function(features) {
if (!(features instanceof Array)) {

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

@@ -31,7 +31,7 @@ OpenLayers.Geometry.MultiPoint = OpenLayers.Class(
* Create a new MultiPoint Geometry
*
* Parameters:
* components - Array({<OpenLayers.Geometry.Point>})
* components - {Array(<OpenLayers.Geometry.Point>)}
*
* Returns:
* {<OpenLayers.Geometry.MultiPoint>}

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

@@ -33,7 +33,7 @@ OpenLayers.Geometry.Polygon = OpenLayers.Class(
*
*
* Parameters:
* components - Array({<OpenLayers.Geometry.LinearRing>})
* components - {Array(<OpenLayers.Geometry.LinearRing>)}
*/
initialize: function(components) {
OpenLayers.Geometry.Collection.prototype.initialize.apply(this,

7
lib/OpenLayers/Geometry/Surface.js
View File

@@ -6,15 +6,8 @@
* @requires OpenLayers/Geometry.js
*/
/**
* Class: OpenLayers.Geometry.Surface
*/
OpenLayers.Geometry.Surface = OpenLayers.Class(OpenLayers.Geometry, {
/**
* Constructor: OpenLayers.Geometry.Surface
*
*/
initialize: function() {
OpenLayers.Geometry.prototype.initialize.apply(this, arguments);
},

2
lib/OpenLayers/Handler/Click.js
View File

@@ -79,7 +79,7 @@ OpenLayers.Handler.Click = OpenLayers.Class(OpenLayers.Handler, {
/**
* Property: timerId
* {Number} The id of the timeout waiting to clear the <delayedEvent>.
* {Number} The id of the timeout waiting to clear the <delayedCall>.
*/
timerId: null,

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

@@ -26,7 +26,7 @@ OpenLayers.Layer.GeoRSS = OpenLayers.Class(OpenLayers.Layer.Markers, {
/**
* Property: features
* Array({<OpenLayers.Feature>})
* {Array(<OpenLayers.Feature>)}
*/
features: null,

4
lib/OpenLayers/Layer/MapServer/Untiled.js
View File

@@ -9,8 +9,8 @@
/**
* Class: OpenLayers.Layer.MapServer.Untiled
* Deprecated, to be removed in 3.0 - instead use OpenLayers.Layer.MapServer and
* pass the option 'singleTile' as true.
* *Deprecated*. To be removed in 3.0. Instead use OpenLayers.Layer.MapServer
* and pass the option 'singleTile' as true.
*
* Inherits from:
* - <OpenLayers.Layer.MapServer>

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

@@ -23,7 +23,7 @@ OpenLayers.Layer.Markers = OpenLayers.Class(OpenLayers.Layer, {
/**
* Property: markers
* Array({<OpenLayers.Marker>}) internal marker list
* {Array(<OpenLayers.Marker>)} internal marker list
*/
markers: null,

4
lib/OpenLayers/Layer/MultiMap.js
View File

@@ -13,8 +13,8 @@
* option. See Ticket #953 for more details.
*
* Inherits from:
* - <OpenLayers.Layers.EventPane>
* - <OpenLayers.Layers.FixedZoomLevels>
* - <OpenLayers.Layer.EventPane>
* - <OpenLayers.Layer.FixedZoomLevels>
*/
OpenLayers.Layer.MultiMap = OpenLayers.Class(
OpenLayers.Layer.EventPane, OpenLayers.Layer.FixedZoomLevels, {

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

@@ -50,7 +50,7 @@ OpenLayers.Layer.Text = OpenLayers.Class(OpenLayers.Layer.Markers, {
/**
* Property: features
* Array({<OpenLayers.Feature>})
* {Array(<OpenLayers.Feature>)}
*/
features: null,

6
lib/OpenLayers/Layer/Vector.js
View File

@@ -87,13 +87,13 @@ OpenLayers.Layer.Vector = OpenLayers.Class(OpenLayers.Layer, {
/**
* APIProperty: features
* Array({<OpenLayers.Feature.Vector>})
* {Array(<OpenLayers.Feature.Vector>)}
*/
features: null,
/**
* Property: selectedFeatures
* Array({<OpenLayers.Feature.Vector>})
* {Array(<OpenLayers.Feature.Vector>)}
*/
selectedFeatures: null,
@@ -118,7 +118,7 @@ OpenLayers.Layer.Vector = OpenLayers.Class(OpenLayers.Layer, {
/**
* Property: renderers
* Array({String}) List of supported Renderer classes. Add to this list to
* {Array(String)} List of supported Renderer classes. Add to this list to
* add support for additional renderers. This list is ordered:
* the first renderer which returns true for the 'supported()'
* method will be used, if not defined in the 'renderer' option.

2
lib/OpenLayers/Layer/WMS/Untiled.js
View File

@@ -9,7 +9,7 @@
/**
* Class: OpenLayers.Layer.WMS.Untiled
* Deprecated, to be removed in 3.0 - instead use OpenLayers.Layer.WMS and
* *Deprecated*. To be removed in 3.0. Instead use OpenLayers.Layer.WMS and
* pass the option 'singleTile' as true.
*
* Inherits from:

2
lib/OpenLayers/Map.js
View File

@@ -820,7 +820,7 @@ OpenLayers.Map = OpenLayers.Class({
* APIMethod: addLayers
*
* Parameters:
* layers - Array({<OpenLayers.Layer>})
* layers - {Array(<OpenLayers.Layer>)}
*/
addLayers: function (layers) {
for (var i = 0; i < layers.length; i++) {

2
lib/OpenLayers/Rule.js
View File

@@ -122,7 +122,7 @@ OpenLayers.Rule = OpenLayers.Class({
* feature - {<OpenLayers.Feature>} feature to apply the rule to.
*
* Returns:
* {boolean} true if the rule applies, false if it does not.
* {Boolean} true if the rule applies, false if it does not.
* This rule is the default rule and always returns true.
*/
evaluate: function(feature) {

2
lib/OpenLayers/Style.js
View File

@@ -48,7 +48,7 @@ OpenLayers.Style = OpenLayers.Class({
/**
* Property: rules
* Array({<OpenLayers.Rule>})
* {Array(<OpenLayers.Rule>)}
*/
rules: null,