From ed2da66dc062cad5077211f5a69327b441d49339 Mon Sep 17 00:00:00 2001
From: Xinchen Hui <laruence@php.net>
Date: Thu, 1 Sep 2011 11:12:59 +0000
Subject: [PATCH] update docs

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@315968 c90b9560-bf6c-de11-be94-00142212c4b1
---
 reference/yaf/examples.xml                    | 137 ++++++++++++++++--
 reference/yaf/versions.xml                    |   3 +
 reference/yaf/yaf_application/app.xml         |   2 +-
 .../yaf/yaf_application/clearlasterror.xml    |  93 ++++++++++++
 reference/yaf/yaf_application/environ.xml     |   2 +-
 reference/yaf/yaf_application/execute.xml     |   2 +-
 reference/yaf/yaf_application/getconfig.xml   |   2 +-
 .../yaf/yaf_application/getdispatcher.xml     |   2 +-
 .../yaf/yaf_application/getlasterrormsg.xml   |  92 ++++++++++++
 .../yaf/yaf_application/getlasterrorno.xml    |  93 ++++++++++++
 reference/yaf/yaf_application/getmodules.xml  |   2 +-
 reference/yaf/yaf_application/run.xml         |   2 +-
 reference/yaf/yaf_dispatcher/autorender.xml   |   6 +-
 .../yaf/yaf_dispatcher/catchexception.xml     |   6 +-
 reference/yaf/yaf_dispatcher/clone.xml        |   2 +-
 reference/yaf/yaf_dispatcher/construct.xml    |   2 +-
 reference/yaf/yaf_dispatcher/disableview.xml  |   4 +-
 reference/yaf/yaf_dispatcher/dispatch.xml     |   6 +-
 reference/yaf/yaf_dispatcher/enableview.xml   |   4 +-
 .../yaf/yaf_dispatcher/flushinstantly.xml     |   6 +-
 .../yaf/yaf_dispatcher/getapplication.xml     |   4 +-
 reference/yaf/yaf_dispatcher/getinstance.xml  |   4 +-
 reference/yaf/yaf_dispatcher/getrequest.xml   |   4 +-
 reference/yaf/yaf_dispatcher/getrouter.xml    |   4 +-
 reference/yaf/yaf_dispatcher/initview.xml     |   4 +-
 .../yaf/yaf_dispatcher/registerplugin.xml     |   6 +-
 .../yaf/yaf_dispatcher/returnresponse.xml     |   4 +-
 .../yaf/yaf_dispatcher/setappdirectory.xml    |   4 +-
 .../yaf/yaf_dispatcher/setdefaultaction.xml   |   4 +-
 .../yaf_dispatcher/setdefaultcontroller.xml   |   4 +-
 .../yaf/yaf_dispatcher/setdefaultmodule.xml   |   4 +-
 .../yaf/yaf_dispatcher/seterrorhandler.xml    |   6 +-
 reference/yaf/yaf_dispatcher/setrequest.xml   |   4 +-
 reference/yaf/yaf_dispatcher/setview.xml      |   4 +-
 .../yaf/yaf_dispatcher/throwexception.xml     |   6 +-
 35 files changed, 464 insertions(+), 70 deletions(-)
 create mode 100644 reference/yaf/yaf_application/clearlasterror.xml
 create mode 100644 reference/yaf/yaf_application/getlasterrormsg.xml
 create mode 100644 reference/yaf/yaf_application/getlasterrorno.xml

diff --git a/reference/yaf/examples.xml b/reference/yaf/examples.xml
index eff30f65d0..d799dd1adb 100644
--- a/reference/yaf/examples.xml
+++ b/reference/yaf/examples.xml
@@ -4,23 +4,136 @@
 <chapter xml:id="yaf.examples" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
  &reftitle.examples;
  <example>
-  <title>Yaf Example</title>
-  <programlisting role="php">
-<![CDATA[
-<?php
-
-/* ... */
-
-?>
-]]>
-  </programlisting>
-  &example.outputs.similar;
+  <title>A classic Application directory layout</title>
   <screen>
 <![CDATA[
-...
+- index.php 
+- .htaccess 
++ conf
+  |- application.ini //application config
+- application/
+  - Bootstrap.php   
+  + controllers
+     - Index.php //default controller
+  + views    
+     |+ index   
+        - index.phtml //view template for default action
+  + modules 
+  - library
+  - models  
+  - plugins 
+]]>
+ </screen>
+ </example>
+ <example>
+  <title>Entry</title>
+  <para>index.php in the top directory is the only way in of the application, you should rewrite all request to it(you can use .htaccess in Apache+php_mod) </para>
+   <programlisting role="php">
+<![CDATA[
+<?php
+define("APPLICATION_PATH",  dirname(__FILE__));
+
+$app  = new Yaf_Application(APPLICATION_PATH . "/conf/application.ini");
+$app->bootstrap() //call bootstrap methods defined in Bootstrap.php
+ ->run();
+]]>
+   </programlisting>
+ </example>
+
+ <example>
+  <title>Rewrite rule</title>
+  <screen>
+<![CDATA[
+#for apache (.htaccess)
+RewriteEngine On
+RewriteCond %{REQUEST_FILENAME} !-f
+RewriteRule .* index.php
+
+#for nginx
+server {
+  listen ****;
+  server_name  domain.com;
+  root   document_root;
+  index  index.php index.html index.htm;
+
+  if (!-e $request_filename) {
+    rewrite ^/(.*)  /index.php/$1 last;
+  }
+}
+
+#for lighttpd
+$HTTP["host"] =~ "(www.)?domain.com$" {
+  url.rewrite = (
+     "^/(.+)/?$"  => "/index.php/$1",
+  )
+}
 ]]>
   </screen>
  </example>
+
+ <example>
+  <title>Application config</title>
+   <programlisting role="ini">
+<![CDATA[
+[yaf]
+;APPLICATION_PATH is the constant defined in index.php
+application.directory=APPLICATION_PATH "/application/" 
+
+;product section inherit from yaf section
+[product:yaf]
+foo=bar
+]]>
+   </programlisting>
+ </example>
+
+ <example>
+  <title>Default controller</title>
+   <programlisting role="php">
+<![CDATA[
+<?php
+class IndexController extends Yaf_Controller_Abstract {
+   /* default action */
+   public function indexAction() {
+       $this->view->word = "hello world";
+   }
+}
+?>
+]]>
+   </programlisting>
+ </example>
+
+ <example>
+  <title>Default view template</title>
+   <programlisting role="php">
+<![CDATA[
+<html>
+ <head>
+   <title>Hello World</title>
+ </head>
+ <body>
+   <?php echo $word;?>
+ </body>
+</htlm>
+]]>
+   </programlisting>
+  </example>
+
+  <example>
+   <title>Run the Applicatioin</title>
+    &example.outputs.similar;
+   <screen>
+<![CDATA[
+<html>
+ <head>
+   <title>Hello World</title>
+ </head>
+ <body>
+   hello world
+ </body>
+</htlm>
+]]>
+   </screen> 
+  </example>
 </chapter>
 
 <!-- Keep this comment at the end of the file
diff --git a/reference/yaf/versions.xml b/reference/yaf/versions.xml
index 6f73671a1e..bee6b89dc2 100644
--- a/reference/yaf/versions.xml
+++ b/reference/yaf/versions.xml
@@ -15,6 +15,9 @@
  <function name='yaf_application::getconfig' from='PECL yaf &gt;=1.0.0'/>
  <function name='yaf_application::getmodules' from='PECL yaf &gt;=1.0.0'/>
  <function name='yaf_application::getdispatcher' from='PECL yaf &gt;=1.0.0'/>
+ <function name='yaf_application::getlasterrorno' from='PECL yaf &gt;=2.1.2'/>
+ <function name='yaf_application::getlasterrormsg' from='PECL yaf &gt;=2.1.2'/>
+ <function name='yaf_application::clearlasterror' from='PECL yaf &gt;=2.1.2'/>
  <function name='yaf_application::__destruct' from='PECL yaf &gt;=1.0.0'/>
  <function name='yaf_application::__clone' from='PECL yaf &gt;=1.0.0'/>
  <function name='yaf_application::__sleep' from='PECL yaf &gt;=1.0.0'/>
diff --git a/reference/yaf/yaf_application/app.xml b/reference/yaf/yaf_application/app.xml
index bd0d261ce7..8e9baf7d44 100644
--- a/reference/yaf/yaf_application/app.xml
+++ b/reference/yaf/yaf_application/app.xml
@@ -4,7 +4,7 @@
 <refentry xml:id="yaf-application.app" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
  <refnamediv>
   <refname>Yaf_Application::app</refname>
-  <refpurpose>retrive an Application instance</refpurpose>
+  <refpurpose>Retrive an Application instance</refpurpose>
  </refnamediv>
 
  <refsect1 role="description">
diff --git a/reference/yaf/yaf_application/clearlasterror.xml b/reference/yaf/yaf_application/clearlasterror.xml
new file mode 100644
index 0000000000..809338fd64
--- /dev/null
+++ b/reference/yaf/yaf_application/clearlasterror.xml
@@ -0,0 +1,93 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+
+<refentry xml:id="yaf-application.clearlasterror" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+  <refname>Yaf_Application::clearLastError</refname>
+  <refpurpose>Clear the last error info</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <modifier>public</modifier> <type>Yaf_Application</type><methodname>Yaf_Application::clearLastError</methodname>
+   <void />
+  </methodsynopsis>
+  <para>
+
+  </para>
+
+  &warn.undocumented.func;
+
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  &no.function.parameters;
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+
+  </para>
+ </refsect1>
+
+ <refsect1 role="examples">
+  &reftitle.examples;
+  <example>
+   <title><function>Yaf_Application::clearLastError</function>example</title>
+   <programlisting role="php">
+<![CDATA[
+<?php
+function error_handler($errno, $errstr, $errfile, $errline) {
+   Yaf_Application::app()->clearLastError();
+   var_dump(Yaf_Application::app()->getLastErrorNo());
+}
+ 
+$config = array(                   
+ "application" => array(
+   "directory" => "/tmp/notexists",
+     "dispatcher" => array(
+       "throwException" => 0, //trigger error instead of throw exception when error occure
+      ),
+  ),
+);
+  
+$app = new Yaf_Application($config);
+$app->getDispatcher()->setErrorHandler("error_handler", E_RECOVERABLE_ERROR);
+$app->run();
+?>
+]]>
+   </programlisting>
+   &example.outputs.similar;
+   <screen>
+<![CDATA[
+int(0)
+]]>
+   </screen>
+  </example>
+ </refsect1>
+
+</refentry>
+
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+indent-tabs-mode:nil
+sgml-parent-document:nil
+sgml-default-dtd-file:"~/.phpdoc/manual.ced"
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+vim600: syn=xml fen fdm=syntax fdl=2 si
+vim: et tw=78 syn=sgml
+vi: ts=1 sw=1
+-->
diff --git a/reference/yaf/yaf_application/environ.xml b/reference/yaf/yaf_application/environ.xml
index 93fa754980..76f145d24b 100644
--- a/reference/yaf/yaf_application/environ.xml
+++ b/reference/yaf/yaf_application/environ.xml
@@ -4,7 +4,7 @@
 <refentry xml:id="yaf-application.environ" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
  <refnamediv>
   <refname>Yaf_Application::environ</refname>
-  <refpurpose>retrive environ</refpurpose>
+  <refpurpose>Retrive environ</refpurpose>
  </refnamediv>
 
  <refsect1 role="description">
diff --git a/reference/yaf/yaf_application/execute.xml b/reference/yaf/yaf_application/execute.xml
index a8cec71754..b4ea5959ae 100644
--- a/reference/yaf/yaf_application/execute.xml
+++ b/reference/yaf/yaf_application/execute.xml
@@ -4,7 +4,7 @@
 <refentry xml:id="yaf-application.execute" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
  <refnamediv>
   <refname>Yaf_Application::execute</refname>
-  <refpurpose>execute a callback</refpurpose>
+  <refpurpose>Execute a callback</refpurpose>
  </refnamediv>
 
  <refsect1 role="description">
diff --git a/reference/yaf/yaf_application/getconfig.xml b/reference/yaf/yaf_application/getconfig.xml
index addf34cb8b..0cb30be824 100644
--- a/reference/yaf/yaf_application/getconfig.xml
+++ b/reference/yaf/yaf_application/getconfig.xml
@@ -4,7 +4,7 @@
 <refentry xml:id="yaf-application.getconfig" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
  <refnamediv>
   <refname>Yaf_Application::getConfig</refname>
-  <refpurpose>retrive the config instance</refpurpose>
+  <refpurpose>Retrive the config instance</refpurpose>
  </refnamediv>
 
  <refsect1 role="description">
diff --git a/reference/yaf/yaf_application/getdispatcher.xml b/reference/yaf/yaf_application/getdispatcher.xml
index c3c8423e81..9a0741dc9f 100644
--- a/reference/yaf/yaf_application/getdispatcher.xml
+++ b/reference/yaf/yaf_application/getdispatcher.xml
@@ -4,7 +4,7 @@
 <refentry xml:id="yaf-application.getdispatcher" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
  <refnamediv>
   <refname>Yaf_Application::getDispatcher</refname>
-  <refpurpose>get Yaf_Dispatcher instance</refpurpose>
+  <refpurpose>Get Yaf_Dispatcher instance</refpurpose>
  </refnamediv>
 
  <refsect1 role="description">
diff --git a/reference/yaf/yaf_application/getlasterrormsg.xml b/reference/yaf/yaf_application/getlasterrormsg.xml
new file mode 100644
index 0000000000..d9a7b648bf
--- /dev/null
+++ b/reference/yaf/yaf_application/getlasterrormsg.xml
@@ -0,0 +1,92 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+
+<refentry xml:id="yaf-application.getlasterrormsg" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+  <refname>Yaf_Application::getLastErrorMsg</refname>
+  <refpurpose>Get message of the last occurred error</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <modifier>public</modifier> <type>string</type><methodname>Yaf_Application::getLastErrorMsg</methodname>
+   <void />
+  </methodsynopsis>
+  <para>
+
+  </para>
+
+  &warn.undocumented.func;
+
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  &no.function.parameters;
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+
+  </para>
+ </refsect1>
+
+ <refsect1 role="examples">
+  &reftitle.examples;
+  <example>
+   <title><function>Yaf_Application::getLastErrorMsg</function>example</title>
+   <programlisting role="php">
+<![CDATA[
+<?php
+function error_handler($errno, $errstr, $errfile, $errline) {
+   var_dump(Yaf_Application::app()->getLastErrorMsg());
+}
+
+$config = array(                   
+ "application" => array(
+   "directory" => "/tmp/notexists",
+     "dispatcher" => array(
+       "throwException" => 0, //trigger error instead of throw exception when error occure
+      ),
+  ),
+);
+
+$app = new Yaf_Application($config);
+$app->getDispatcher()->setErrorHandler("error_handler", E_RECOVERABLE_ERROR);
+$app->run();
+?>
+]]>
+   </programlisting>
+   &example.outputs.similar;
+   <screen>
+<![CDATA[
+string(69) "Could not find controller script /tmp/notexists/controllers/Index.php"
+]]>
+   </screen>
+  </example>
+ </refsect1>
+
+</refentry>
+
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+indent-tabs-mode:nil
+sgml-parent-document:nil
+sgml-default-dtd-file:"~/.phpdoc/manual.ced"
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+vim600: syn=xml fen fdm=syntax fdl=2 si
+vim: et tw=78 syn=sgml
+vi: ts=1 sw=1
+-->
diff --git a/reference/yaf/yaf_application/getlasterrorno.xml b/reference/yaf/yaf_application/getlasterrorno.xml
new file mode 100644
index 0000000000..0ceabe44fc
--- /dev/null
+++ b/reference/yaf/yaf_application/getlasterrorno.xml
@@ -0,0 +1,93 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+
+<refentry xml:id="yaf-application.getlasterrorno" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+  <refname>Yaf_Application::getLastErrorNo</refname>
+  <refpurpose>Get code of last occurred error</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <modifier>public</modifier> <type>int</type><methodname>Yaf_Application::getLastErrorNo</methodname>
+   <void />
+  </methodsynopsis>
+  <para>
+
+  </para>
+
+  &warn.undocumented.func;
+
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  &no.function.parameters;
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+
+  </para>
+ </refsect1>
+ <refsect1 role="examples">
+  &reftitle.examples;
+  <example>
+   <title><function>Yaf_Application::getLastErrorNo</function>example</title>
+   <programlisting role="php">
+<![CDATA[
+<?php
+function error_handler($errno, $errstr, $errfile, $errline) {
+   var_dump(Yaf_Application::app()->getLastErrorNo());
+   var_dump(Yaf_Application::app()->getLastErrorNo() == YAF_ERR_NOTFOUND_CONTROLLER);
+}
+
+$config = array(
+  "application" => array(
+   "directory" => "/tmp/notexists",
+     "dispatcher" => array(
+       "throwException" => 0, //trigger error instead of throw exception when error occure
+      ),
+  ),
+);
+
+$app = new Yaf_Application($config);
+$app->getDispatcher()->setErrorHandler("error_handler", E_RECOVERABLE_ERROR);
+$app->run();
+]]>
+   </programlisting>
+   &example.outputs.similar;
+   <screen>
+<![CDATA[
+int(516)
+bool(true)
+]]>
+   </screen>
+  </example>
+ </refsect1>
+
+
+</refentry>
+
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+indent-tabs-mode:nil
+sgml-parent-document:nil
+sgml-default-dtd-file:"~/.phpdoc/manual.ced"
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+vim600: syn=xml fen fdm=syntax fdl=2 si
+vim: et tw=78 syn=sgml
+vi: ts=1 sw=1
+-->
diff --git a/reference/yaf/yaf_application/getmodules.xml b/reference/yaf/yaf_application/getmodules.xml
index 3c6f742dba..60552bcd28 100644
--- a/reference/yaf/yaf_application/getmodules.xml
+++ b/reference/yaf/yaf_application/getmodules.xml
@@ -4,7 +4,7 @@
 <refentry xml:id="yaf-application.getmodules" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
  <refnamediv>
   <refname>Yaf_Application::getModules</refname>
-  <refpurpose>get defined module names</refpurpose>
+  <refpurpose>Get defined module names</refpurpose>
  </refnamediv>
 
  <refsect1 role="description">
diff --git a/reference/yaf/yaf_application/run.xml b/reference/yaf/yaf_application/run.xml
index 13dfc7098c..b90e499f5c 100644
--- a/reference/yaf/yaf_application/run.xml
+++ b/reference/yaf/yaf_application/run.xml
@@ -4,7 +4,7 @@
 <refentry xml:id="yaf-application.run" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
  <refnamediv>
   <refname>Yaf_Application::run</refname>
-  <refpurpose>start Yaf_Application</refpurpose>
+  <refpurpose>Start Yaf_Application</refpurpose>
  </refnamediv>
 
  <refsect1 role="description">
diff --git a/reference/yaf/yaf_dispatcher/autorender.xml b/reference/yaf/yaf_dispatcher/autorender.xml
index 3e9dcd9286..12ee5832ca 100644
--- a/reference/yaf/yaf_dispatcher/autorender.xml
+++ b/reference/yaf/yaf_dispatcher/autorender.xml
@@ -4,14 +4,14 @@
 <refentry xml:id="yaf-dispatcher.autorender" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
  <refnamediv>
   <refname>Yaf_Dispatcher::autoRender</refname>
-  <refpurpose>The autoRender purpose</refpurpose>
+  <refpurpose>Switch on/off autorendering</refpurpose>
  </refnamediv>
 
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
-   <modifier>public</modifier> <type>void</type><methodname>Yaf_Dispatcher::autoRender</methodname>
-   <methodparam><type>string</type><parameter>flag</parameter></methodparam>
+   <modifier>public</modifier> <type>Yaf_Dispatcher</type><methodname>Yaf_Dispatcher::autoRender</methodname>
+   <methodparam><type>bool</type><parameter>flag</parameter></methodparam>
   </methodsynopsis>
   <para>
 
diff --git a/reference/yaf/yaf_dispatcher/catchexception.xml b/reference/yaf/yaf_dispatcher/catchexception.xml
index f1c50c3afb..deea10bee3 100644
--- a/reference/yaf/yaf_dispatcher/catchexception.xml
+++ b/reference/yaf/yaf_dispatcher/catchexception.xml
@@ -4,14 +4,14 @@
 <refentry xml:id="yaf-dispatcher.catchexception" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
  <refnamediv>
   <refname>Yaf_Dispatcher::catchException</refname>
-  <refpurpose>The catchException purpose</refpurpose>
+  <refpurpose>Switch on/off exception catching</refpurpose>
  </refnamediv>
 
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
-   <modifier>public</modifier> <type>void</type><methodname>Yaf_Dispatcher::catchException</methodname>
-   <methodparam choice="opt"><type>string</type><parameter>flag</parameter></methodparam>
+   <modifier>public</modifier> <type>Yaf_Dispatcher</type><methodname>Yaf_Dispatcher::catchException</methodname>
+   <methodparam choice="opt"><type>bool</type><parameter>flag</parameter></methodparam>
   </methodsynopsis>
   <para>
 
diff --git a/reference/yaf/yaf_dispatcher/clone.xml b/reference/yaf/yaf_dispatcher/clone.xml
index 94eafb08b0..cacfd5fb58 100644
--- a/reference/yaf/yaf_dispatcher/clone.xml
+++ b/reference/yaf/yaf_dispatcher/clone.xml
@@ -4,7 +4,7 @@
 <refentry xml:id="yaf-dispatcher.clone" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
  <refnamediv>
   <refname>Yaf_Dispatcher::__clone</refname>
-  <refpurpose>The __clone purpose</refpurpose>
+  <refpurpose>Yaf_Dispatcher can not be cloned</refpurpose>
  </refnamediv>
 
  <refsect1 role="description">
diff --git a/reference/yaf/yaf_dispatcher/construct.xml b/reference/yaf/yaf_dispatcher/construct.xml
index 5bcfde4eb6..fa585c4163 100644
--- a/reference/yaf/yaf_dispatcher/construct.xml
+++ b/reference/yaf/yaf_dispatcher/construct.xml
@@ -4,7 +4,7 @@
 <refentry xml:id="yaf-dispatcher.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
  <refnamediv>
   <refname>Yaf_Dispatcher::__construct</refname>
-  <refpurpose>The __construct purpose</refpurpose>
+  <refpurpose>Yaf_Dispatcher constructor</refpurpose>
  </refnamediv>
 
  <refsect1 role="description">
diff --git a/reference/yaf/yaf_dispatcher/disableview.xml b/reference/yaf/yaf_dispatcher/disableview.xml
index 3cd7bff337..1f50e8548c 100644
--- a/reference/yaf/yaf_dispatcher/disableview.xml
+++ b/reference/yaf/yaf_dispatcher/disableview.xml
@@ -4,13 +4,13 @@
 <refentry xml:id="yaf-dispatcher.disableview" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
  <refnamediv>
   <refname>Yaf_Dispatcher::disableView</refname>
-  <refpurpose>The disableView purpose</refpurpose>
+  <refpurpose>Disable view rendering</refpurpose>
  </refnamediv>
 
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
-   <modifier>public</modifier> <type>void</type><methodname>Yaf_Dispatcher::disableView</methodname>
+   <modifier>public</modifier> <type>Yaf_Dispatcher</type><methodname>Yaf_Dispatcher::disableView</methodname>
    <void />
   </methodsynopsis>
   <para>
diff --git a/reference/yaf/yaf_dispatcher/dispatch.xml b/reference/yaf/yaf_dispatcher/dispatch.xml
index 1e776f62a4..33784e9571 100644
--- a/reference/yaf/yaf_dispatcher/dispatch.xml
+++ b/reference/yaf/yaf_dispatcher/dispatch.xml
@@ -4,14 +4,14 @@
 <refentry xml:id="yaf-dispatcher.dispatch" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
  <refnamediv>
   <refname>Yaf_Dispatcher::dispatch</refname>
-  <refpurpose>The dispatch purpose</refpurpose>
+  <refpurpose>Dispatch a request</refpurpose>
  </refnamediv>
 
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
-   <modifier>public</modifier> <type>void</type><methodname>Yaf_Dispatcher::dispatch</methodname>
-   <methodparam><type>string</type><parameter>request</parameter></methodparam>
+   <modifier>public</modifier> <type>Yaf_Response_Abstract</type><methodname>Yaf_Dispatcher::dispatch</methodname>
+   <methodparam><type>Yaf_Request_Abstract</type><parameter>request</parameter></methodparam>
   </methodsynopsis>
   <para>
 
diff --git a/reference/yaf/yaf_dispatcher/enableview.xml b/reference/yaf/yaf_dispatcher/enableview.xml
index 579eb31668..a283a13f03 100644
--- a/reference/yaf/yaf_dispatcher/enableview.xml
+++ b/reference/yaf/yaf_dispatcher/enableview.xml
@@ -4,13 +4,13 @@
 <refentry xml:id="yaf-dispatcher.enableview" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
  <refnamediv>
   <refname>Yaf_Dispatcher::enableView</refname>
-  <refpurpose>The enableView purpose</refpurpose>
+  <refpurpose>enable view rendering</refpurpose>
  </refnamediv>
 
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
-   <modifier>public</modifier> <type>void</type><methodname>Yaf_Dispatcher::enableView</methodname>
+   <modifier>public</modifier> <type>Yaf_Dispatcher</type><methodname>Yaf_Dispatcher::enableView</methodname>
    <void />
   </methodsynopsis>
   <para>
diff --git a/reference/yaf/yaf_dispatcher/flushinstantly.xml b/reference/yaf/yaf_dispatcher/flushinstantly.xml
index 1033221143..372e878cc3 100644
--- a/reference/yaf/yaf_dispatcher/flushinstantly.xml
+++ b/reference/yaf/yaf_dispatcher/flushinstantly.xml
@@ -4,14 +4,14 @@
 <refentry xml:id="yaf-dispatcher.flushinstantly" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
  <refnamediv>
   <refname>Yaf_Dispatcher::flushInstantly</refname>
-  <refpurpose>The flushInstantly purpose</refpurpose>
+  <refpurpose>Switch on/off the instant flushing</refpurpose>
  </refnamediv>
 
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
-   <modifier>public</modifier> <type>void</type><methodname>Yaf_Dispatcher::flushInstantly</methodname>
-   <methodparam><type>string</type><parameter>flag</parameter></methodparam>
+   <modifier>public</modifier> <type>Yaf_Dispatcher</type><methodname>Yaf_Dispatcher::flushInstantly</methodname>
+   <methodparam><type>bool</type><parameter>flag</parameter></methodparam>
   </methodsynopsis>
   <para>
 
diff --git a/reference/yaf/yaf_dispatcher/getapplication.xml b/reference/yaf/yaf_dispatcher/getapplication.xml
index 7be2800359..d021a59148 100644
--- a/reference/yaf/yaf_dispatcher/getapplication.xml
+++ b/reference/yaf/yaf_dispatcher/getapplication.xml
@@ -4,13 +4,13 @@
 <refentry xml:id="yaf-dispatcher.getapplication" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
  <refnamediv>
   <refname>Yaf_Dispatcher::getApplication</refname>
-  <refpurpose>The getApplication purpose</refpurpose>
+  <refpurpose>Retrive the application</refpurpose>
  </refnamediv>
 
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
-   <modifier>public</modifier> <type>void</type><methodname>Yaf_Dispatcher::getApplication</methodname>
+   <modifier>public</modifier> <type>Yaf_Application</type><methodname>Yaf_Dispatcher::getApplication</methodname>
    <void />
   </methodsynopsis>
   <para>
diff --git a/reference/yaf/yaf_dispatcher/getinstance.xml b/reference/yaf/yaf_dispatcher/getinstance.xml
index 686d094fce..0dfeeba53d 100644
--- a/reference/yaf/yaf_dispatcher/getinstance.xml
+++ b/reference/yaf/yaf_dispatcher/getinstance.xml
@@ -4,13 +4,13 @@
 <refentry xml:id="yaf-dispatcher.getinstance" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
  <refnamediv>
   <refname>Yaf_Dispatcher::getInstance</refname>
-  <refpurpose>The getInstance purpose</refpurpose>
+  <refpurpose>Retrive the dispatcher instance</refpurpose>
  </refnamediv>
 
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
-   <modifier>public</modifier> <modifier>static</modifier> <type>void</type><methodname>Yaf_Dispatcher::getInstance</methodname>
+   <modifier>public</modifier> <modifier>static</modifier> <type>Yaf_Dispatcher</type><methodname>Yaf_Dispatcher::getInstance</methodname>
    <void />
   </methodsynopsis>
   <para>
diff --git a/reference/yaf/yaf_dispatcher/getrequest.xml b/reference/yaf/yaf_dispatcher/getrequest.xml
index e97778c3c7..43df3d77b2 100644
--- a/reference/yaf/yaf_dispatcher/getrequest.xml
+++ b/reference/yaf/yaf_dispatcher/getrequest.xml
@@ -4,13 +4,13 @@
 <refentry xml:id="yaf-dispatcher.getrequest" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
  <refnamediv>
   <refname>Yaf_Dispatcher::getRequest</refname>
-  <refpurpose>The getRequest purpose</refpurpose>
+  <refpurpose>Retrive the request instance</refpurpose>
  </refnamediv>
 
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
-   <modifier>public</modifier> <type>void</type><methodname>Yaf_Dispatcher::getRequest</methodname>
+   <modifier>public</modifier> <type>Yaf_Request_Abstract</type><methodname>Yaf_Dispatcher::getRequest</methodname>
    <void />
   </methodsynopsis>
   <para>
diff --git a/reference/yaf/yaf_dispatcher/getrouter.xml b/reference/yaf/yaf_dispatcher/getrouter.xml
index 2da7f08e10..11f6f558b7 100644
--- a/reference/yaf/yaf_dispatcher/getrouter.xml
+++ b/reference/yaf/yaf_dispatcher/getrouter.xml
@@ -4,13 +4,13 @@
 <refentry xml:id="yaf-dispatcher.getrouter" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
  <refnamediv>
   <refname>Yaf_Dispatcher::getRouter</refname>
-  <refpurpose>The getRouter purpose</refpurpose>
+  <refpurpose>Retrive router instance</refpurpose>
  </refnamediv>
 
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
-   <modifier>public</modifier> <type>void</type><methodname>Yaf_Dispatcher::getRouter</methodname>
+   <modifier>public</modifier> <type>Yaf_Router</type><methodname>Yaf_Dispatcher::getRouter</methodname>
    <void />
   </methodsynopsis>
   <para>
diff --git a/reference/yaf/yaf_dispatcher/initview.xml b/reference/yaf/yaf_dispatcher/initview.xml
index 2983172561..7d5b3b0b7d 100644
--- a/reference/yaf/yaf_dispatcher/initview.xml
+++ b/reference/yaf/yaf_dispatcher/initview.xml
@@ -4,13 +4,13 @@
 <refentry xml:id="yaf-dispatcher.initview" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
  <refnamediv>
   <refname>Yaf_Dispatcher::initView</refname>
-  <refpurpose>The initView purpose</refpurpose>
+  <refpurpose>Initialize view and return it</refpurpose>
  </refnamediv>
 
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
-   <modifier>public</modifier> <type>void</type><methodname>Yaf_Dispatcher::initView</methodname>
+   <modifier>public</modifier> <type>Yaf_View_Interface</type><methodname>Yaf_Dispatcher::initView</methodname>
    <methodparam><type>string</type><parameter>templates_dir</parameter></methodparam>
    <methodparam choice="opt"><type>array</type><parameter>options</parameter></methodparam>
   </methodsynopsis>
diff --git a/reference/yaf/yaf_dispatcher/registerplugin.xml b/reference/yaf/yaf_dispatcher/registerplugin.xml
index 133fb8448b..0dc04dd41f 100644
--- a/reference/yaf/yaf_dispatcher/registerplugin.xml
+++ b/reference/yaf/yaf_dispatcher/registerplugin.xml
@@ -4,14 +4,14 @@
 <refentry xml:id="yaf-dispatcher.registerplugin" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
  <refnamediv>
   <refname>Yaf_Dispatcher::registerPlugin</refname>
-  <refpurpose>The registerPlugin purpose</refpurpose>
+  <refpurpose>Register a plugin</refpurpose>
  </refnamediv>
 
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
-   <modifier>public</modifier> <type>void</type><methodname>Yaf_Dispatcher::registerPlugin</methodname>
-   <methodparam><type>string</type><parameter>plugin</parameter></methodparam>
+   <modifier>public</modifier> <type>Yaf_Dispatcher</type><methodname>Yaf_Dispatcher::registerPlugin</methodname>
+   <methodparam><type>Yaf_Plugin_Abstract</type><parameter>plugin</parameter></methodparam>
   </methodsynopsis>
   <para>
 
diff --git a/reference/yaf/yaf_dispatcher/returnresponse.xml b/reference/yaf/yaf_dispatcher/returnresponse.xml
index 8d43430a51..2d155cfe41 100644
--- a/reference/yaf/yaf_dispatcher/returnresponse.xml
+++ b/reference/yaf/yaf_dispatcher/returnresponse.xml
@@ -10,8 +10,8 @@
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
-   <modifier>public</modifier> <type>void</type><methodname>Yaf_Dispatcher::returnResponse</methodname>
-   <methodparam><type>string</type><parameter>flag</parameter></methodparam>
+   <modifier>public</modifier> <type>Yaf_Dispatcher</type><methodname>Yaf_Dispatcher::returnResponse</methodname>
+   <methodparam><type>bool</type><parameter>flag</parameter></methodparam>
   </methodsynopsis>
   <para>
 
diff --git a/reference/yaf/yaf_dispatcher/setappdirectory.xml b/reference/yaf/yaf_dispatcher/setappdirectory.xml
index a8aca70ca9..54f1b76900 100644
--- a/reference/yaf/yaf_dispatcher/setappdirectory.xml
+++ b/reference/yaf/yaf_dispatcher/setappdirectory.xml
@@ -4,13 +4,13 @@
 <refentry xml:id="yaf-dispatcher.setappdirectory" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
  <refnamediv>
   <refname>Yaf_Dispatcher::setAppDirectory</refname>
-  <refpurpose>The setAppDirectory purpose</refpurpose>
+  <refpurpose>Change the application directory</refpurpose>
  </refnamediv>
 
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
-   <modifier>public</modifier> <type>void</type><methodname>Yaf_Dispatcher::setAppDirectory</methodname>
+   <modifier>public</modifier> <type>Yaf_Dispatcher</type><methodname>Yaf_Dispatcher::setAppDirectory</methodname>
    <methodparam><type>string</type><parameter>directory</parameter></methodparam>
   </methodsynopsis>
   <para>
diff --git a/reference/yaf/yaf_dispatcher/setdefaultaction.xml b/reference/yaf/yaf_dispatcher/setdefaultaction.xml
index e1c532790a..06526effd3 100644
--- a/reference/yaf/yaf_dispatcher/setdefaultaction.xml
+++ b/reference/yaf/yaf_dispatcher/setdefaultaction.xml
@@ -4,13 +4,13 @@
 <refentry xml:id="yaf-dispatcher.setdefaultaction" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
  <refnamediv>
   <refname>Yaf_Dispatcher::setDefaultAction</refname>
-  <refpurpose>The setDefaultAction purpose</refpurpose>
+  <refpurpose>Change default action name</refpurpose>
  </refnamediv>
 
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
-   <modifier>public</modifier> <type>void</type><methodname>Yaf_Dispatcher::setDefaultAction</methodname>
+   <modifier>public</modifier> <type>Yaf_Dispatcher</type><methodname>Yaf_Dispatcher::setDefaultAction</methodname>
    <methodparam><type>string</type><parameter>action</parameter></methodparam>
   </methodsynopsis>
   <para>
diff --git a/reference/yaf/yaf_dispatcher/setdefaultcontroller.xml b/reference/yaf/yaf_dispatcher/setdefaultcontroller.xml
index 8a92d92e91..772d9a5ecf 100644
--- a/reference/yaf/yaf_dispatcher/setdefaultcontroller.xml
+++ b/reference/yaf/yaf_dispatcher/setdefaultcontroller.xml
@@ -4,13 +4,13 @@
 <refentry xml:id="yaf-dispatcher.setdefaultcontroller" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
  <refnamediv>
   <refname>Yaf_Dispatcher::setDefaultController</refname>
-  <refpurpose>The setDefaultController purpose</refpurpose>
+  <refpurpose>Change default controller name</refpurpose>
  </refnamediv>
 
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
-   <modifier>public</modifier> <type>void</type><methodname>Yaf_Dispatcher::setDefaultController</methodname>
+   <modifier>public</modifier> <type>Yaf_Dispatcher</type><methodname>Yaf_Dispatcher::setDefaultController</methodname>
    <methodparam><type>string</type><parameter>controller</parameter></methodparam>
   </methodsynopsis>
   <para>
diff --git a/reference/yaf/yaf_dispatcher/setdefaultmodule.xml b/reference/yaf/yaf_dispatcher/setdefaultmodule.xml
index 7a24b70b03..188bcd3793 100644
--- a/reference/yaf/yaf_dispatcher/setdefaultmodule.xml
+++ b/reference/yaf/yaf_dispatcher/setdefaultmodule.xml
@@ -4,13 +4,13 @@
 <refentry xml:id="yaf-dispatcher.setdefaultmodule" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
  <refnamediv>
   <refname>Yaf_Dispatcher::setDefaultModule</refname>
-  <refpurpose>The setDefaultModule purpose</refpurpose>
+  <refpurpose>Change default module name</refpurpose>
  </refnamediv>
 
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
-   <modifier>public</modifier> <type>void</type><methodname>Yaf_Dispatcher::setDefaultModule</methodname>
+   <modifier>public</modifier> <type>Yaf_Dispatcher</type><methodname>Yaf_Dispatcher::setDefaultModule</methodname>
    <methodparam><type>string</type><parameter>module</parameter></methodparam>
   </methodsynopsis>
   <para>
diff --git a/reference/yaf/yaf_dispatcher/seterrorhandler.xml b/reference/yaf/yaf_dispatcher/seterrorhandler.xml
index ed226aeab7..c2e4837f5e 100644
--- a/reference/yaf/yaf_dispatcher/seterrorhandler.xml
+++ b/reference/yaf/yaf_dispatcher/seterrorhandler.xml
@@ -10,9 +10,9 @@
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
-   <modifier>public</modifier> <type>void</type><methodname>Yaf_Dispatcher::setErrorHandler</methodname>
-   <methodparam><type>string</type><parameter>callback</parameter></methodparam>
-   <methodparam><type>string</type><parameter>error_types</parameter></methodparam>
+   <modifier>public</modifier> <type>Yaf_Dispatcher</type><methodname>Yaf_Dispatcher::setErrorHandler</methodname>
+   <methodparam><type>call</type><parameter>callback</parameter></methodparam>
+   <methodparam><type>int</type><parameter>error_types</parameter></methodparam>
   </methodsynopsis>
   <para>
 
diff --git a/reference/yaf/yaf_dispatcher/setrequest.xml b/reference/yaf/yaf_dispatcher/setrequest.xml
index de8055d8f2..2804bcd14e 100644
--- a/reference/yaf/yaf_dispatcher/setrequest.xml
+++ b/reference/yaf/yaf_dispatcher/setrequest.xml
@@ -10,8 +10,8 @@
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
-   <modifier>public</modifier> <type>void</type><methodname>Yaf_Dispatcher::setRequest</methodname>
-   <methodparam><type>string</type><parameter>plugin</parameter></methodparam>
+   <modifier>public</modifier> <type>Yaf_Dispatcher</type><methodname>Yaf_Dispatcher::setRequest</methodname>
+   <methodparam><type>Yaf_Request_Abstract</type><parameter>request</parameter></methodparam>
   </methodsynopsis>
   <para>
 
diff --git a/reference/yaf/yaf_dispatcher/setview.xml b/reference/yaf/yaf_dispatcher/setview.xml
index 618f24b292..0a1c7c4dbc 100644
--- a/reference/yaf/yaf_dispatcher/setview.xml
+++ b/reference/yaf/yaf_dispatcher/setview.xml
@@ -10,8 +10,8 @@
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
-   <modifier>public</modifier> <type>void</type><methodname>Yaf_Dispatcher::setView</methodname>
-   <methodparam><type>string</type><parameter>view</parameter></methodparam>
+   <modifier>public</modifier> <type>Yaf_Dispatcher</type><methodname>Yaf_Dispatcher::setView</methodname>
+   <methodparam><type>Yaf_View_Interface</type><parameter>view</parameter></methodparam>
   </methodsynopsis>
   <para>
 
diff --git a/reference/yaf/yaf_dispatcher/throwexception.xml b/reference/yaf/yaf_dispatcher/throwexception.xml
index 84f61f7e9b..7837c6689e 100644
--- a/reference/yaf/yaf_dispatcher/throwexception.xml
+++ b/reference/yaf/yaf_dispatcher/throwexception.xml
@@ -4,14 +4,14 @@
 <refentry xml:id="yaf-dispatcher.throwexception" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
  <refnamediv>
   <refname>Yaf_Dispatcher::throwException</refname>
-  <refpurpose>The throwException purpose</refpurpose>
+  <refpurpose>Switch on/off exception throwing</refpurpose>
  </refnamediv>
 
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
-   <modifier>public</modifier> <type>void</type><methodname>Yaf_Dispatcher::throwException</methodname>
-   <methodparam choice="opt"><type>string</type><parameter>flag</parameter></methodparam>
+   <modifier>public</modifier> <type>Yaf_Dispatcher</type><methodname>Yaf_Dispatcher::throwException</methodname>
+   <methodparam choice="opt"><type>bool</type><parameter>flag</parameter></methodparam>
   </methodsynopsis>
   <para>