Documentation OpenLayers API vs documentation développeur

Le site Web d'OpenLayers fournit deux ensembles de documentation de référence:

• Documents API: http://dev.openlayers.org/apidocs/
• Documentation développeur: http://dev.openlayers.org/docs/

Pour la plupart des classes, les documents API contiennent un petit sous-ensemble de ce qui se trouve dans la documentation du développeur. Je trouve que je ne peux généralement pas faire grand-chose en utilisant uniquement les fonctionnalités décrites dans la documentation de l'API, donc j'utilise la documentation du développeur (et je lis la source et les exemples).

Quelle est la distinction officielle entre ces deux ensembles de documentation? Les documents API décrivent-ils des interfaces qui devraient être stables? Suis-je à risque de rupture future si j'utilise des fonctionnalités décrites uniquement dans la documentation du développeur?

Je dois modifier ma réponse pour corriger un peu. Concernant OpenLayers, il existe plusieurs documentations principales:

1 - Un wiki comme celui-ci

2 - Documentation API

3 - Documentation développeur

4 - Documentation de la dernière version / trunk API

5 - Documentation du développeur de la dernière version / trunk

La documentation de l'API est destinée à décrire les détails stables de l' API , tandis que la documentation des développeurs pointe vers d'autres détails qui sont nécessaires lors du développement d'applications OpenLayers.

"Il existe deux types de propriétés / méthodes dans le code OpenLayers: un ensemble est l'ensemble des méthodes et propriétés de l'API. Il existe également des propriétés internes supplémentaires qui ne sont pas exposées à l'API. Javascript n'a pas de membres privés, donc il n'y a pas limitation technique à l'utilisation de ces méthodes non documentées dans le code d'application. Cependant, bien que nous nous efforcions de ne pas modifier les API entre les versions, les méthodes et les propriétés qui ne sont pas explicitement déclarées comme méthodes API peuvent changer dans les versions mineures.

La documentation ci-dessus "(l'API doc 2 et 4)" inclut uniquement les méthodes API. La documentation complète du développeur / de la bibliothèque interne est également disponible sous "(3 et 5)", mais les méthodes qui ne sont pas disponibles dans la documentation de l'API ci-dessus ne peuvent pas dépendre pour rester les mêmes entre les versions. Si vous utilisez des méthodes incluses dans ces documents, vous devrez peut-être apporter des modifications à votre code d'application pour qu'il s'exécute entre les versions mineures d'OpenLayers. "

BONNE RÉPONSE: Vous devez vous fier aux documents API de la dernière version, lien à partir du point 2, pour être sûr que votre code est relativement sûr par rapport aux nouvelles versions.

Mauvaise réponse <>

Ma réponse correcte réelle est basée sur . Il y a une discussion similaire ici .