re-add the Constructor API doc removed in r11640 (see #3147)

git-svn-id: http://svn.openlayers.org/trunk/openlayers@11652 dc9f47b5-9b13-0410-9fdd-eb0c1a62fdaf
This commit is contained in:
Frédéric Junod
2011-03-07 14:13:32 +00:00
parent 7865f4d1f3
commit 415aca4763
17 changed files with 152 additions and 1 deletions

View File

@@ -59,6 +59,15 @@ OpenLayers.Format.Atom = OpenLayers.Class(OpenLayers.Format.XML, {
*/ */
xy: false, xy: false,
/**
* Constructor: OpenLayers.Format.AtomEntry
* Create a new parser for Atom.
*
* Parameters:
* options - {Object} An optional object whose properties will be set on
* this instance.
*/
/** /**
* APIMethod: read * APIMethod: read
* Return a list of features from an Atom feed or entry document. * Return a list of features from an Atom feed or entry document.

View File

@@ -39,6 +39,15 @@ OpenLayers.Format.Filter = OpenLayers.Class(OpenLayers.Format.XML, {
*/ */
parser: null, parser: null,
/**
* Constructor: OpenLayers.Format.Filter
* Create a new parser for Filter.
*
* Parameters:
* options - {Object} An optional object whose properties will be set on
* this instance.
*/
/** /**
* APIMethod: write * APIMethod: write
* Write an ogc:Filter given a filter object. * Write an ogc:Filter given a filter object.

View File

@@ -32,6 +32,15 @@ OpenLayers.Format.GeoJSON = OpenLayers.Class(OpenLayers.Format.JSON, {
*/ */
ignoreExtraDims: false, ignoreExtraDims: false,
/**
* Constructor: OpenLayers.Format.GeoJSON
* Create a new parser for GeoJSON.
*
* Parameters:
* options - {Object} An optional object whose properties will be set on
* this instance.
*/
/** /**
* APIMethod: read * APIMethod: read
* Deserialize a GeoJSON string. * Deserialize a GeoJSON string.

View File

@@ -75,6 +75,15 @@ OpenLayers.Format.GeoRSS = OpenLayers.Class(OpenLayers.Format.XML, {
*/ */
xy: false, xy: false,
/**
* Constructor: OpenLayers.Format.GeoRSS
* Create a new parser for GeoRSS.
*
* Parameters:
* options - {Object} An optional object whose properties will be set on
* this instance.
*/
/** /**
* Method: createGeometryFromItem * Method: createGeometryFromItem
* Return a geometry from a GeoRSS Item. * Return a geometry from a GeoRSS Item.

View File

@@ -67,6 +67,15 @@ OpenLayers.Format.JSON = OpenLayers.Class(OpenLayers.Format, {
return !!(window.JSON && typeof JSON.parse == "function" && typeof JSON.stringify == "function"); return !!(window.JSON && typeof JSON.parse == "function" && typeof JSON.stringify == "function");
})(), })(),
/**
* Constructor: OpenLayers.Format.JSON
* Create a new parser for JSON.
*
* Parameters:
* options - {Object} An optional object whose properties will be set on
* this instance.
*/
/** /**
* APIMethod: read * APIMethod: read
* Deserialize a json string. * Deserialize a json string.

View File

@@ -24,6 +24,15 @@ OpenLayers.Format.OWSContext = OpenLayers.Class(OpenLayers.Format.Context,{
*/ */
defaultVersion: "0.3.1", defaultVersion: "0.3.1",
/**
* Constructor: OpenLayers.Format.OWSContext
* Create a new parser for OWS Context documents.
*
* Parameters:
* options - {Object} An optional object whose properties will be set on
* this instance.
*/
/** /**
* Method: getParser * Method: getParser
* Get the OWSContext parser given a version. Create a new parser if it does not * Get the OWSContext parser given a version. Create a new parser if it does not

View File

@@ -50,6 +50,15 @@ OpenLayers.Format.SLD = OpenLayers.Class(OpenLayers.Format.XML, {
*/ */
parser: null, parser: null,
/**
* Constructor: OpenLayers.Format.SLD
* Create a new parser for SLD.
*
* Parameters:
* options - {Object} An optional object whose properties will be set on
* this instance.
*/
/** /**
* APIMethod: write * APIMethod: write
* Write a SLD document given a list of styles. * Write a SLD document given a list of styles.

View File

@@ -34,6 +34,15 @@ OpenLayers.Format.SOSCapabilities = OpenLayers.Class(OpenLayers.Format.XML, {
*/ */
parser: null, parser: null,
/**
* Constructor: OpenLayers.Format.SOSCapabilities
* Create a new parser for SOS Capabilities.
*
* Parameters:
* options - {Object} An optional object whose properties will be set on
* this instance.
*/
/** /**
* APIMethod: read * APIMethod: read
* Read capabilities data from a string, and return information about * Read capabilities data from a string, and return information about

View File

@@ -59,6 +59,14 @@ OpenLayers.Format.SOSGetFeatureOfInterest = OpenLayers.Class(
trimComma: (/\s*,\s*/g) trimComma: (/\s*,\s*/g)
}, },
/**
* Constructor: OpenLayers.Format.SOSGetFeatureOfInterest
*
* Parameters:
* options - {Object} An optional object whose properties will be set on
* this instance.
*/
/** /**
* APIMethod: read * APIMethod: read
* Parse a GetFeatureOfInterest response and return an array of features * Parse a GetFeatureOfInterest response and return an array of features

View File

@@ -61,6 +61,14 @@ OpenLayers.Format.SOSGetObservation = OpenLayers.Class(OpenLayers.Format.XML, {
*/ */
defaultPrefix: "sos", defaultPrefix: "sos",
/**
* Constructor: OpenLayers.Format.SOSGetObservation
*
* Parameters:
* options - {Object} An optional object whose properties will be set on
* this instance.
*/
/** /**
* Method: read * Method: read
* *

View File

@@ -28,6 +28,15 @@ OpenLayers.Format.WFSCapabilities = OpenLayers.Class(OpenLayers.Format.XML, {
*/ */
version: null, version: null,
/**
* Constructor: OpenLayers.Format.WFSCapabilities
* Create a new parser for WFS capabilities.
*
* Parameters:
* options - {Object} An optional object whose properties will be set on
* this instance.
*/
/** /**
* APIMethod: read * APIMethod: read
* Read capabilities data from a string, and return a list of layers. * Read capabilities data from a string, and return a list of layers.

View File

@@ -23,6 +23,15 @@ OpenLayers.Format.WFSDescribeFeatureType = OpenLayers.Class(
xsd: "http://www.w3.org/2001/XMLSchema" xsd: "http://www.w3.org/2001/XMLSchema"
}, },
/**
* Constructor: OpenLayers.Format.WFSDescribeFeatureType
* Create a new parser for WFS DescribeFeatureType responses.
*
* Parameters:
* options - {Object} An optional object whose properties will be set on
* this instance.
*/
/** /**
* Property: readers * Property: readers
* Contains public functions, grouped by namespace prefix, that will * Contains public functions, grouped by namespace prefix, that will

View File

@@ -23,6 +23,15 @@ OpenLayers.Format.WMC = OpenLayers.Class(OpenLayers.Format.Context, {
*/ */
defaultVersion: "1.1.0", defaultVersion: "1.1.0",
/**
* Constructor: OpenLayers.Format.WMC
* Create a new parser for Web Map Context documents.
*
* Parameters:
* options - {Object} An optional object whose properties will be set on
* this instance.
*/
/** /**
* Method: getParser * Method: getParser
* Get the WMC parser given a version. Create a new parser if it does not * Get the WMC parser given a version. Create a new parser if it does not

View File

@@ -43,6 +43,15 @@ OpenLayers.Format.WMSCapabilities = OpenLayers.Class(OpenLayers.Format.XML, {
*/ */
parser: null, parser: null,
/**
* Constructor: OpenLayers.Format.WMSCapabilities
* Create a new parser for WMS capabilities.
*
* Parameters:
* options - {Object} An optional object whose properties will be set on
* this instance.
*/
/** /**
* APIMethod: read * APIMethod: read
* Read capabilities data from a string, and return a list of layers. * Read capabilities data from a string, and return a list of layers.

View File

@@ -29,6 +29,15 @@ OpenLayers.Format.WMSDescribeLayer = OpenLayers.Class(OpenLayers.Format.XML, {
*/ */
version: null, version: null,
/**
* Constructor: OpenLayers.Format.WMSDescribeLayer
* Create a new parser for WMS DescribeLayer responses.
*
* Parameters:
* options - {Object} An optional object whose properties will be set on
* this instance.
*/
/** /**
* APIMethod: read * APIMethod: read
* Read DescribeLayer data from a string, and return the response. * Read DescribeLayer data from a string, and return the response.

View File

@@ -48,6 +48,15 @@ OpenLayers.Format.WMSGetFeatureInfo = OpenLayers.Class(OpenLayers.Format.XML, {
*/ */
gmlFormat: null, gmlFormat: null,
/**
* Constructor: OpenLayers.Format.WMSGetFeatureInfo
* Create a new parser for WMS GetFeatureInfo responses
*
* Parameters:
* options - {Object} An optional object whose properties will be set on
* this instance.
*/
/** /**
* APIMethod: read * APIMethod: read
* Read WMS GetFeatureInfo data from a string, and return an array of features * Read WMS GetFeatureInfo data from a string, and return an array of features

View File

@@ -47,6 +47,15 @@ OpenLayers.Format.WMTSCapabilities = OpenLayers.Class(OpenLayers.Format.XML, {
"urn:ogc:def:crs:EPSG::4326": true "urn:ogc:def:crs:EPSG::4326": true
}, },
/**
* Constructor: OpenLayers.Format.WMTSCapabilities
* Create a new parser for WMTS capabilities.
*
* Parameters:
* options - {Object} An optional object whose properties will be set on
* this instance.
*/
/** /**
* APIMethod: read * APIMethod: read
* Read capabilities data from a string, and return information about * Read capabilities data from a string, and return information about