updates docs

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@327672 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Xinchen Hui 2012-09-17 09:02:21 +00:00
parent ff8bbeed9c
commit 94f2f851f0
23 changed files with 20 additions and 85 deletions

View file

@ -16,9 +16,6 @@
<para>
</para>
&warn.undocumented.func;
</refsect1>
<refsect1 role="parameters">

View file

@ -16,9 +16,6 @@
<para>
</para>
&warn.undocumented.func;
</refsect1>
<refsect1 role="parameters">

View file

@ -10,16 +10,13 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>final</modifier> <modifier>protected</modifier> <type>bool</type><methodname>Yaf_Controller_Abstract::display</methodname>
<modifier>protected</modifier> <type>bool</type><methodname>Yaf_Controller_Abstract::display</methodname>
<methodparam><type>string</type><parameter>tpl</parameter></methodparam>
<methodparam choice="opt"><type>array</type><parameter>parameters</parameter></methodparam>
</methodsynopsis>
<para>
</para>
&warn.undocumented.func;
</refsect1>
<refsect1 role="parameters">

View file

@ -10,7 +10,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>final</modifier> <modifier>public</modifier> <type>void</type><methodname>Yaf_Controller_Abstract::forward</methodname>
<modifier>public</modifier> <type>void</type><methodname>Yaf_Controller_Abstract::forward</methodname>
<methodparam><type>string</type><parameter>module</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>controller</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>action</parameter></methodparam>
@ -19,9 +19,6 @@
<para>
</para>
&warn.undocumented.func;
</refsect1>
<refsect1 role="parameters">

View file

@ -10,15 +10,12 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>final</modifier> <modifier>public</modifier> <type>void</type><methodname>Yaf_Controller_Abstract::getInvokeArg</methodname>
<modifier>public</modifier> <type>void</type><methodname>Yaf_Controller_Abstract::getInvokeArg</methodname>
<methodparam><type>string</type><parameter>name</parameter></methodparam>
</methodsynopsis>
<para>
</para>
&warn.undocumented.func;
</refsect1>
<refsect1 role="parameters">

View file

@ -10,15 +10,12 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>final</modifier> <modifier>public</modifier> <type>void</type><methodname>Yaf_Controller_Abstract::getInvokeArgs</methodname>
<modifier>public</modifier> <type>void</type><methodname>Yaf_Controller_Abstract::getInvokeArgs</methodname>
<void />
</methodsynopsis>
<para>
</para>
&warn.undocumented.func;
</refsect1>
<refsect1 role="parameters">

View file

@ -10,15 +10,12 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>final</modifier> <modifier>public</modifier> <type>string</type><methodname>Yaf_Controller_Abstract::getModuleName</methodname>
<modifier>public</modifier> <type>string</type><methodname>Yaf_Controller_Abstract::getModuleName</methodname>
<void />
</methodsynopsis>
<para>
get the controller's module name
</para>
&warn.undocumented.func;
</refsect1>
<refsect1 role="parameters">

View file

@ -10,15 +10,12 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>final</modifier> <modifier>public</modifier> <type>Yaf_Request_Abstract</type><methodname>Yaf_Controller_Abstract::getRequest</methodname>
<modifier>public</modifier> <type>Yaf_Request_Abstract</type><methodname>Yaf_Controller_Abstract::getRequest</methodname>
<void />
</methodsynopsis>
<para>
</para>
&warn.undocumented.func;
</refsect1>
<refsect1 role="parameters">

View file

@ -10,15 +10,12 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>final</modifier> <modifier>public</modifier> <type>Yaf_Response_Abstract</type><methodname>Yaf_Controller_Abstract::getResponse</methodname>
<modifier>public</modifier> <type>Yaf_Response_Abstract</type><methodname>Yaf_Controller_Abstract::getResponse</methodname>
<void />
</methodsynopsis>
<para>
</para>
&warn.undocumented.func;
</refsect1>
<refsect1 role="parameters">

View file

@ -10,7 +10,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>final</modifier> <modifier>public</modifier> <type>Yaf_View_Interface</type><methodname>Yaf_Controller_Abstract::getView</methodname>
<modifier>public</modifier> <type>Yaf_View_Interface</type><methodname>Yaf_Controller_Abstract::getView</methodname>
<void />
</methodsynopsis>
<para>

View file

@ -10,15 +10,12 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>final</modifier> <modifier>public</modifier> <type>void</type><methodname>Yaf_Controller_Abstract::getViewpath</methodname>
<modifier>public</modifier> <type>void</type><methodname>Yaf_Controller_Abstract::getViewpath</methodname>
<void />
</methodsynopsis>
<para>
</para>
&warn.undocumented.func;
</refsect1>
<refsect1 role="parameters">

View file

@ -10,15 +10,12 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>final</modifier> <modifier>public</modifier> <type>void</type><methodname>Yaf_Controller_Abstract::initView</methodname>
<modifier>public</modifier> <type>void</type><methodname>Yaf_Controller_Abstract::initView</methodname>
<methodparam choice="opt"><type>array</type><parameter>options</parameter></methodparam>
</methodsynopsis>
<para>
</para>
&warn.undocumented.func;
</refsect1>
<refsect1 role="parameters">

View file

@ -10,15 +10,12 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>final</modifier> <modifier>public</modifier> <type>void</type><methodname>Yaf_Controller_Abstract::redirect</methodname>
<modifier>public</modifier> <type>void</type><methodname>Yaf_Controller_Abstract::redirect</methodname>
<methodparam><type>string</type><parameter>url</parameter></methodparam>
</methodsynopsis>
<para>
</para>
&warn.undocumented.func;
</refsect1>
<refsect1 role="parameters">

View file

@ -4,22 +4,19 @@
<refentry xml:id="yaf-controller-abstract.render" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Yaf_Controller_Abstract::render</refname>
<refpurpose>The render purpose</refpurpose>
<refpurpose>Render view template</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>final</modifier> <modifier>protected</modifier> <type>string</type><methodname>Yaf_Controller_Abstract::render</methodname>
<modifier>protected</modifier> <type>string</type><methodname>Yaf_Controller_Abstract::render</methodname>
<methodparam><type>string</type><parameter>tpl</parameter></methodparam>
<methodparam choice="opt"><type>array</type><parameter>parameters</parameter></methodparam>
</methodsynopsis>
<para>
</para>
&warn.undocumented.func;
</refsect1>
<refsect1 role="parameters">

View file

@ -10,15 +10,12 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>final</modifier> <modifier>public</modifier> <type>void</type><methodname>Yaf_Controller_Abstract::setViewpath</methodname>
<modifier>public</modifier> <type>void</type><methodname>Yaf_Controller_Abstract::setViewpath</methodname>
<methodparam><type>string</type><parameter>view_directory</parameter></methodparam>
</methodsynopsis>
<para>
</para>
&warn.undocumented.func;
</refsect1>
<refsect1 role="parameters">

View file

@ -4,22 +4,19 @@
<refentry xml:id="yaf-view-simple.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Yaf_View_Simple::__construct</refname>
<refpurpose>The __construct purpose</refpurpose>
<refpurpose>Constructor of Yaf_View_Simple</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <methodname>Yaf_View_Simple::__construct</methodname>
<modifier>final</modifier> <modifier>public</modifier> <methodname>Yaf_View_Simple::__construct</methodname>
<methodparam><type>string</type><parameter>tempalte_dir</parameter></methodparam>
<methodparam choice="opt"><type>array</type><parameter>options</parameter></methodparam>
</methodsynopsis>
<para>
</para>
&warn.undocumented.func;
</refsect1>
<refsect1 role="parameters">

View file

@ -17,9 +17,6 @@
<para>
Render a template and display the result instantly.
</para>
&warn.undocumented.func;
</refsect1>
<refsect1 role="parameters">

View file

@ -14,15 +14,13 @@
<methodparam choice="opt"><type>string</type><parameter>name</parameter></methodparam>
</methodsynopsis>
<para>
Retrieve assigned varaiable
<note>
<para>
parameter can be empty since 2.1.11
</para>
</note>
</para>
&warn.undocumented.func;
</refsect1>
<refsect1 role="parameters">

View file

@ -4,7 +4,7 @@
<refentry xml:id="yaf-view-simple.getscriptpath" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Yaf_View_Simple::getScriptPath</refname>
<refpurpose>Get template base directory</refpurpose>
<refpurpose>Get templates directory</refpurpose>
</refnamediv>
<refsect1 role="description">
@ -16,9 +16,6 @@
<para>
</para>
&warn.undocumented.func;
</refsect1>
<refsect1 role="parameters">

View file

@ -16,9 +16,6 @@
<para>
</para>
&warn.undocumented.func;
</refsect1>
<refsect1 role="parameters">

View file

@ -17,9 +17,6 @@
<para>
Render a tempalte and return the result.
</para>
&warn.undocumented.func;
</refsect1>
<refsect1 role="parameters">

View file

@ -15,12 +15,9 @@
<methodparam><type>mixed</type><parameter>value</parameter></methodparam>
</methodsynopsis>
<para>
This is a easier way to instead of
This is a alternative and easier way to
<methodname>Yaf_View_Simple::assign</methodname>.
</para>
&warn.undocumented.func;
</refsect1>
<refsect1 role="parameters">

View file

@ -4,7 +4,7 @@
<refentry xml:id="yaf-view-simple.setscriptpath" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Yaf_View_Simple::setScriptPath</refname>
<refpurpose>Set tempalte base directory</refpurpose>
<refpurpose>Set tempaltes directory</refpurpose>
</refnamediv>
<refsect1 role="description">
@ -16,9 +16,6 @@
<para>
</para>
&warn.undocumented.func;
</refsect1>
<refsect1 role="parameters">