From 04f882eb0dcb786495d709dd1ae6f9fae35928e3 Mon Sep 17 00:00:00 2001
From: Xinchen Hui <laruence@php.net>
Date: Tue, 19 Feb 2013 10:53:22 +0000
Subject: [PATCH] Update forward entry

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@329501 c90b9560-bf6c-de11-be94-00142212c4b1
---
 .../yaf/yaf_controller_abstract/forward.xml   | 32 +++++++++++++++----
 1 file changed, 25 insertions(+), 7 deletions(-)

diff --git a/reference/yaf/yaf_controller_abstract/forward.xml b/reference/yaf/yaf_controller_abstract/forward.xml
index f21c170d19..885c658669 100644
--- a/reference/yaf/yaf_controller_abstract/forward.xml
+++ b/reference/yaf/yaf_controller_abstract/forward.xml
@@ -4,11 +4,22 @@
 <refentry xml:id="yaf-controller-abstract.forward" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
  <refnamediv>
   <refname>Yaf_Controller_Abstract::forward</refname>
-  <refpurpose>The forward purpose</refpurpose>
+  <refpurpose>foward to another action</refpurpose>
  </refnamediv>
 
  <refsect1 role="description">
   &reftitle.description;
+  <methodsynopsis>
+   <modifier>public</modifier> <type>void</type><methodname>Yaf_Controller_Abstract::forward</methodname>
+   <methodparam><type>string</type><parameter>action</parameter></methodparam>
+   <methodparam choice="opt"><type>array</type><parameter>paramters</parameter></methodparam>
+  </methodsynopsis>
+  <methodsynopsis>
+   <modifier>public</modifier> <type>void</type><methodname>Yaf_Controller_Abstract::forward</methodname>
+   <methodparam><type>string</type><parameter>controller</parameter></methodparam>
+   <methodparam choice="opt"><type>string</type><parameter>action</parameter></methodparam>
+   <methodparam choice="opt"><type>array</type><parameter>paramters</parameter></methodparam>
+  </methodsynopsis>
   <methodsynopsis>
    <modifier>public</modifier> <type>void</type><methodname>Yaf_Controller_Abstract::forward</methodname>
    <methodparam><type>string</type><parameter>module</parameter></methodparam>
@@ -17,7 +28,13 @@
    <methodparam choice="opt"><type>array</type><parameter>paramters</parameter></methodparam>
   </methodsynopsis>
   <para>
-
+   forward current execution process to other action.
+   <note>
+    <para>
+      it doesn't switch to other action immediately, the forwarding will
+      only occurr after current execution flow over.
+    </para>
+   </note>
   </para>
  </refsect1>
 
@@ -28,7 +45,8 @@
     <term><parameter>module</parameter></term>
     <listitem>
      <para>
-      
+       destination module name, if NULL was given, then default module name
+       is assumed
      </para>
     </listitem>
    </varlistentry>
@@ -36,7 +54,7 @@
     <term><parameter>controller</parameter></term>
     <listitem>
      <para>
-      
+       destination controller name
      </para>
     </listitem>
    </varlistentry>
@@ -44,7 +62,7 @@
     <term><parameter>action</parameter></term>
     <listitem>
      <para>
-      
+       destination action name
      </para>
     </listitem>
    </varlistentry>
@@ -52,7 +70,7 @@
     <term><parameter>paramters</parameter></term>
     <listitem>
      <para>
-      
+      calling arguments
      </para>
     </listitem>
    </varlistentry>
@@ -62,7 +80,7 @@
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
-
+    return FALSE on failure
   </para>
  </refsect1>