Update comment/documentation
This commit is contained in:
@@ -12,6 +12,17 @@
|
||||
* Class: OpenLayers.Format.XML.VersionedOGC
|
||||
* Base class for versioned formats, i.e. a format which supports multiple
|
||||
* versions.
|
||||
*
|
||||
* To enable checking if parsing succeeded, you will need to define a property
|
||||
* called errorProperty on the parser you want to check. The parser will then
|
||||
* check the returned object to see if that property is present. If it is, it
|
||||
* assumes the parsing was successful. If it is not present (or is null), it will
|
||||
* pass the document through an OGCExceptionReport parser.
|
||||
*
|
||||
* If errorProperty is undefined for the parser, this error checking mechanism
|
||||
* will be disabled.
|
||||
*
|
||||
*
|
||||
*
|
||||
* Inherits from:
|
||||
* - <OpenLayers.Format.XML>
|
||||
@@ -45,15 +56,6 @@ OpenLayers.Format.XML.VersionedOGC = OpenLayers.Class(OpenLayers.Format.XML, {
|
||||
*/
|
||||
allowFallback: false,
|
||||
|
||||
/**
|
||||
* APIProperty: errorProperty
|
||||
* {String} Which property of the returned object to check for in order to
|
||||
* determine whether or not parsing has failed. In the case that the
|
||||
* errorProperty is undefined on the returned object, the document will be
|
||||
* run through an OGCExceptionReport parser.
|
||||
*/
|
||||
errorProperty: null,
|
||||
|
||||
/**
|
||||
* Property: name
|
||||
* {String} The name of this parser, this is the part of the CLASS_NAME
|
||||
|
||||
Reference in New Issue
Block a user