update docs

This commit is contained in:
rolux 2012-05-30 22:39:47 +02:00
parent b960ef3ea4
commit abc6e948e0

View file

@ -1,13 +1,11 @@
'use strict'; 'use strict';
/*@ /*@
Ox.Map <f:Ox.Element> Basic map object Ox.Map <f> Basic map object
# DESCRIPTION -------------------------------------------------------------- # DESCRIPTION --------------------------------------------------------------
<code>Ox.Map</code> is a wrapper around the <code>Ox.Map</code> is a wrapper around the
<a href="http://code.google.com/apis/maps/documentation/javascript/">Google <a href="http://code.google.com/apis/maps/documentation/javascript/">Google
Maps API</a>. Maps API</a>.
# USAGE --------------------------------------------------------------------
([options[, self]]) -> <o> Map object
# ARGUMENTS ---------------------------------------------------------------- # ARGUMENTS ----------------------------------------------------------------
options <o|{}> options options <o|{}> options
clickable <b|false> If true, clicking on the map finds a place clickable <b|false> If true, clicking on the map finds a place
@ -38,7 +36,9 @@ Ox.Map <f:Ox.Element> Basic map object
showZoombar <b|false> If true, the map has a zoombar showZoombar <b|false> If true, the map has a zoombar
zoomOnlyWhenFocused <b|false> If true, scroll-zoom only when focused zoomOnlyWhenFocused <b|false> If true, scroll-zoom only when focused
self <o|{}> Shared private variable self <o|{}> Shared private variable
# EVENTS ------------------------------------------------------------------- # USAGE --------------------------------------------------------------------
([options[, self]]) -> <o:Ox.Element> Map object
# EVENTS ---------------------------------------------------------------
addplace <!> Fires when a place has been added addplace <!> Fires when a place has been added
place <o> Place object place <o> Place object
editplace <!> Fires when a place has been edited editplace <!> Fires when a place has been edited