From 7748fb78cbf95fb45e641985e09dd6e250411993 Mon Sep 17 00:00:00 2001
From: Xinchen Hui <laruence@php.net>
Date: Thu, 1 Sep 2011 04:07:41 +0000
Subject: [PATCH] Update Yaf_Application relevant docs

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@315950 c90b9560-bf6c-de11-be94-00142212c4b1
---
 reference/yaf/yaf-application.xml                   | 1 +
 reference/yaf/yaf_action_abstract/execute.xml       | 8 +++++---
 reference/yaf/yaf_action_abstract/getcontroller.xml | 4 ++--
 reference/yaf/yaf_application/bootstrap.xml         | 9 +++++----
 4 files changed, 13 insertions(+), 9 deletions(-)

diff --git a/reference/yaf/yaf-application.xml b/reference/yaf/yaf-application.xml
index 09ceeabf4b..aa09e2e96a 100644
--- a/reference/yaf/yaf-application.xml
+++ b/reference/yaf/yaf-application.xml
@@ -44,6 +44,7 @@
      <varname linkend="yaf-application.props.dispatcher">dispatcher</varname>
     </fieldsynopsis>
     <fieldsynopsis>
+     <modifier>protected</modifier>
      <modifier>static</modifier>
      <varname linkend="yaf-application.props.app">_app</varname>
     </fieldsynopsis>
diff --git a/reference/yaf/yaf_action_abstract/execute.xml b/reference/yaf/yaf_action_abstract/execute.xml
index 188746586b..071d280ccc 100644
--- a/reference/yaf/yaf_action_abstract/execute.xml
+++ b/reference/yaf/yaf_action_abstract/execute.xml
@@ -4,14 +4,16 @@
 <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>The execute purpose</refpurpose>
+  <refpurpose>entry point method</refpurpose>
  </refnamediv>
 
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
-   <modifier>abstract</modifier> <modifier>public</modifier> <type>void</type><methodname>Yaf_Action_Abstract::execute</methodname>
-   <void />
+   <modifier>abstract</modifier> <modifier>public</modifier><type>mixed</type><methodname>Yaf_Action_Abstract::execute</methodname>
+   <methodparam><type>mixed</type><parameter>arg</parameter></methodparam>
+   <methodparam
+    choice="opt"><type>mixed</type><parameter>...</parameter></methodparam>
   </methodsynopsis>
   <para>
 
diff --git a/reference/yaf/yaf_action_abstract/getcontroller.xml b/reference/yaf/yaf_action_abstract/getcontroller.xml
index 3edb5eae15..742eab06f7 100644
--- a/reference/yaf/yaf_action_abstract/getcontroller.xml
+++ b/reference/yaf/yaf_action_abstract/getcontroller.xml
@@ -4,13 +4,13 @@
 <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>The getController purpose</refpurpose>
+  <refpurpose>get controller instance</refpurpose>
  </refnamediv>
 
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
-   <modifier>public</modifier> <type>void</type><methodname>Yaf_Action_Abstract::getController</methodname>
+   <modifier>public</modifier><type linkend="class.yaf-controller-abstract">Yaf_Controller_Abstract</type><methodname>Yaf_Action_Abstract::getController</methodname>
    <void />
   </methodsynopsis>
   <para>
diff --git a/reference/yaf/yaf_application/bootstrap.xml b/reference/yaf/yaf_application/bootstrap.xml
index 5955ee25ab..a09c274b45 100644
--- a/reference/yaf/yaf_application/bootstrap.xml
+++ b/reference/yaf/yaf_application/bootstrap.xml
@@ -11,10 +11,11 @@
   &reftitle.description;
   <methodsynopsis>
    <modifier>public</modifier> <type>void</type><methodname>Yaf_Application::bootstrap</methodname>
-   <methodparam choice="opt"><type>string</type><parameter>bootstrap</parameter></methodparam>
+   <methodparam choice="opt"><type>Yaf_Bootstrap_Abstract</type><parameter>bootstrap</parameter></methodparam>
   </methodsynopsis>
   <para>
-   
+    Run a Bootstrap, if the parameter bootstrap is not supplied, Yaf will look
+    for a Bootstrap under application.directory.
   </para>
 
   &warn.undocumented.func;
@@ -28,7 +29,7 @@
     <term><parameter>bootstrap</parameter></term>
     <listitem>
      <para>
-         
+      A <classname>Yaf_Bootstrap_Abstract</classname> instance      
      </para>
     </listitem>
    </varlistentry>
@@ -38,7 +39,7 @@
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
-    Yaf_Application instance
+   <classname>Yaf_Application</classname> instance
   </para>
  </refsect1>