coliver 2003/05/24 17:57:53
Modified: src/documentation/xdocs/userdocs/flow api.xml
Log:
documented getContinuation
Revision Changes Path
1.5 +15 -1 cocoon-2.1/src/documentation/xdocs/userdocs/flow/api.xml
Index: api.xml
===================================================================
RCS file: /home/cvs/cocoon-2.1/src/documentation/xdocs/userdocs/flow/api.xml,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- api.xml 25 May 2003 00:48:47 -0000 1.4
+++ api.xml 25 May 2003 00:57:53 -0000 1.5
@@ -135,6 +135,20 @@
<p>
<code>WebContinuation</code> objects support the following functions
and properties:
</p>
+ <s4 title="getContinuation">
+ <p>
+ <em>Function</em> <code>[WebContinuation] getContinuation([Number]
level)</code>
+ </p>
+ <p>
+ Return the ancestor continuation situated <code>level</code>s
+ above the current continuation. The current instance is
+ considered to be at level 0. The parent continuation of the
+ receiving instance at level 1, its parent is at level 2 relative
+ to the receiving instance. If <code>level</code> is bigger than
+ the depth of the tree, the root of the tree is returned.
+
+ </p>
+ </s4>
<s4 title="invalidate">
<p>
<em>Function</em> <code>invalidate()</code>
@@ -152,7 +166,7 @@
<em>Property</em> <code>[String] id</code>
</p>
<p>
- Returns this object's unique identifier as a String
+ Returns this unique string identifier of this continuation
</p>
</s4>
</s2>
