Skip to content
This repository has been archived by the owner on Dec 9, 2019. It is now read-only.

Commit

Permalink
Updated api docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
@lamberta
lamberta committed Apr 26, 2011
1 parent 3983e21 commit d669d46
Show file tree
Hide file tree
Showing 32 changed files with 344 additions and 192 deletions.
2 changes: 1 addition & 1 deletion build/majdoc
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
s#!/bin/bash
#!/bin/bash
##
## More-or-less Another Javascript Doc tool
##
Expand Down
2 changes: 1 addition & 1 deletion doc/api/colorfilter.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@
<li>ColorFilter</li>
<li>Display</li>
<li>ElementNode</li>
<li>Emitter</li>
<li>Event</li>
<li>EventDispatcher</li>
<li>FontStyle</li>
<li>FontVariant</li>
<li>FontWeight</li>
Expand Down
57 changes: 38 additions & 19 deletions doc/api/display.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@
<li>ColorFilter</li>
<li>Display</li>
<li>ElementNode</li>
<li>Emitter</li>
<li>Event</li>
<li>EventDispatcher</li>
<li>FontStyle</li>
<li>FontVariant</li>
<li>FontWeight</li>
Expand Down Expand Up @@ -60,7 +60,7 @@ <h3>Inherits</h3>
<ol>
<li>ElementNode</li>
<li>Node</li>
<li>EventDispatcher</li>
<li>Emitter</li>
<li>Object</li>
</ol>

Expand Down Expand Up @@ -664,7 +664,7 @@ <h3>Throws</h3>
</dd>
<dt><dfn>on</dfn> (type:string, listener:Function) :void</dt>
<dd>
<p>Adds an event listener on an EventDispatcher object. This is convenience alias for EventDispatcher.addEventListener(type, listener, useCapture=false).</p>
<p>Adds an event listener on an Emitter object. This is convenience alias for Emitter.addListener(type, listener, useCapture=false).</p>
<details>

<h3>Parameters</h3>
Expand Down Expand Up @@ -797,7 +797,7 @@ <h3>Throws</h3>
</dd>
<dt><dfn>willTrigger</dfn> (type:string) :boolean</dt>
<dd>
<p>Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type. The difference between the hasEventListener() and the willTrigger() methods is that hasEventListener() examines only the object to which it belongs, whereas the willTrigger() method examines the entire event flow for the event specified by the type parameter.</p>
<p>Checks whether an event listener is registered with this Emitter object or any of its ancestors for the specified event type. The difference between the hasListener() and the willTrigger() methods is that hasListener() examines only the object to which it belongs, whereas the willTrigger() method examines the entire event flow for the event specified by the type parameter.</p>
<details>

<h3>Parameters</h3>
Expand All @@ -820,9 +820,9 @@ <h3>Throws</h3>

</details>
</dd>
<dt><dfn>hasEventListener</dfn> (type:string) :boolean</dt>
<dt><dfn>hasListener</dfn> (type:string) :boolean</dt>
<dd>
<p>Checks whether the EventDispatcher object has any listeners registered for a specific type of event.</p>
<p>Checks whether the Emitter object has any listeners registered for a specific type of event.</p>
<details>

<h3>Parameters</h3>
Expand Down Expand Up @@ -870,9 +870,9 @@ <h3>Throws</h3>

</details>
</dd>
<dt><dfn>dispatchEvent</dfn> (event:doodle.events.Event) :boolean</dt>
<dt><dfn>emit</dfn> (event:doodle.events.Event) :boolean</dt>
<dd>
<p>Dispatches an event into the event flow. The event target is the EventDispatcher object upon which the dispatchEvent() method is called.</p>
<p>Dispatches an event into the event flow. The event target is the Emitter object upon which the emit() method is called.</p>
<details>

<h3>Parameters</h3>
Expand All @@ -895,7 +895,7 @@ <h3>Throws</h3>

</details>
</dd>
<dt><dfn>broadcastEvent</dfn> (event:doodle.events.Event) :boolean</dt>
<dt><dfn>broadcast</dfn> (event:doodle.events.Event) :boolean</dt>
<dd>
<p>Dispatches an event to every object with an active listener. Ignores propagation path, objects come from</p>
<details>
Expand Down Expand Up @@ -1237,16 +1237,15 @@ <h3>Throws</h3>

</details>
</dd>
<dt><dfn>addEventListener</dfn> (type:string, listener:Function, useCapture:boolean) :void</dt>
<dt><dfn>addListener</dfn> (type:string, listener:Function) :void</dt>
<dd>
<p>Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.</p>
<p>Registers an event listener object with an Emitter object so that the listener receives notification of an event.</p>
<details>

<h3>Parameters</h3>
<ol>
<li>type:string &#8211; </li>
<li>listener:Function &#8211; </li>
<li>useCapture:boolean &#8211; </li>
</ol>


Expand Down Expand Up @@ -1305,16 +1304,15 @@ <h3>Throws</h3>

</details>
</dd>
<dt><dfn>removeEventListener</dfn> (type:string, listener:Function, useCapture:boolean) :void</dt>
<dt><dfn>removeListener</dfn> (type:string, listener:Function) :void</dt>
<dd>
<p>Removes a listener from the EventDispatcher object.</p>
<p>Removes a listener from the Emitter object.</p>
<details>

<h3>Parameters</h3>
<ol>
<li>type:string &#8211; </li>
<li>listener:Function &#8211; </li>
<li>useCapture:boolean &#8211; </li>
</ol>


Expand All @@ -1329,15 +1327,14 @@ <h3>Throws</h3>

</details>
</dd>
<dt><dfn>removeAllListeners</dfn> (type:string, useCapture:=boolean) :void</dt>
<dt><dfn>removeAllListeners</dfn> (type:string) :void</dt>
<dd>
<p>Removes all listeners from the EventDispatcher for the specified event.</p>
<p>Removes all listeners from the Emitter for the specified event.</p>
<details>

<h3>Parameters</h3>
<ol>
<li>type:string &#8211; </li>
<li>useCapture:=boolean &#8211; <span class='param_annotation'>[optional]</span> If undefined, remove all handlers of any type.</li>
</ol>


Expand Down Expand Up @@ -1375,6 +1372,28 @@ <h3>Throws</h3>



</details>
</dd>
<dt><dfn>listeners</dfn> (type:string) :array</dt>
<dd>
<p>Returns an array of listeners for the specified event.</p>
<details>

<h3>Parameters</h3>
<ol>
<li>type:string &#8211; </li>
</ol>

<h3>Returns</h3>
<ul>
<li>array &#8211; </li>
</ul>






</details>
</dd>
<dt><dfn>swapDepthAt</dfn> (index:number) :void</dt>
Expand Down Expand Up @@ -1402,7 +1421,7 @@ <h3>Throws</h3>
</dd>
<dt><dfn>swapDepths</dfn> (node:Node) :void</dt>
<dd>
<p>Swap positions with another node in the parents child list.</p>
<p>Swap positions with a sibling node.</p>
<details>

<h3>Parameters</h3>
Expand Down
57 changes: 38 additions & 19 deletions doc/api/elementnode.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@
<li>ColorFilter</li>
<li>Display</li>
<li>ElementNode</li>
<li>Emitter</li>
<li>Event</li>
<li>EventDispatcher</li>
<li>FontStyle</li>
<li>FontVariant</li>
<li>FontWeight</li>
Expand Down Expand Up @@ -59,7 +59,7 @@ <h2>Description:</h2>
<h3>Inherits</h3>
<ol>
<li>Node</li>
<li>EventDispatcher</li>
<li>Emitter</li>
<li>Object</li>
</ol>

Expand Down Expand Up @@ -481,7 +481,7 @@ <h2>Methods</h2>
<dl>
<dt><dfn>on</dfn> (type:string, listener:Function) :void</dt>
<dd>
<p>Adds an event listener on an EventDispatcher object. This is convenience alias for EventDispatcher.addEventListener(type, listener, useCapture=false).</p>
<p>Adds an event listener on an Emitter object. This is convenience alias for Emitter.addListener(type, listener, useCapture=false).</p>
<details>

<h3>Parameters</h3>
Expand Down Expand Up @@ -572,7 +572,7 @@ <h3>Throws</h3>
</dd>
<dt><dfn>willTrigger</dfn> (type:string) :boolean</dt>
<dd>
<p>Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type. The difference between the hasEventListener() and the willTrigger() methods is that hasEventListener() examines only the object to which it belongs, whereas the willTrigger() method examines the entire event flow for the event specified by the type parameter.</p>
<p>Checks whether an event listener is registered with this Emitter object or any of its ancestors for the specified event type. The difference between the hasListener() and the willTrigger() methods is that hasListener() examines only the object to which it belongs, whereas the willTrigger() method examines the entire event flow for the event specified by the type parameter.</p>
<details>

<h3>Parameters</h3>
Expand All @@ -595,9 +595,9 @@ <h3>Throws</h3>

</details>
</dd>
<dt><dfn>hasEventListener</dfn> (type:string) :boolean</dt>
<dt><dfn>hasListener</dfn> (type:string) :boolean</dt>
<dd>
<p>Checks whether the EventDispatcher object has any listeners registered for a specific type of event.</p>
<p>Checks whether the Emitter object has any listeners registered for a specific type of event.</p>
<details>

<h3>Parameters</h3>
Expand Down Expand Up @@ -645,9 +645,9 @@ <h3>Throws</h3>

</details>
</dd>
<dt><dfn>dispatchEvent</dfn> (event:doodle.events.Event) :boolean</dt>
<dt><dfn>emit</dfn> (event:doodle.events.Event) :boolean</dt>
<dd>
<p>Dispatches an event into the event flow. The event target is the EventDispatcher object upon which the dispatchEvent() method is called.</p>
<p>Dispatches an event into the event flow. The event target is the Emitter object upon which the emit() method is called.</p>
<details>

<h3>Parameters</h3>
Expand All @@ -670,7 +670,7 @@ <h3>Throws</h3>

</details>
</dd>
<dt><dfn>broadcastEvent</dfn> (event:doodle.events.Event) :boolean</dt>
<dt><dfn>broadcast</dfn> (event:doodle.events.Event) :boolean</dt>
<dd>
<p>Dispatches an event to every object with an active listener. Ignores propagation path, objects come from</p>
<details>
Expand Down Expand Up @@ -1064,16 +1064,15 @@ <h3>Throws</h3>

</details>
</dd>
<dt><dfn>addEventListener</dfn> (type:string, listener:Function, useCapture:boolean) :void</dt>
<dt><dfn>addListener</dfn> (type:string, listener:Function) :void</dt>
<dd>
<p>Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.</p>
<p>Registers an event listener object with an Emitter object so that the listener receives notification of an event.</p>
<details>

<h3>Parameters</h3>
<ol>
<li>type:string &#8211; </li>
<li>listener:Function &#8211; </li>
<li>useCapture:boolean &#8211; </li>
</ol>


Expand All @@ -1088,16 +1087,15 @@ <h3>Throws</h3>

</details>
</dd>
<dt><dfn>removeEventListener</dfn> (type:string, listener:Function, useCapture:boolean) :void</dt>
<dt><dfn>removeListener</dfn> (type:string, listener:Function) :void</dt>
<dd>
<p>Removes a listener from the EventDispatcher object.</p>
<p>Removes a listener from the Emitter object.</p>
<details>

<h3>Parameters</h3>
<ol>
<li>type:string &#8211; </li>
<li>listener:Function &#8211; </li>
<li>useCapture:boolean &#8211; </li>
</ol>


Expand All @@ -1112,15 +1110,14 @@ <h3>Throws</h3>

</details>
</dd>
<dt><dfn>removeAllListeners</dfn> (type:string, useCapture:=boolean) :void</dt>
<dt><dfn>removeAllListeners</dfn> (type:string) :void</dt>
<dd>
<p>Removes all listeners from the EventDispatcher for the specified event.</p>
<p>Removes all listeners from the Emitter for the specified event.</p>
<details>

<h3>Parameters</h3>
<ol>
<li>type:string &#8211; </li>
<li>useCapture:=boolean &#8211; <span class='param_annotation'>[optional]</span> If undefined, remove all handlers of any type.</li>
</ol>


Expand All @@ -1133,6 +1130,28 @@ <h3>Throws</h3>



</details>
</dd>
<dt><dfn>listeners</dfn> (type:string) :array</dt>
<dd>
<p>Returns an array of listeners for the specified event.</p>
<details>

<h3>Parameters</h3>
<ol>
<li>type:string &#8211; </li>
</ol>

<h3>Returns</h3>
<ul>
<li>array &#8211; </li>
</ul>






</details>
</dd>
<dt><dfn>toString</dfn> () :string</dt>
Expand Down Expand Up @@ -1179,7 +1198,7 @@ <h3>Throws</h3>
</dd>
<dt><dfn>swapDepths</dfn> (node:Node) :void</dt>
<dd>
<p>Swap positions with another node in the parents child list.</p>
<p>Swap positions with a sibling node.</p>
<details>

<h3>Parameters</h3>
Expand Down
Loading

0 comments on commit d669d46

Please sign in to comment.