svn: /phpdoc/en/trunk/reference/yaf/yaf_action_abstract/ execute.xml getcontroller.xml
| From: | Xinchen Hui | Date: | Wed, 20 Feb 2013 05:44:57 +0000 |
| Subject: | svn: /phpdoc/en/trunk/reference/yaf/yaf_action_abstract/ execute.xml getcontroller.xml | ||
| Groups: | php.doc.cvs | ||
| Request: | Send a blank email to doc-cvs+get-11020@lists.php.net to get a copy of this message | ||
laruence Wed, 20 Feb 2013 05:44:57 +0000
Revision: http://svn.php.net/viewvc?view=revision&revision=329516
Log:
update action methods doc
Changed paths:
U phpdoc/en/trunk/reference/yaf/yaf_action_abstract/execute.xml
U phpdoc/en/trunk/reference/yaf/yaf_action_abstract/getcontroller.xml
Modified: phpdoc/en/trunk/reference/yaf/yaf_action_abstract/execute.xml
===================================================================
--- phpdoc/en/trunk/reference/yaf/yaf_action_abstract/execute.xml 2013-02-20 05:40:17 UTC (rev
329515)
+++ phpdoc/en/trunk/reference/yaf/yaf_action_abstract/execute.xml 2013-02-20 05:44:57 UTC (rev
329516)
@@ -4,7 +4,7 @@
<refentry xml:id="yaf-action-abstract.execute" xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Yaf_Action_Abstract::execute</refname>
- <refpurpose>Execute the action</refpurpose>
+ <refpurpose>Action entry point</refpurpose>
</refnamediv>
<refsect1 role="description">
@@ -16,6 +16,8 @@
choice="opt"><type>mixed</type><parameter>...</parameter></methodparam>
</methodsynopsis>
<para>
+ user should always define this method for a action, this is the entry point
+ of an action.
<methodname>Yaf_Action_Abstract::execute</methodname> may have agruments.
<note>
<para>
@@ -24,9 +26,6 @@
</para>
</note>
</para>
-
- &warn.undocumented.func;
-
</refsect1>
<refsect1 role="parameters">
Modified: phpdoc/en/trunk/reference/yaf/yaf_action_abstract/getcontroller.xml
===================================================================
--- phpdoc/en/trunk/reference/yaf/yaf_action_abstract/getcontroller.xml 2013-02-20 05:40:17 UTC (rev
329515)
+++ phpdoc/en/trunk/reference/yaf/yaf_action_abstract/getcontroller.xml 2013-02-20 05:44:57 UTC (rev
329516)
@@ -4,7 +4,7 @@
<refentry xml:id="yaf-action-abstract.getcontroller" xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Yaf_Action_Abstract::getController</refname>
- <refpurpose>get controller instance</refpurpose>
+ <refpurpose>Retrieve controller object</refpurpose>
</refnamediv>
<refsect1 role="description">
@@ -14,11 +14,8 @@
<void />
</methodsynopsis>
<para>
- Retrive the controller object.
+ retrieve current controller object.
</para>
-
- &warn.undocumented.func;
-
</refsect1>
<refsect1 role="parameters">
@@ -29,7 +26,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
-
+ <classname>Yaf_Controller_Abstract</classname> instance
</para>
</refsect1>