Fix some problems in the documentation.

This commit is contained in:
Xavier Mamano
2012-03-05 11:43:09 +01:00
parent d3a4275136
commit bfb379f349
45 changed files with 106 additions and 58 deletions
+3 -3
View File
@@ -418,7 +418,7 @@ OpenLayers.Format.Atom = OpenLayers.Class(OpenLayers.Format.XML, {
* node - {DOMElement} An Atom entry or feed node.
*
* Returns:
* An <OpenLayers.Feature.Vector>.
* {<OpenLayers.Feature.Vector>}
*/
parseFeature: function(node) {
var atomAttrib = {};
@@ -554,7 +554,7 @@ OpenLayers.Format.Atom = OpenLayers.Class(OpenLayers.Format.XML, {
* node - {DOMElement} An Atom entry or feed node.
*
* Returns:
* An Array of <OpenLayers.Feature.Vector>s.
* Array({<OpenLayers.Feature.Vector>})
*/
parseFeatures: function(node) {
var features = [];
@@ -578,7 +578,7 @@ OpenLayers.Format.Atom = OpenLayers.Class(OpenLayers.Format.XML, {
* node - {DOMElement} An Atom entry or feed node.
*
* Returns:
* An Array of <OpenLayers.Geometry>s.
* Array({<OpenLayers.Geometry>})
*/
parseLocations: function(node) {
var georssns = this.namespaces.georss;
+1
View File
@@ -887,6 +887,7 @@ OpenLayers.Format.GML = OpenLayers.Class(OpenLayers.Format.XML, {
* (code)
* <gml:coordinates decimal="." cs="," ts=" ">...</gml:coordinates>
* (end)
*
* Parameters:
* geometry - {<OpenLayers.Geometry>}
*
+1 -1
View File
@@ -615,7 +615,7 @@ OpenLayers.Format.GML.Base = OpenLayers.Class(OpenLayers.Format.XML, {
},
/**
* Function: setGeometryTypes
* Method: setGeometryTypes
* Sets the <geometryTypes> mapping.
*/
setGeometryTypes: function() {
+1 -1
View File
@@ -444,7 +444,7 @@ OpenLayers.Format.GML.v3 = OpenLayers.Class(OpenLayers.Format.GML.Base, {
},
/**
* Function: setGeometryTypes
* Method: setGeometryTypes
* Sets the <geometryTypes> mapping.
*/
setGeometryTypes: function() {
+1 -1
View File
@@ -102,7 +102,7 @@ OpenLayers.Format.GPX = OpenLayers.Class(OpenLayers.Format.XML, {
* doc - {Element}
*
* Returns:
* An Array of <OpenLayers.Feature.Vector>s
* Array({<OpenLayers.Feature.Vector>})
*/
read: function(doc) {
if (typeof doc == "string") {
+1 -1
View File
@@ -287,7 +287,7 @@ OpenLayers.Format.GeoJSON = OpenLayers.Class(OpenLayers.Format.JSON, {
* <OpenLayers.Geometry>.
*
* Parameters:
* array {Object} The coordinates array from the GeoJSON fragment.
* array - {Object} The coordinates array from the GeoJSON fragment.
*
* Returns:
* {<OpenLayers.Geometry>} A geometry.
+1 -1
View File
@@ -90,7 +90,7 @@ OpenLayers.Format.OSM = OpenLayers.Class(OpenLayers.Format.XML, {
* doc - {Element}
*
* Returns:
* An Array of <OpenLayers.Feature.Vector>s
* Array({<OpenLayers.Feature.Vector>})
*/
read: function(doc) {
if (typeof doc == "string") {
+1 -1
View File
@@ -72,7 +72,7 @@ OpenLayers.Format.Text = OpenLayers.Class(OpenLayers.Format, {
* text - {String}
*
* Returns:
* An Array of <OpenLayers.Feature.Vector>s
* Array({<OpenLayers.Feature.Vector>})
*/
read: function(text) {
var lines = text.split('\n');
@@ -5,7 +5,9 @@
/**
* @requires OpenLayers/Format/XML.js
*
*/
/**
* Class: OpenLayers.Format.WFSDescribeFeatureType
* Read WFS DescribeFeatureType response
*
@@ -145,8 +147,8 @@ OpenLayers.Format.WFSDescribeFeatureType = OpenLayers.Class(
* Reads restriction defined in the child nodes of a restriction element
*
* Parameters:
* node {DOMElement} - the node to parse
* obj {Object} - the object that receives the read result
* node - {DOMElement} the node to parse
* obj - {Object} the object that receives the read result
*/
readRestriction: function(node, obj) {
var children = node.childNodes;
+7 -6
View File
@@ -1055,15 +1055,16 @@ OpenLayers.Format.WMC.v1 = OpenLayers.Class(OpenLayers.Format.XML, {
},
/**
* Method: write_wmc_URLType
* Create a LogoURL/DescriptionURL/MetadataURL/DataURL/LegendURL node given a object and elementName.
* Method: write_wmc_URLType
* Create a LogoURL/DescriptionURL/MetadataURL/DataURL/LegendURL node given a object and elementName.
*
* Parameters:
* elName - {String} Name of element (LogoURL/DescriptionURL/MetadataURL/LegendURL)
* url - {String} URL string value
* attr - {Object} Optional attributes (width, height, format)
* elName - {String} Name of element (LogoURL/DescriptionURL/MetadataURL/LegendURL)
* url - {String} URL string value
* attr - {Object} Optional attributes (width, height, format)
*
* Returns:
* {Element} A WMC element node.
* {Element} A WMC element node.
*/
write_wmc_URLType: function(elName, url, attr) {
var node = this.createElementDefaultNS(elName);
+1 -1
View File
@@ -190,7 +190,7 @@ OpenLayers.Format.WMSGetFeatureInfo = OpenLayers.Class(OpenLayers.Format.XML, {
* criteria - {String} Search string which will match some part of a tagName
*
* Returns:
* Array({DOMElement)) An array of sibling xml nodes
* Array({DOMElement}) An array of sibling xml nodes
*/
getSiblingNodesByTagCriteria: function(node, criteria){
var nodes = [];