sigmasternchen/php-doc-en
1
0
Fork 0
mirror of https://github.com/sigmasternchen/php-doc-en synced 2025-03-16 00:48:54 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Add description, rewrite refpurposes and add see also

Browse source 
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@249454 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Mehdi Achour 2007-12-31 00:39:35 +00:00
parent e18b239894
commit 0c4fa155c5
9 changed files with 59 additions and 28 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
reference/apc/functions/apc-add.xml
View file

@ -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

11
reference/apc/functions/apc-cache-info.xml
View file

@ -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>

13
reference/apc/functions/apc-clear-cache.xml
View file

@ -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

19
reference/apc/functions/apc-compile-file.xml
View file

@ -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

7
reference/apc/functions/apc-delete.xml
View file

@ -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;

7
reference/apc/functions/apc-fetch.xml
View file

@ -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;

5
reference/apc/functions/apc-load-constants.xml
View file

@ -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;

9
reference/apc/functions/apc-sma-info.xml
View file

@ -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>

8
reference/apc/functions/apc-store.xml
View file

@ -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