Permalink
Browse files

update doc

  • Loading branch information...
1 parent 4051d99 commit 0ef1c5c33eed7e79799a5cf45ea761f5545cc242 @JacksonTian committed Nov 3, 2014
Showing with 930 additions and 524 deletions.
  1. +32 −46 api.html
  2. +898 −478 eventproxy.html
View
@@ -64,10 +64,6 @@
<ul class="indexs">
<li>
- <a href="#eventproxy__SLICE">SLICE</a>
- </li>
-
- <li>
<a href="#eventproxy__EventProxy">EventProxy</a>
</li>
@@ -203,27 +199,6 @@
</table>
- <h3 data-id="eventproxy__SLICE">
- SLICE
- </h3>
-
-
- <p>refs</p>
-
- <table class="table table-striped table-bordered table-hover table-condensed">
-
- <tr>
- <td>声明</td>
- <td>SLICE</td>
- <td></td>
- <td>SLICE</td>
- </tr>
-
-
-
- </table>
-
-
<h3 data-id="eventproxy__EventProxy">
EventProxy
</h3>
@@ -256,7 +231,12 @@ <h3 data-id="eventproxy__addListener">
</h3>
- <p>Bind an event, specified by a string name, <code>ev</code>, to a <code>callback</code> function.<br />Passing <strong>ALL_EVENT</strong> will bind the callback to all events fired.</p>
+ <p>Bind an event, specified by a string name, <code>ev</code>, to a <code>callback</code> function.<br />Passing <strong>ALL_EVENT</strong> will bind the callback to all events fired.<br />Examples:</p><pre><code class="lang-js">var proxy = new EventProxy();
+proxy.addListener(&quot;template&quot;, function (event) {
+ // TODO
+});
+</code></pre>
+
<table class="table table-striped table-bordered table-hover table-condensed">
@@ -270,7 +250,7 @@ <h3 data-id="eventproxy__addListener">
<tr>
<td>参数</td>
- <td>eventName(String)</td>
+ <td>eventname(String)</td>
<td colspan="2">Event name.</td>
</tr>
@@ -368,7 +348,7 @@ <h3 data-id="eventproxy__headbind">
<tr>
<td>参数</td>
- <td>eventName(String)</td>
+ <td>eventname(String)</td>
<td colspan="2">Event name.</td>
</tr>
@@ -391,7 +371,7 @@ <h3 data-id="eventproxy__removeListener">
<p>Remove one or many callbacks.</p><ul>
<li>If <code>callback</code> is null, removes all callbacks for the event.</li>
-<li>If <code>eventName</code> is null, removes all bound callbacks for all events.</li>
+<li>If <code>eventname</code> is null, removes all bound callbacks for all events.</li>
</ul>
@@ -407,7 +387,7 @@ <h3 data-id="eventproxy__removeListener">
<tr>
<td>参数</td>
- <td>eventName(String)</td>
+ <td>eventname(String)</td>
<td colspan="2">Event name.</td>
</tr>
@@ -533,7 +513,7 @@ <h3 data-id="eventproxy__trigger">
<tr>
<td>参数</td>
- <td>eventName(String)</td>
+ <td>eventname(String)</td>
<td colspan="2">Event name</td>
</tr>
@@ -715,7 +695,7 @@ <h3 data-id="eventproxy__all">
</h3>
- <p>Assign some events, after all events were fired, the callback will be executed once.<br />Examples:</p><pre><code class="lang-js">proxy.all(ev1, ev2, callback);
+ <p>Assign some events, after all events were fired, the callback will be executed once.</p><p>Examples:</p><pre><code class="lang-js">proxy.all(ev1, ev2, callback);
proxy.all([ev1, ev2], callback);
proxy.all(ev1, [ev2, ev3], callback);
</code></pre>
@@ -733,14 +713,14 @@ <h3 data-id="eventproxy__all">
<tr>
<td>参数</td>
- <td>eventName1(String)</td>
+ <td>eventname1(String)</td>
<td colspan="2">First event name.</td>
</tr>
<tr>
<td>参数</td>
- <td>eventName2(String)</td>
+ <td>eventname2(String)</td>
<td colspan="2">Second event name.</td>
</tr>
@@ -828,14 +808,14 @@ <h3 data-id="eventproxy__tail">
<tr>
<td>参数</td>
- <td>eventName1(String)</td>
+ <td>eventname1(String)</td>
<td colspan="2">First event name.</td>
</tr>
<tr>
<td>参数</td>
- <td>eventName2(String)</td>
+ <td>eventname2(String)</td>
<td colspan="2">Second event name.</td>
</tr>
@@ -912,7 +892,7 @@ <h3 data-id="eventproxy__after">
<tr>
<td>参数</td>
- <td>eventName(String)</td>
+ <td>eventname(String)</td>
<td colspan="2">Event name.</td>
</tr>
@@ -962,7 +942,7 @@ <h3 data-id="eventproxy__group">
<tr>
<td>参数</td>
- <td>eventName(String)</td>
+ <td>eventname(String)</td>
<td colspan="2">Event name, shoule keep consistent with `after`.</td>
</tr>
@@ -997,22 +977,22 @@ <h3 data-id="eventproxy__any">
<tr>
<td>参数</td>
- <td>eventName1(String)</td>
+ <td>eventname1(String)</td>
<td colspan="2">Event name.</td>
</tr>
<tr>
<td>参数</td>
- <td>eventName2(String)</td>
+ <td>eventname2(String)</td>
<td colspan="2">Event name.</td>
</tr>
<tr>
<td>参数</td>
<td>callback(Function)</td>
- <td colspan="2">The callback will get a map that has data and eventName attributes.</td>
+ <td colspan="2">The callback will get a map that has data and eventname attributes.</td>
</tr>
@@ -1039,7 +1019,7 @@ <h3 data-id="eventproxy__not">
<tr>
<td>参数</td>
- <td>eventName(String)</td>
+ <td>eventname(String)</td>
<td colspan="2">Event name.</td>
</tr>
@@ -1131,6 +1111,13 @@ <h3 data-id="eventproxy__doneLater">
</tr>
+ <tr>
+ <td>返回</td>
+ <td>Function</td>
+ <td colspan="2">delay done</td>
+ </tr>
+
+
</table>
@@ -1162,10 +1149,9 @@ <h3 data-id="eventproxy_EventProxy_create">
<tr>
- <td>undefined</td>
- <td>undefined</td>
- <td>undefined</td>
- <td>undefined</td>
+ <td>返回</td>
+ <td>EventProxy</td>
+ <td colspan="2">EventProxy instance</td>
</tr>
Oops, something went wrong.

0 comments on commit 0ef1c5c

Please sign in to comment.