From 83a6761c731fbda6003d4bed7608a4dbb7aa9f4e Mon Sep 17 00:00:00 2001
From: Xinchen Hui <laruence@php.net>
Date: Sat, 26 Nov 2011 12:08:23 +0000
Subject: [PATCH] update docs

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@319951 c90b9560-bf6c-de11-be94-00142212c4b1
---
 reference/yaf/yaf_view_interface/assign.xml        | 6 +++---
 reference/yaf/yaf_view_interface/display.xml       | 8 ++++----
 reference/yaf/yaf_view_interface/render.xml        | 8 ++++----
 reference/yaf/yaf_view_interface/setscriptpath.xml | 7 +++++--
 4 files changed, 16 insertions(+), 13 deletions(-)

diff --git a/reference/yaf/yaf_view_interface/assign.xml b/reference/yaf/yaf_view_interface/assign.xml
index c65165fe09..99f88bf883 100644
--- a/reference/yaf/yaf_view_interface/assign.xml
+++ b/reference/yaf/yaf_view_interface/assign.xml
@@ -4,18 +4,18 @@
 <refentry xml:id="yaf-view-interface.assign" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
  <refnamediv>
   <refname>Yaf_View_Interface::assign</refname>
-  <refpurpose>The assign purpose</refpurpose>
+  <refpurpose>Assign value to View engine</refpurpose>
  </refnamediv>
 
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
-   <modifier>abstract</modifier> <modifier>public</modifier> <type>void</type><methodname>Yaf_View_Interface::assign</methodname>
+   <modifier>abstract</modifier> <modifier>public</modifier> <type>bool</type><methodname>Yaf_View_Interface::assign</methodname>
    <methodparam><type>string</type><parameter>name</parameter></methodparam>
    <methodparam choice="opt"><type>string</type><parameter>value</parameter></methodparam>
   </methodsynopsis>
   <para>
-
+     Assigan values to View engine, then the value can access directly by name in template.
   </para>
 
   &warn.undocumented.func;
diff --git a/reference/yaf/yaf_view_interface/display.xml b/reference/yaf/yaf_view_interface/display.xml
index 8ef58abb90..2f482ef7e8 100644
--- a/reference/yaf/yaf_view_interface/display.xml
+++ b/reference/yaf/yaf_view_interface/display.xml
@@ -4,18 +4,18 @@
 <refentry xml:id="yaf-view-interface.display" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
  <refnamediv>
   <refname>Yaf_View_Interface::display</refname>
-  <refpurpose>The display purpose</refpurpose>
+  <refpurpose>Render and output a template</refpurpose>
  </refnamediv>
 
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
-   <modifier>abstract</modifier> <modifier>public</modifier> <type>void</type><methodname>Yaf_View_Interface::display</methodname>
+   <modifier>abstract</modifier> <modifier>public</modifier> <type>bool</type><methodname>Yaf_View_Interface::display</methodname>
    <methodparam><type>string</type><parameter>tpl</parameter></methodparam>
-   <methodparam choice="opt"><type>string</type><parameter>tpl_vars</parameter></methodparam>
+   <methodparam choice="opt"><type>array</type><parameter>tpl_vars</parameter></methodparam>
   </methodsynopsis>
   <para>
-
+    Render a template and output the result immediatly.
   </para>
 
   &warn.undocumented.func;
diff --git a/reference/yaf/yaf_view_interface/render.xml b/reference/yaf/yaf_view_interface/render.xml
index c3ba86e88c..9564ace877 100644
--- a/reference/yaf/yaf_view_interface/render.xml
+++ b/reference/yaf/yaf_view_interface/render.xml
@@ -4,18 +4,18 @@
 <refentry xml:id="yaf-view-interface.render" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
  <refnamediv>
   <refname>Yaf_View_Interface::render</refname>
-  <refpurpose>The render purpose</refpurpose>
+  <refpurpose>Render a template</refpurpose>
  </refnamediv>
 
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
-   <modifier>abstract</modifier> <modifier>public</modifier> <type>void</type><methodname>Yaf_View_Interface::render</methodname>
+   <modifier>abstract</modifier> <modifier>public</modifier> <type>string</type><methodname>Yaf_View_Interface::render</methodname>
    <methodparam><type>string</type><parameter>tpl</parameter></methodparam>
-   <methodparam choice="opt"><type>string</type><parameter>tpl_vars</parameter></methodparam>
+   <methodparam choice="opt"><type>array</type><parameter>tpl_vars</parameter></methodparam>
   </methodsynopsis>
   <para>
-
+    Render a template and return the result.
   </para>
 
   &warn.undocumented.func;
diff --git a/reference/yaf/yaf_view_interface/setscriptpath.xml b/reference/yaf/yaf_view_interface/setscriptpath.xml
index dd5a57ad14..1691b6f8ee 100644
--- a/reference/yaf/yaf_view_interface/setscriptpath.xml
+++ b/reference/yaf/yaf_view_interface/setscriptpath.xml
@@ -14,7 +14,8 @@
    <methodparam><type>string</type><parameter>template_dir</parameter></methodparam>
   </methodsynopsis>
   <para>
-
+    Set the templates base directory, this is usually called by
+    <classname>Yaf_Dispatcher</classname>
   </para>
 
   &warn.undocumented.func;
@@ -28,7 +29,9 @@
     <term><parameter>template_dir</parameter></term>
     <listitem>
      <para>
-      
+      A absolute path to the template directory, by default,
+      <classname>Yaf_Dispatcher</classname> use
+      APPLICATION_PATH . "/views" as this paramter.
      </para>
     </listitem>
    </varlistentry>