Documentazione API OpenLayers vs. documentazione per sviluppatori

Il sito Web OpenLayers fornisce due serie di documentazione di riferimento:

• Documenti API: http://dev.openlayers.org/apidocs/
• Documentazione per gli sviluppatori: http://dev.openlayers.org/docs/

Per la maggior parte delle classi, i documenti API contengono un piccolo sottoinsieme di ciò che è nella documentazione per gli sviluppatori. Trovo che di solito non riesco a fare molto utilizzando solo le funzionalità descritte in Documenti API, quindi uso la documentazione per sviluppatori (e leggo la fonte e gli esempi).

Qual è la distinzione ufficiale tra questi due set di documentazione? I documenti API descrivono le interfacce che dovrebbero essere stabili? Rischio di rotture future se utilizzo le funzionalità descritte solo nella Documentazione per gli sviluppatori?

Devo modificare la mia risposta per correggere un po '. In relazione a OpenLayer ci sono diverse documentazioni principali:

1 - Una wiki come questa

2 - Documentazione API

3 - Documentazione per gli sviluppatori

4 - Ultima versione / documentazione API trunk

5 - Ultima versione / trunk Documentazione per sviluppatori

La documentazione dell'API ha lo scopo di descrivere i dettagli stabili dell'API , mentre la documentazione per gli sviluppatori indica altri dettagli necessari per lo sviluppo di applicazioni OpenLayers.

"Esistono due tipi di proprietà / metodi nel codice OpenLayers: un set è l'insieme di metodi e proprietà API. Esistono anche proprietà interne aggiuntive che non sono esposte all'API. Javascript non ha membri privati, quindi non esiste limitazione tecnica all'utilizzo di questi metodi non documentati nel codice dell'applicazione, tuttavia, mentre facciamo ogni sforzo per non modificare le API tra versioni, metodi e proprietà che non sono esplicitamente dichiarati come i metodi API possono cambiare in versioni secondarie.

La documentazione sopra "(i documenti API 2 e 4)" include solo i metodi API. La documentazione completa per sviluppatori / librerie interne è disponibile anche sotto "(3 e 5)", ma i metodi che non sono disponibili nella documentazione API sopra riportata non possono dipendere dal fatto che rimangano gli stessi tra le versioni. Se si utilizzano i metodi inclusi in questi documenti, potrebbe essere necessario apportare modifiche al codice dell'applicazione per l'esecuzione tra versioni secondarie di OpenLayer. "

BUONA RISPOSTA: dovresti fare affidamento sui documenti API dell'ultima versione, link dal punto 2, per essere sicuro che il tuo codice sia relativamente sicuro rispetto alle nuove versioni.

RISPOSTA ERRATA <>

La mia vera risposta corretta si basa su . C'è una discussione simile qui .