From 939657ed2968400018ca4d0a34b63d40a34045f8 Mon Sep 17 00:00:00 2001
From: Xinchen Hui <laruence@php.net>
Date: Wed, 20 Feb 2013 05:44:57 +0000
Subject: [PATCH] update action methods doc

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@329516 c90b9560-bf6c-de11-be94-00142212c4b1
---
 reference/yaf/yaf_action_abstract/execute.xml       | 7 +++----
 reference/yaf/yaf_action_abstract/getcontroller.xml | 9 +++------
 2 files changed, 6 insertions(+), 10 deletions(-)

diff --git a/reference/yaf/yaf_action_abstract/execute.xml b/reference/yaf/yaf_action_abstract/execute.xml
index a5ded140a9..ce47a75279 100644
--- a/reference/yaf/yaf_action_abstract/execute.xml
+++ b/reference/yaf/yaf_action_abstract/execute.xml
@@ -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">
diff --git a/reference/yaf/yaf_action_abstract/getcontroller.xml b/reference/yaf/yaf_action_abstract/getcontroller.xml
index f196942c95..feb6d48ba3 100644
--- a/reference/yaf/yaf_action_abstract/getcontroller.xml
+++ b/reference/yaf/yaf_action_abstract/getcontroller.xml
@@ -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>