From 74a81de4b7710ca3919b384251c684d0db30fd64 Mon Sep 17 00:00:00 2001
From: Nick Berard <nicobn@php.net>
Date: Tue, 3 Jul 2007 19:53:55 +0000
Subject: [PATCH] Documented the functions' socket parameter and corrected an
 error from previous commit.

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@239126 c90b9560-bf6c-de11-be94-00142212c4b1
---
 reference/sockets/functions/socket-get-option.xml  | 5 +++--
 reference/sockets/functions/socket-getpeername.xml | 4 +++-
 reference/sockets/functions/socket-getsockname.xml | 4 +++-
 reference/sockets/functions/socket-last-error.xml  | 3 ++-
 reference/sockets/functions/socket-listen.xml      | 3 ++-
 5 files changed, 13 insertions(+), 6 deletions(-)

diff --git a/reference/sockets/functions/socket-get-option.xml b/reference/sockets/functions/socket-get-option.xml
index 68466afa5a..6b9ae51ca7 100644
--- a/reference/sockets/functions/socket-get-option.xml
+++ b/reference/sockets/functions/socket-get-option.xml
@@ -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.socket-get-option">
  <refnamediv>
   <refname>socket_get_option</refname>
@@ -29,7 +29,8 @@
      <term><parameter>socket</parameter></term>
      <listitem>
       <para>
-       A valid socket resource created with <function>socket_create</function>.
+       A valid socket resource created with <function>socket_create</function>
+       or <function>socket_accept</function>.
       </para>
      </listitem>
     </varlistentry>
diff --git a/reference/sockets/functions/socket-getpeername.xml b/reference/sockets/functions/socket-getpeername.xml
index 078d28cf9f..e8bba9f94b 100644
--- a/reference/sockets/functions/socket-getpeername.xml
+++ b/reference/sockets/functions/socket-getpeername.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.13 $ -->
+<!-- $Revision: 1.14 $ -->
 <refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.socket-getpeername">
  <refnamediv>
   <refname>socket_getpeername</refname>
@@ -28,6 +28,8 @@
      <term><parameter>socket</parameter></term>
      <listitem>
       <para>
+       A valid socket resource created with <function>socket_create</function>
+       or <function>socket_accept</function>.
       </para>
      </listitem>
     </varlistentry>
diff --git a/reference/sockets/functions/socket-getsockname.xml b/reference/sockets/functions/socket-getsockname.xml
index 299e37de9c..4303648410 100644
--- a/reference/sockets/functions/socket-getsockname.xml
+++ b/reference/sockets/functions/socket-getsockname.xml
@@ -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.socket-getsockname">
  <refnamediv>
   <refname>socket_getsockname</refname>
@@ -33,6 +33,8 @@
      <term><parameter>socket</parameter></term>
      <listitem>
       <para>
+       A valid socket resource created with <function>socket_create</function> 
+       or <function>socket_accept</function>.
       </para>
      </listitem>
     </varlistentry>
diff --git a/reference/sockets/functions/socket-last-error.xml b/reference/sockets/functions/socket-last-error.xml
index a4fffa8685..b3a2396c59 100644
--- a/reference/sockets/functions/socket-last-error.xml
+++ b/reference/sockets/functions/socket-last-error.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.10 $ -->
+<!-- $Revision: 1.11 $ -->
 <refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.socket-last-error">
  <refnamediv>
   <refname>socket_last_error</refname>
@@ -43,6 +43,7 @@ if (false == ($socket = @socket_create(AF_INET, SOCK_STREAM, SOL_TCP))) {
      <term><parameter>socket</parameter></term>
      <listitem>
       <para>
+       A valid socket resource created with <function>socket_create</function>.
       </para>
      </listitem>
     </varlistentry>
diff --git a/reference/sockets/functions/socket-listen.xml b/reference/sockets/functions/socket-listen.xml
index 73f1831c12..164c48cac6 100644
--- a/reference/sockets/functions/socket-listen.xml
+++ b/reference/sockets/functions/socket-listen.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.socket-listen">
  <refnamediv>
   <refname>socket_listen</refname>
@@ -34,6 +34,7 @@
      <term><parameter>socket</parameter></term>
      <listitem>
       <para>
+       A valid socket resource created with <function>socket_create</function>.
       </para>
      </listitem>
     </varlistentry>