sanj/oxjs
1
0
Fork 0
forked from 0x2620/oxjs
Code Pull requests Activity

in documentation use foo, not <code>foo</code>

Browse source
This commit is contained in:
rolux 2012-06-02 13:06:44 +02:00
commit 73fa856900
16 changed files with 89 additions and 105 deletions
Download patch file Download diff file Expand all files Collapse all files

7
source/Ox.UI/js/Core/Element.js
View file

@ -296,7 +296,7 @@ Ox.Element = function(options, self) {
callback <f> Callback function
data <o> event data (key/value pairs)
event <s> Event name
Event names can be namespaced, like <code>'click.foo'</code>
Event names can be namespaced, like `'click.foo'`
@*/
that.bindEvent = function() {
if (Ox.typeOf(arguments[0]) == 'function') {
@ -316,7 +316,7 @@ Ox.Element = function(options, self) {
callback <f> Callback function
data <o> event data (key/value pairs)
event <s> Event name
Event names can be namespaced, like <code>'click.foo'</code>
Event names can be namespaced, like `'click.foo'`
@*/
that.bindEventOnce = function() {
Ox.forEach(Ox.makeObject(arguments), function(callback, event) {
@ -478,8 +478,7 @@ Ox.Element = function(options, self) {
/*@
unbindEvent <function> Unbinds all callbacks from an event
To unbind a specific handler, use namespaced events, like
<code>bindEvent('click.foo', callback)</code>, and then
<code>unbindEvent('click.foo')</code>.
`bindEvent('click.foo', callback)`, and then `unbindEvent('click.foo')`.
() -> <object> This element
Unbinds all callbacks from all events
(callback) -> <o> This element

8
source/Ox.UI/js/Core/Event.js
View file

@ -4,6 +4,7 @@
Ox.Event <o> Basic event handler
@*/
// FIXME: unused
Ox.Event = (function() {
@ -18,7 +19,7 @@ Ox.Event = (function() {
callback <f> Callback function
data <*> Event data
event <s> Event name
Event names can be namespaced, like <code>'click.foo'</code>
Event names can be namespaced, like `'click.foo'`
@*/
that.bind = function() {
Ox.forEach(Ox.makeObject(arguments), function(callback, event) {
@ -38,7 +39,7 @@ Ox.Event = (function() {
callback <f> Callback function
data <*> Event data
event <s> Event name
Event names can be namespaced, like <code>'click.foo'</code>
Event names can be namespaced, like `'click.foo'`
@*/
that.bindOnce = function() {
Ox.forEach(Ox.makeObject(arguments), function(callback, event) {
@ -68,8 +69,7 @@ Ox.Event = (function() {
/*@
unbind <f> Unbinds all callbacks from an event
To unbind a specific handler, use namespaced events, like
<code>bind('click.foo', callback)</code>, and then
<code>unbind('click.foo')</code>.
`bind('click.foo', callback)`, and then `unbind('click.foo')`.
() -> <o> The event handler
Unbinds all events
(event) -> <o> The event handler

5
source/Ox.UI/js/Map/Map.js
View file

@ -3,9 +3,8 @@
/*@
Ox.Map <f> Basic map object
# DESCRIPTION --------------------------------------------------------------
<code>Ox.Map</code> is a wrapper around the
<a href="http://code.google.com/apis/maps/documentation/javascript/">Google
Maps API</a>.
`Ox.Map` is a wrapper around the [Google Maps
API](http://code.google.com/apis/maps/documentation/javascript/).
# ARGUMENTS ----------------------------------------------------------------
options <o|{}> options
clickable <b|false> If true, clicking on the map finds a place

4
source/Ox.UI/js/Panel/TabPanel.js
View file

@ -5,8 +5,8 @@ Ox.TabPanel <f> Tabbed panel
([options[, self]]) -> <o:Ox.SplitPanel> Panel
options <o> Options
content <o|f> Content per tab
Either <code>({id1: $element1, id2: $element2}}</code> or
<code>function(id) { return $element; })</code>
Either `({id1: $element1, id2: $element2}}` or `function(id) {
return $element; })`
size <n|24> Height of the tab bar
tabs [o] Tabs
id <s> Tab id