From 124db9928136a3e3d91035cae3d95a3cbc541c9d Mon Sep 17 00:00:00 2001
From: Xinchen Hui <laruence@php.net>
Date: Sun, 4 Dec 2011 05:51:01 +0000
Subject: [PATCH] Add docs for the yaf.cache_config Add visiblity modifier to
 constructors

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@320343 c90b9560-bf6c-de11-be94-00142212c4b1
---
 reference/yaf/ini.xml                          | 16 +++++++++++++++-
 reference/yaf/yaf_application/construct.xml    | 12 ++++++++++--
 reference/yaf/yaf_dispatcher/construct.xml     |  2 +-
 reference/yaf/yaf_loader/construct.xml         |  2 +-
 reference/yaf/yaf_route_regex/construct.xml    |  2 +-
 reference/yaf/yaf_route_rewrite/construct.xml  |  2 +-
 reference/yaf/yaf_route_simple/construct.xml   |  2 +-
 reference/yaf/yaf_route_supervar/construct.xml |  7 +++++--
 reference/yaf/yaf_router/construct.xml         |  4 ++--
 9 files changed, 37 insertions(+), 12 deletions(-)

diff --git a/reference/yaf/ini.xml b/reference/yaf/ini.xml
index fb3903761b..d7e330e1c2 100644
--- a/reference/yaf/ini.xml
+++ b/reference/yaf/ini.xml
@@ -203,9 +203,23 @@
      <listitem>
       <para>
         If this is On, and in the meantime you are using ini config file as the
-        parameter of <classname>Yaf_Application</classname>, then the
+        parameter of <methodname>Yaf_Application</methodname>, the
         compiling result of the ini config file will be cached in the PHP
         process.
+        <note>
+         <para>
+          Yaf examine the mtime of the ini file, if it was changed since
+          last compiling, Yaf will reload it.
+         </para>
+        </note>
+        <warning>
+         <para>
+          Yaf use the ini file path as the cache entry key, so do use the
+          absolute path in ini file path, otherwise there might be some
+          conflicts if two application use the same relative path of ini
+          config.
+         </para>
+        </warning>
       </para>
      </listitem>
     </varlistentry>
diff --git a/reference/yaf/yaf_application/construct.xml b/reference/yaf/yaf_application/construct.xml
index 5537bf74f4..e2ef8bbedd 100644
--- a/reference/yaf/yaf_application/construct.xml
+++ b/reference/yaf/yaf_application/construct.xml
@@ -10,12 +10,12 @@
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
-   <methodname>Yaf_Application::__construct</methodname>
+   <modifier>public</modifier><methodname>Yaf_Application::__construct</methodname>
    <methodparam><type>mixed</type><parameter>config</parameter></methodparam>
    <methodparam choice="opt"><type>string</type><parameter>envrion</parameter></methodparam>
   </methodsynopsis>
   <para>
-
+   Instance a <classname>Yaf_Application</classname>.
   </para>
 
   &warn.undocumented.func;
@@ -35,6 +35,14 @@
        If is a ini config file, there should be a section named as the one
        defined by <link linkend="ini.yaf.environ">yaf.environ</link>, which
        is "product" by default.
+      <note>
+       <para>
+        If you use a ini configuration file as your applicatioin's config
+        container. you would open the <link
+         linkend="ini.yaf.cache-config">yaf.cache_config</link> to improve
+        performance.
+       </para>
+      </note>
      </para>
      <para>
        And the config entry(and there default value) list blow:
diff --git a/reference/yaf/yaf_dispatcher/construct.xml b/reference/yaf/yaf_dispatcher/construct.xml
index fa585c4163..134813d83e 100644
--- a/reference/yaf/yaf_dispatcher/construct.xml
+++ b/reference/yaf/yaf_dispatcher/construct.xml
@@ -10,7 +10,7 @@
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
-   <methodname>Yaf_Dispatcher::__construct</methodname>
+   <modifier>public</modifier><methodname>Yaf_Dispatcher::__construct</methodname>
    <void />
   </methodsynopsis>
   <para>
diff --git a/reference/yaf/yaf_loader/construct.xml b/reference/yaf/yaf_loader/construct.xml
index 861a8b2c84..f6c5be1a57 100644
--- a/reference/yaf/yaf_loader/construct.xml
+++ b/reference/yaf/yaf_loader/construct.xml
@@ -10,7 +10,7 @@
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
-   <methodname>Yaf_Loader::__construct</methodname>
+   <modifier>public</modifier><methodname>Yaf_Loader::__construct</methodname>
    <void />
   </methodsynopsis>
   <para>
diff --git a/reference/yaf/yaf_route_regex/construct.xml b/reference/yaf/yaf_route_regex/construct.xml
index df4392ee65..a8381a1f8f 100644
--- a/reference/yaf/yaf_route_regex/construct.xml
+++ b/reference/yaf/yaf_route_regex/construct.xml
@@ -10,7 +10,7 @@
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
-   <methodname>Yaf_Route_Regex::__construct</methodname>
+   <modifier>public</modifier><methodname>Yaf_Route_Regex::__construct</methodname>
    <methodparam><type>string</type><parameter>match</parameter></methodparam>
    <methodparam><type>array</type><parameter>route</parameter></methodparam>
    <methodparam choice="opt"><type>array</type><parameter>map</parameter></methodparam>
diff --git a/reference/yaf/yaf_route_rewrite/construct.xml b/reference/yaf/yaf_route_rewrite/construct.xml
index e53d6148d8..26c27cf529 100644
--- a/reference/yaf/yaf_route_rewrite/construct.xml
+++ b/reference/yaf/yaf_route_rewrite/construct.xml
@@ -10,7 +10,7 @@
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
-   <methodname>Yaf_Route_Rewrite::__construct</methodname>
+   <modifier>public</modifier><methodname>Yaf_Route_Rewrite::__construct</methodname>
    <methodparam><type>string</type><parameter>match</parameter></methodparam>
    <methodparam><type>array</type><parameter>route</parameter></methodparam>
    <methodparam choice="opt"><type>array</type><parameter>verify</parameter></methodparam>
diff --git a/reference/yaf/yaf_route_simple/construct.xml b/reference/yaf/yaf_route_simple/construct.xml
index 02b78c509a..73bcb15884 100644
--- a/reference/yaf/yaf_route_simple/construct.xml
+++ b/reference/yaf/yaf_route_simple/construct.xml
@@ -10,7 +10,7 @@
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
-   <methodname>Yaf_Route_Simple::__construct</methodname>
+   <modifier>public</modifier><methodname>Yaf_Route_Simple::__construct</methodname>
    <methodparam><type>string</type><parameter>module_name</parameter></methodparam>
    <methodparam><type>string</type><parameter>controller_name</parameter></methodparam>
    <methodparam><type>string</type><parameter>action_name</parameter></methodparam>
diff --git a/reference/yaf/yaf_route_supervar/construct.xml b/reference/yaf/yaf_route_supervar/construct.xml
index 5b26488eb7..087e8a19aa 100644
--- a/reference/yaf/yaf_route_supervar/construct.xml
+++ b/reference/yaf/yaf_route_supervar/construct.xml
@@ -10,11 +10,14 @@
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
-   <methodname>Yaf_Route_Supervar::__construct</methodname>
+   <modifier>public</modifier><methodname>Yaf_Route_Supervar::__construct</methodname>
    <methodparam><type>string</type><parameter>supervar_name</parameter></methodparam>
   </methodsynopsis>
   <para>
-
+   <classname>Yaf_Route_Supervar</classname> is similar with
+   <classname>Yaf_Route_Static</classname>, the difference is
+   <classname>Yaf_Route_Supervar</classname> will look for path info in query
+   string, and the parameter <varname>supervar_name</varname> is the key.
   </para>
 
   &warn.undocumented.func;
diff --git a/reference/yaf/yaf_router/construct.xml b/reference/yaf/yaf_router/construct.xml
index 779b9b1b3f..fe1e2fbe69 100644
--- a/reference/yaf/yaf_router/construct.xml
+++ b/reference/yaf/yaf_router/construct.xml
@@ -4,13 +4,13 @@
 <refentry xml:id="yaf-router.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
  <refnamediv>
   <refname>Yaf_Router::__construct</refname>
-  <refpurpose>The __construct purpose</refpurpose>
+  <refpurpose>Yaf_Router constructor</refpurpose>
  </refnamediv>
 
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
-   <methodname>Yaf_Router::__construct</methodname>
+   <modifier>public</modifier><methodname>Yaf_Router::__construct</methodname>
    <void />
   </methodsynopsis>
   <para>