From: Ryan Dahl <ry@tinyclouds.org>
Date: Tue, 15 Sep 2009 13:25:06 +0000 (+0200)
Subject: Add documentation for promise.emitSuccess and emitError
X-Git-Tag: v0.1.11~9
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=fdc136df690d11a9b5b65ac58e9c1f420b24c274;p=platform%2Fupstream%2Fnodejs.git

Add documentation for promise.emitSuccess and emitError
---

diff --git a/doc/api.html b/doc/api.html
index dcae34f..6e078bf 100644
--- a/doc/api.html
+++ b/doc/api.html
@@ -280,6 +280,25 @@ Adds a listener for the <tt>"error"</tt> event. Returns the same promise object.
 </p>
 </dd>
 <dt class="hdlist1">
+<tt>promise.emitSuccess(arg1, arg2, &#8230;)</tt> 
+</dt>
+<dd>
+<p>
+If you created the promise (by doing <tt>new node.Promise()</tt>) then call
+<tt>emitSuccess</tt> to emit the <tt>"success"</tt> event with the given arguments.
+</p>
+<div class="paragraph"><p>(<tt>promise.emit("success", arg1, arg2, &#8230;)</tt> should also work, but doesn&#8217;t at
+the moment due to a bug; use <tt>emitSuccess</tt> instead.)</p></div>
+</dd>
+<dt class="hdlist1">
+<tt>promise.emitError(arg1, arg2, &#8230;)</tt> 
+</dt>
+<dd>
+<p>
+Emits the <tt>"error"</tt> event.
+</p>
+</dd>
+<dt class="hdlist1">
 <tt>promise.wait()</tt> 
 </dt>
 <dd>
@@ -1861,7 +1880,7 @@ init (Handle&lt;Object&gt; target)
 <div id="footer">
 <div id="footer-text">
 Version 0.1.10<br />
-Last updated 2009-09-13 18:25:27 CEST
+Last updated 2009-09-15 15:23:59 CEST
 </div>
 </div>
 </body>
diff --git a/doc/api.txt b/doc/api.txt
index 9928e25..9256725 100644
--- a/doc/api.txt
+++ b/doc/api.txt
@@ -165,6 +165,16 @@ Adds a listener for the +"success"+ event. Returns the same promise object.
 +promise.addErrback(listener)+ ::
 Adds a listener for the +"error"+ event. Returns the same promise object.
 
++promise.emitSuccess(arg1, arg2, ...)+ ::
+If you created the promise (by doing +new node.Promise()+) then call
++emitSuccess+ to emit the +"success"+ event with the given arguments. 
++
+(+promise.emit("success", arg1, arg2, ...)+ should also work, but doesn't at
+the moment due to a bug; use +emitSuccess+ instead.)
+
++promise.emitError(arg1, arg2, ...)+ ::
+Emits the +"error"+ event.
+
 +promise.wait()+ ::
 Blocks futher execution until the promise emits a success or error event.
 Events setup before the call to +promise.wait()+ was made may still be
diff --git a/doc/node.1 b/doc/node.1
index 9ae853d..fa7b81d 100644
--- a/doc/node.1
+++ b/doc/node.1
@@ -1,11 +1,11 @@
 .\"     Title: node
 .\"    Author: 
 .\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/>
-.\"      Date: 09/13/2009
+.\"      Date: 09/15/2009
 .\"    Manual: 
 .\"    Source: 
 .\"
-.TH "NODE" "1" "09/13/2009" "" ""
+.TH "NODE" "1" "09/15/2009" "" ""
 .\" disable hyphenation
 .nh
 .\" disable justification (adjust text to left margin only)
@@ -236,6 +236,28 @@ Adds a listener for the
 event\. Returns the same promise object\.
 .RE
 .PP
+promise\.emitSuccess(arg1, arg2, \&...)
+.RS 4
+If you created the promise (by doing
+new node\.Promise()) then call
+emitSuccess
+to emit the
+"success"
+event with the given arguments\.
+.sp
+(promise\.emit("success", arg1, arg2, \&...)
+should also work, but doesn\(cqt at the moment due to a bug; use
+emitSuccess
+instead\.)
+.RE
+.PP
+promise\.emitError(arg1, arg2, \&...)
+.RS 4
+Emits the
+"error"
+event\.
+.RE
+.PP
 promise\.wait()
 .RS 4
 Blocks futher execution until the promise emits a success or error event\. Events setup before the call to