From 0c4fa155c5682e396ba3012268f7ef0f9def23b6 Mon Sep 17 00:00:00 2001
From: Mehdi Achour <didou@php.net>
Date: Mon, 31 Dec 2007 00:39:35 +0000
Subject: [PATCH] Add description, rewrite refpurposes and add see also

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@249454 c90b9560-bf6c-de11-be94-00142212c4b1
---
 reference/apc/functions/apc-add.xml           |  8 +++++---
 reference/apc/functions/apc-cache-info.xml    | 11 +++++++----
 reference/apc/functions/apc-clear-cache.xml   | 13 +++++++++++--
 reference/apc/functions/apc-compile-file.xml  | 19 +++++++++++--------
 reference/apc/functions/apc-delete.xml        |  7 +++++--
 reference/apc/functions/apc-fetch.xml         |  7 +++++--
 .../apc/functions/apc-load-constants.xml      |  5 ++++-
 reference/apc/functions/apc-sma-info.xml      |  9 ++++++---
 reference/apc/functions/apc-store.xml         |  8 +++++---
 9 files changed, 59 insertions(+), 28 deletions(-)

diff --git a/reference/apc/functions/apc-add.xml b/reference/apc/functions/apc-add.xml
index 9dbca44ef2..26226a263b 100644
--- a/reference/apc/functions/apc-add.xml
+++ b/reference/apc/functions/apc-add.xml
@@ -1,10 +1,10 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
 <refentry xml:id="function.apc-add" xmlns="http://docbook.org/ns/docbook">
  <refnamediv>
   <refname>apc_add</refname>
   <refpurpose>
-   Cache a variable in the data store (only if it's not stored)
+   Cache a variable in the data store
   </refpurpose>
  </refnamediv>
  <refsect1 role="description">
@@ -15,7 +15,9 @@
    <methodparam><type>mixed</type><parameter>var</parameter></methodparam>
    <methodparam choice="opt"><type>int</type><parameter>ttl</parameter></methodparam>
   </methodsynopsis>
-
+  <para>
+   Caches a variable in the data store, only if it's not already stored.
+  </para>
   <note>
    <simpara>
     Unlike many other mechanisms in PHP, variables stored using
diff --git a/reference/apc/functions/apc-cache-info.xml b/reference/apc/functions/apc-cache-info.xml
index 40f0cb9c82..6b4cbe5917 100644
--- a/reference/apc/functions/apc-cache-info.xml
+++ b/reference/apc/functions/apc-cache-info.xml
@@ -1,10 +1,10 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.5 $ -->
+<!-- $Revision: 1.6 $ -->
 <refentry xml:id="function.apc-cache-info" xmlns="http://docbook.org/ns/docbook">
  <refnamediv>
   <refname>apc_cache_info</refname>
   <refpurpose>
-   Retrieves cached information (and meta-data) from APC's data store
+   Retrieves cached information from APC's data store
   </refpurpose>
  </refnamediv>
  <refsect1 role="description">
@@ -14,6 +14,9 @@
    <methodparam choice="opt"><type>string</type><parameter>cache_type</parameter></methodparam>
    <methodparam choice="opt"><type>bool</type><parameter>limited</parameter></methodparam>
   </methodsynopsis>
+  <para>
+   Retrieves cached information and meta-data from APC's data store.
+  </para>
  </refsect1>
 
  <refsect1 role="returnvalues">
@@ -38,7 +41,7 @@
      <listitem>
       <para>
        If <parameter>cache_type</parameter> is "<literal>user</literal>",
-       information about the user cache will be returned;  otherwise,  
+       information about the user cache will be returned;  otherwise,
        information about the system cache (cached files) will be returned.
       </para>
      </listitem>
@@ -126,7 +129,7 @@ Array
    </example>
   </para>
  </refsect1>
- 
+
  <refsect1 role="seealso">
   &reftitle.seealso;
   <para>
diff --git a/reference/apc/functions/apc-clear-cache.xml b/reference/apc/functions/apc-clear-cache.xml
index b5d8370b5a..580697504f 100644
--- a/reference/apc/functions/apc-clear-cache.xml
+++ b/reference/apc/functions/apc-clear-cache.xml
@@ -1,10 +1,10 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.4 $ -->
+<!-- $Revision: 1.5 $ -->
 <refentry xml:id="function.apc-clear-cache" xmlns="http://docbook.org/ns/docbook">
  <refnamediv>
   <refname>apc_clear_cache</refname>
   <refpurpose>
-   Clears the APC cache 
+   Clears the APC cache
   </refpurpose>
  </refnamediv>
  <refsect1 role="description">
@@ -40,6 +40,15 @@
   </para>
  </refsect1>
 
+ <refsect1 role="seealso">
+  &reftitle.seealso;
+  <para>
+   <simplelist>
+    <member><function>apc_cache_info</function></member>
+   </simplelist>
+  </para>
+ </refsect1>
+
 </refentry>
 
 <!-- Keep this comment at the end of the file
diff --git a/reference/apc/functions/apc-compile-file.xml b/reference/apc/functions/apc-compile-file.xml
index fad1b5c47d..7e3adc1534 100644
--- a/reference/apc/functions/apc-compile-file.xml
+++ b/reference/apc/functions/apc-compile-file.xml
@@ -1,10 +1,10 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
 <refentry xml:id="function.apc-compile-file" xmlns="http://docbook.org/ns/docbook">
  <refnamediv>
   <refname>apc_compile_file</refname>
   <refpurpose>
-   Stores a file in the bytecode cache, bypassing all filters. 
+   Stores a file in the bytecode cache, bypassing all filters.
   </refpurpose>
  </refnamediv>
  <refsect1 role="description">
@@ -13,12 +13,8 @@
    <type>bool</type><methodname>apc_compile_file</methodname>
    <methodparam><type>string</type><parameter>filename</parameter></methodparam>
   </methodsynopsis>
- </refsect1>
-
- <refsect1 role="returnvalues">
-  &reftitle.returnvalues;
   <para>
-   &return.success;
+   Stores a file in the bytecode cache, bypassing all filters.
   </para>
  </refsect1>
 
@@ -31,7 +27,7 @@
      <listitem>
       <para>
        Full or relative path to a PHP file that will be compiled and stored in
-       the bytecode cache. 
+       the bytecode cache.
       </para>
      </listitem>
     </varlistentry>
@@ -39,6 +35,13 @@
   </para>
  </refsect1>
 
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   &return.success;
+  </para>
+ </refsect1>
+
 </refentry>
 
 <!-- Keep this comment at the end of the file
diff --git a/reference/apc/functions/apc-delete.xml b/reference/apc/functions/apc-delete.xml
index d346125839..70c83f86a2 100644
--- a/reference/apc/functions/apc-delete.xml
+++ b/reference/apc/functions/apc-delete.xml
@@ -1,10 +1,10 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.3 $ -->
+<!-- $Revision: 1.4 $ -->
 <refentry xml:id="function.apc-delete" xmlns="http://docbook.org/ns/docbook">
  <refnamediv>
   <refname>apc_delete</refname>
   <refpurpose>
-   Removes a stored variable from the cache 
+   Removes a stored variable from the cache
   </refpurpose>
  </refnamediv>
  <refsect1 role="description">
@@ -13,6 +13,9 @@
    <type>bool</type><methodname>apc_delete</methodname>
    <methodparam><type>string</type><parameter>key</parameter></methodparam>
   </methodsynopsis>
+  <para>
+   Removes a stored variable from the cache.
+  </para>
  </refsect1>
  <refsect1 role="parameters">
   &reftitle.parameters;
diff --git a/reference/apc/functions/apc-fetch.xml b/reference/apc/functions/apc-fetch.xml
index 56f86885bb..10519d3e3c 100644
--- a/reference/apc/functions/apc-fetch.xml
+++ b/reference/apc/functions/apc-fetch.xml
@@ -1,10 +1,10 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
 <refentry xml:id="function.apc-fetch" xmlns="http://docbook.org/ns/docbook">
  <refnamediv>
   <refname>apc_fetch</refname>
   <refpurpose>
-   Fetch a stored variable from the cache 
+   Fetch a stored variable from the cache
   </refpurpose>
  </refnamediv>
  <refsect1 role="description">
@@ -13,6 +13,9 @@
    <type>mixed</type><methodname>apc_fetch</methodname>
    <methodparam><type>string</type><parameter>key</parameter></methodparam>
   </methodsynopsis>
+  <para>
+   Fetchs a stored variable from the cache.
+  </para>
  </refsect1>
  <refsect1 role="parameters">
   &reftitle.parameters;
diff --git a/reference/apc/functions/apc-load-constants.xml b/reference/apc/functions/apc-load-constants.xml
index 007a2eab7f..3982f63839 100644
--- a/reference/apc/functions/apc-load-constants.xml
+++ b/reference/apc/functions/apc-load-constants.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.3 $ -->
+<!-- $Revision: 1.4 $ -->
 <refentry xml:id="function.apc-load-constants" xmlns="http://docbook.org/ns/docbook">
  <refnamediv>
   <refname>apc_load_constants</refname>
@@ -14,6 +14,9 @@
    <methodparam><type>string</type><parameter>key</parameter></methodparam>
    <methodparam choice="opt"><type>bool</type><parameter>case_sensitive</parameter></methodparam>
   </methodsynopsis>
+  <para>
+   Loads a set of constants from the cache.
+  </para>
  </refsect1>
  <refsect1 role="parameters">
   &reftitle.parameters;
diff --git a/reference/apc/functions/apc-sma-info.xml b/reference/apc/functions/apc-sma-info.xml
index 38261122d4..14af9b4bc9 100644
--- a/reference/apc/functions/apc-sma-info.xml
+++ b/reference/apc/functions/apc-sma-info.xml
@@ -1,10 +1,10 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.3 $ -->
+<!-- $Revision: 1.4 $ -->
 <refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.apc-sma-info">
  <refnamediv>
   <refname>apc_sma_info</refname>
   <refpurpose>
-   Retrieves APC's Shared Memory Allocation information 
+   Retrieves APC's Shared Memory Allocation information
   </refpurpose>
  </refnamediv>
  <refsect1 role="description">
@@ -13,8 +13,11 @@
    <type>array</type><methodname>apc_sma_info</methodname>
    <methodparam choice="opt"><type>bool</type><parameter>limited</parameter></methodparam>
   </methodsynopsis>
+  <para>
+   Retrieves APC's Shared Memory Allocation information.
+  </para>
  </refsect1>
- 
+
  <refsect1 role="parameters">
   &reftitle.parameters;
   <para>
diff --git a/reference/apc/functions/apc-store.xml b/reference/apc/functions/apc-store.xml
index 14867146e1..bc793f1da5 100644
--- a/reference/apc/functions/apc-store.xml
+++ b/reference/apc/functions/apc-store.xml
@@ -1,10 +1,10 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.5 $ -->
+<!-- $Revision: 1.6 $ -->
 <refentry xml:id="function.apc-store" xmlns="http://docbook.org/ns/docbook">
  <refnamediv>
   <refname>apc_store</refname>
   <refpurpose>
-   Cache a variable in the data store 
+   Cache a variable in the data store
   </refpurpose>
  </refnamediv>
  <refsect1 role="description">
@@ -15,7 +15,9 @@
    <methodparam><type>mixed</type><parameter>var</parameter></methodparam>
    <methodparam choice="opt"><type>int</type><parameter>ttl</parameter></methodparam>
   </methodsynopsis>
-
+  <para>
+   Cache a variable in the data store.
+  </para>
   <note>
    <simpara>
     Unlike many other mechanisms in PHP, variables stored using