From a276c333e54d19f809d1f3eb397debf0fe19169d Mon Sep 17 00:00:00 2001
From: Hartmut Holzgraefe <hholzgra@php.net>
Date: Fri, 14 Mar 2008 21:42:24 +0000
Subject: [PATCH] some parameter description additions

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@255091 c90b9560-bf6c-de11-be94-00142212c4b1
---
 reference/sem/functions/msg-get-queue.xml    | 5 +++--
 reference/sem/functions/msg-remove-queue.xml | 5 ++---
 reference/sem/functions/msg-set-queue.xml    | 3 ++-
 reference/sem/functions/msg-stat-queue.xml   | 3 ++-
 reference/sem/functions/sem-release.xml      | 4 +++-
 reference/sem/functions/sem-remove.xml       | 6 +++---
 reference/sem/functions/shm-attach.xml       | 3 ++-
 reference/sem/functions/shm-detach.xml       | 4 +++-
 reference/sem/functions/shm-put-var.xml      | 5 ++++-
 reference/sem/functions/shm-remove-var.xml   | 5 +++--
 reference/sem/functions/shm-remove.xml       | 5 +++--
 11 files changed, 30 insertions(+), 18 deletions(-)

diff --git a/reference/sem/functions/msg-get-queue.xml b/reference/sem/functions/msg-get-queue.xml
index 7c14c140d6..6809917bd0 100644
--- a/reference/sem/functions/msg-get-queue.xml
+++ b/reference/sem/functions/msg-get-queue.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.6 $ -->
+<!-- $Revision: 1.7 $ -->
 <refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.msg-get-queue">
  <refnamediv>
   <refname>msg_get_queue</refname>
@@ -33,6 +33,7 @@
      <term><parameter>key</parameter></term>
      <listitem>
       <para>
+       Message queue numeric ID
       </para>
      </listitem>
     </varlistentry>
@@ -52,7 +53,7 @@
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
-   Returns an id that can be used to access the System V message queue.
+   Returns a resource handle that can be used to access the System V message queue.
   </para>
  </refsect1>
 
diff --git a/reference/sem/functions/msg-remove-queue.xml b/reference/sem/functions/msg-remove-queue.xml
index 7961b06798..e5ab6234ea 100644
--- a/reference/sem/functions/msg-remove-queue.xml
+++ b/reference/sem/functions/msg-remove-queue.xml
@@ -1,13 +1,11 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.7 $ -->
+<!-- $Revision: 1.8 $ -->
 <refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.msg-remove-queue">
  <refnamediv>
   <refname>msg_remove_queue</refname>
   <refpurpose>Destroy a message queue</refpurpose>
  </refnamediv>
  
- <refsect1 role="description">
-  &reftitle.description;
   <methodsynopsis>
    <type>bool</type><methodname>msg_remove_queue</methodname>
    <methodparam><type>resource</type><parameter>queue</parameter></methodparam>
@@ -28,6 +26,7 @@
      <term><parameter>queue</parameter></term>
      <listitem>
       <para>
+       Message queue resource handle
       </para>
      </listitem>
     </varlistentry>
diff --git a/reference/sem/functions/msg-set-queue.xml b/reference/sem/functions/msg-set-queue.xml
index a5d0735acf..a0c8ab3d07 100644
--- a/reference/sem/functions/msg-set-queue.xml
+++ b/reference/sem/functions/msg-set-queue.xml
@@ -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.msg-set-queue">
  <refnamediv>
   <refname>msg_set_queue</refname>
@@ -35,6 +35,7 @@
      <term><parameter>queue</parameter></term>
      <listitem>
       <para>
+       Message queue resource handle
       </para>
      </listitem>
     </varlistentry>
diff --git a/reference/sem/functions/msg-stat-queue.xml b/reference/sem/functions/msg-stat-queue.xml
index 0e303954d6..a7f9e4686a 100644
--- a/reference/sem/functions/msg-stat-queue.xml
+++ b/reference/sem/functions/msg-stat-queue.xml
@@ -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.msg-stat-queue">
  <refnamediv>
   <refname>msg_stat_queue</refname>
@@ -28,6 +28,7 @@
      <term><parameter>queue</parameter></term>
      <listitem>
       <para>
+       Message queue resource handle
       </para>
      </listitem>
     </varlistentry>
diff --git a/reference/sem/functions/sem-release.xml b/reference/sem/functions/sem-release.xml
index 3640cd4b95..6cbee921be 100644
--- a/reference/sem/functions/sem-release.xml
+++ b/reference/sem/functions/sem-release.xml
@@ -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.sem-release">
  <refnamediv>
   <refname>sem_release</refname>
@@ -31,6 +31,8 @@
      <term><parameter>sem_identifier</parameter></term>
      <listitem>
       <para>
+       A Semaphore resource handle as returned by
+       <function>sem_get</function>.
       </para>
      </listitem>
     </varlistentry>
diff --git a/reference/sem/functions/sem-remove.xml b/reference/sem/functions/sem-remove.xml
index 37370da47a..ba3e0f30e0 100644
--- a/reference/sem/functions/sem-remove.xml
+++ b/reference/sem/functions/sem-remove.xml
@@ -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.sem-remove">
  <refnamediv>
   <refname>sem_remove</refname>
@@ -28,8 +28,8 @@
      <term><parameter>sem_identifier</parameter></term>
      <listitem>
       <para>
-       The semaphore identifier. Must have been created with
-       <function>sem_get</function>, otherwise a warning is generated.
+       A semaphore resource identifier as returned
+       by <function>sem_get</function>.
       </para>
      </listitem>
     </varlistentry>
diff --git a/reference/sem/functions/shm-attach.xml b/reference/sem/functions/shm-attach.xml
index d49dc2a2d9..2e7e09b5c8 100644
--- a/reference/sem/functions/shm-attach.xml
+++ b/reference/sem/functions/shm-attach.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.12 $ -->
+<!-- $Revision: 1.13 $ -->
 <refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.shm-attach">
  <refnamediv>
   <refname>shm_attach</refname>
@@ -38,6 +38,7 @@
      <term><parameter>key</parameter></term>
      <listitem>
       <para>
+       A numeric shared memory segment ID
       </para>
      </listitem>
     </varlistentry>
diff --git a/reference/sem/functions/shm-detach.xml b/reference/sem/functions/shm-detach.xml
index d961163271..93bc243256 100644
--- a/reference/sem/functions/shm-detach.xml
+++ b/reference/sem/functions/shm-detach.xml
@@ -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-detach">
  <refnamediv>
   <refname>shm_detach</refname>
@@ -28,6 +28,8 @@
      <term><parameter>shm_identifier</parameter></term>
      <listitem>
       <para>
+       Ein Shared Memory Reosourcehandle wie von
+       <function>shm_attach</function> geliefert.
       </para>
      </listitem>
     </varlistentry>
diff --git a/reference/sem/functions/shm-put-var.xml b/reference/sem/functions/shm-put-var.xml
index 449a14bd3e..d5796c3089 100644
--- a/reference/sem/functions/shm-put-var.xml
+++ b/reference/sem/functions/shm-put-var.xml
@@ -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-put-var">
  <refnamediv>
   <refname>shm_put_var</refname>
@@ -35,6 +35,8 @@
      <term><parameter>shm_identifier</parameter></term>
      <listitem>
       <para>
+       A shared memory resource handle as returned by
+       <function>shm_attach</function>
       </para>
      </listitem>
     </varlistentry>
@@ -42,6 +44,7 @@
      <term><parameter>variable_key</parameter></term>
      <listitem>
       <para>
+       The variable key.
       </para>
      </listitem>
     </varlistentry>
diff --git a/reference/sem/functions/shm-remove-var.xml b/reference/sem/functions/shm-remove-var.xml
index c8f409143d..3a5228223b 100644
--- a/reference/sem/functions/shm-remove-var.xml
+++ b/reference/sem/functions/shm-remove-var.xml
@@ -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-remove-var">
  <refnamediv>
   <refname>shm_remove_var</refname>
@@ -28,7 +28,8 @@
      <term><parameter>shm_identifier</parameter></term>
      <listitem>
       <para>
-       The shared memory identifier.
+       The shared memory identifier as returned by
+       <function>shm_attach</function>
       </para>
      </listitem>
     </varlistentry>
diff --git a/reference/sem/functions/shm-remove.xml b/reference/sem/functions/shm-remove.xml
index 984646159d..555298f321 100644
--- a/reference/sem/functions/shm-remove.xml
+++ b/reference/sem/functions/shm-remove.xml
@@ -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-remove">
  <refnamediv>
   <refname>shm_remove</refname>
@@ -26,7 +26,8 @@
      <term><parameter>shm_identifier</parameter></term>
      <listitem>
       <para>
-       The shared memory identifier.
+       The shared memory identifier as returned by
+       <function>shm_attach</function>
       </para>
      </listitem>
     </varlistentry>