You are viewing a plain text version of this content. The canonical link for it is here.
Posted to cvs@cocoon.apache.org by co...@apache.org on 2003/12/10 06:29:51 UTC
cvs commit: cocoon-2.1/src/documentation/xdocs/userdocs/flow api.xml
coliver 2003/12/09 21:29:51
Modified: src/documentation/xdocs/userdocs/flow api.xml
Log:
Documented getComponent, releaseComponent, createObject, and disposeObject
Revision Changes Path
1.29 +24 -0 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.28
retrieving revision 1.29
diff -u -r1.28 -r1.29
--- api.xml 14 Nov 2003 23:20:15 -0000 1.28
+++ api.xml 10 Dec 2003 05:29:51 -0000 1.29
@@ -143,6 +143,30 @@
source resolver is used to resolve <code>uri</code>.
</p>
</s3>
+ <s3 title="getComponent">
+ <p><em>Function</em> <code>Object getComponent([String] id)</code></p>
+ <p>
+ Access an Avalon component.
+ </p>
+ </s3>
+ <s3 title="releaseComponent">
+ <p><em>Function</em> <code>releaseComponent([Object] component)</code></p>
+ <p>
+ Release a pooled Avalon component.
+ </p>
+ </s3>
+ <s3 title="createObject">
+ <p><em>Function</em> <code>createObject([JavaClass] componentClass)</code></p>
+ <p>
+ Create and setup an object so that it can access the information provided to regular components. This is done by calling the various Avalon lifecycle interfaces implemented by the object.
+ </p>
+ </s3>
+ <s3 title="disposeObject">
+ <p><em>Function</em> <code>disposeObject([Object] object)</code></p>
+ <p>
+ Dispose an object that has been created using <code>createObject</code>.
+ </p>
+ </s3>
</s2>
<s2 title="Request Object"><anchor id="request"/>