mirror/openseadragon
1
0
Fork 0
mirror of https://github.com/openseadragon/openseadragon.git synced 2024-11-29 00:26:10 +03:00
Code Issues Projects Releases Wiki Activity

Improve comment for destroy() method.

Browse Source
This commit is contained in:
Henri Astre 2014-06-18 12:56:36 -07:00
parent a563bdb658
commit f86f9063fd
1 changed files with 11 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
src/viewer.js
View File

@ -578,8 +578,17 @@ $.extend( $.Viewer.prototype, $.EventSource.prototype, $.ControlDock.prototype,
/**
* Function to destroy the viewer and clean up everything created by
* OpenSeadragon.
* Function to destroy the viewer and clean up everything created by OpenSeadragon.
*
* Example:
* var viewer = OpenSeadragon({
* [...]
* });
*
* //when you are done with the viewer:
* viewer.destroy();
* viewer = null; //important
*
* @function
*/
destroy: function( ) {