Quantcast

documentation

classic Classic list List threaded Threaded
3 messages Options
Reply | Threaded
Open this post in threaded view
|  
Report Content as Inappropriate

documentation

jim white
I noticed the documentation for the API linked to the web site is incomplete compared to what you can find with googling.

http://dev.openlayers.org/releases/OpenLayers-2.12/doc/apidocs/files/OpenLayers/Control/WMSGetFeatureInfo-js.html

http://dev.openlayers.org/docs/files/OpenLayers/Control/WMSGetFeatureInfo-js.html

Jim

--
James B. White
Cary, NC
H: 919-380-9615
M: 919-698-1765
White Coding and Maps

_______________________________________________
Users mailing list
[hidden email]
http://lists.osgeo.org/mailman/listinfo/openlayers-users
Reply | Threaded
Open this post in threaded view
|  
Report Content as Inappropriate

Re: documentation

Matt Priour
Actually, that is an intentional difference.
The 1st link is to the 2.12 release API documentation. This is limited (by design) to public API methods (as marked in the docs within the code). Also since it is tied to the 2.12 release, it is a static snapshot of the api at the time of the latest 2.12 release. The API methods are not supposed to change between releases and require at least 2 release cycles of deprecation warnings before being moved to the deprecated file and even then, by including the deprecated.js file, you can still get them back.

While, the 2nd link is to the 'trunk' or 'nightly' developer documentation. This documentation includes every documented method in every class and is updated every time a commit is made to the master branch of OpenLayers. The non-API methods may change or even be removed entirely between releases without warning or notice. Thus this documentation presents a very different view of the class methods and properties than the API documentation.

Hope that helps clarify things for you

Matt Priour

On 01/29/2013 06:51 PM, Jim White wrote:
I noticed the documentation for the API linked to the web site is incomplete compared to what you can find with googling.

http://dev.openlayers.org/releases/OpenLayers-2.12/doc/apidocs/files/OpenLayers/Control/WMSGetFeatureInfo-js.html

http://dev.openlayers.org/docs/files/OpenLayers/Control/WMSGetFeatureInfo-js.html

Jim

--
James B. White
Cary, NC
H: 919-380-9615
M: 919-698-1765
White Coding and Maps


_______________________________________________
Users mailing list
[hidden email]
http://lists.osgeo.org/mailman/listinfo/openlayers-users


_______________________________________________
Users mailing list
[hidden email]
http://lists.osgeo.org/mailman/listinfo/openlayers-users
Reply | Threaded
Open this post in threaded view
|  
Report Content as Inappropriate

Re: documentation

jim white
In reply to this post by jim white
Thanks Matt,

I see that  if you look in the source there are 2 different APIs also. I suppose you should try to build to the public API and resort to using the dev API when things don't work.

Jim



Actually, that is an intentional
      difference.
      The 1st link is to the 2.12 release API documentation. This is
      limited (by design) to public API methods (as marked in the docs
      within the code). Also since it is tied to the 2.12 release, it is
      a static snapshot of the api at the time of the latest 2.12
      release. The API methods are not supposed to change between
      releases and require at least 2 release cycles of deprecation
      warnings before being moved to the deprecated file and even then,
      by including the deprecated.js file, you can still get them back

      While, the 2nd link is to the 'trunk' or 'nightly' developer
      documentation. This documentation includes every documented method
      in every class and is updated every time a commit is made to the
      master branch of OpenLayers. The non-API methods may change or
      even be removed entirely between releases without warning or
      notice. Thus this documentation presents a very different view of
      the class methods and properties than the API documentation
--
James B. White
Cary, NC
H: 919-380-9615
M: 919-698-1765
White Coding and Maps

_______________________________________________
Users mailing list
[hidden email]
http://lists.osgeo.org/mailman/listinfo/openlayers-users
Loading...