Added basic documentation for shm_has_var, and added some see also sections

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@282870 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Kalle Sommer Nielsen 2009-06-27 13:20:42 +00:00
parent 07f986537b
commit c4b0551ba3
3 changed files with 105 additions and 2 deletions

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.8 $ -->
<!-- $Revision: 1.9 $ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.shm-get-var">
<refnamediv>
<refname>shm_get_var</refname>
@ -51,6 +51,16 @@
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>shm_has_var</function></member>
<member><function>shm_put_var</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

View file

@ -0,0 +1,83 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.shm-has-var">
<refnamediv>
<refname>shm_has_var</refname>
<refpurpose>Check whether a specific entry exists</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>shm_has_var</methodname>
<methodparam><type>resource</type><parameter>shm_identifier</parameter></methodparam>
<methodparam><type>int</type><parameter>variable_key</parameter></methodparam>
</methodsynopsis>
<para>
Checks whether a specific entry exists.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>shm_identifier</parameter></term>
<listitem>
<para>
Shared memory segment, obtained from <function>shm_attach</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>variable_key</parameter></term>
<listitem>
<para>
The variable key.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns &true; if the entry exists, otherwise &false;
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>shm_get_var</function></member>
<member><function>shm_put_var</function></member>
</simplelist>
</para>
</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:"../../../../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
-->

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.11 $ -->
<!-- $Revision: 1.12 $ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.shm-put-var">
<refnamediv>
<refname>shm_put_var</refname>
@ -68,6 +68,16 @@
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>shm_get_var</function></member>
<member><function>shm_has_var</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file