From 6df80bd8ba0e3890c05f044142295cc239cf012a Mon Sep 17 00:00:00 2001
From: Hannes Magnusson <bjori@php.net>
Date: Thu, 3 Feb 2011 13:09:37 +0000
Subject: [PATCH] Document missing optional parameters (Are Pedersen)

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@307972 c90b9560-bf6c-de11-be94-00142212c4b1
---
 reference/amqp/amqpexchange/publish.xml | 96 ++++++++++++++++++++++++-
 1 file changed, 94 insertions(+), 2 deletions(-)

diff --git a/reference/amqp/amqpexchange/publish.xml b/reference/amqp/amqpexchange/publish.xml
index 0a5dbd088e..1caa08a1c9 100644
--- a/reference/amqp/amqpexchange/publish.xml
+++ b/reference/amqp/amqpexchange/publish.xml
@@ -13,13 +13,13 @@
    <modifier>public</modifier> <type>void</type><methodname>AMQPExchange::publish</methodname>
    <methodparam><type>string</type><parameter>message</parameter></methodparam>
    <methodparam><type>string</type><parameter>routing_key</parameter></methodparam>
+   <methodparam choice="opt"><type>int</type><parameter>params</parameter><initializer>0</initializer></methodparam>
+   <methodparam choice="opt"><type>array</type><parameter>attributes</parameter></methodparam>
   </methodsynopsis>
   <para>
     Publish a message to the exchange represented by the <classname>AMQPExchange</classname> object.
   </para>
 
-  &warn.undocumented.func;
-
  </refsect1>
 
  <refsect1 role="parameters">
@@ -42,6 +42,91 @@
       </para>
      </listitem>
     </varlistentry>
+    <varlistentry>
+     <term><parameter>params</parameter></term>
+     <listitem>
+      <para>
+       One or more of <constant>AMQP_MANDATORY</constant> and
+       <constant>AMQP_MANDATORY</constant>.
+      </para>
+     </listitem>
+    </varlistentry>
+    <varlistentry>
+     <term><parameter></parameter></term>
+     <listitem>
+      <para>
+       <table>
+        <title>Supported indexes</title>
+        <tgroup cols="3">
+         <thead>
+          <row>
+           <entry>key</entry>
+           <entry>Description</entry>
+           <entry>Default value</entry>
+          </row>
+         </thead>
+         <tbody>
+          <row>
+           <entry><emphasis>Content-type</emphasis></entry>
+           <entry></entry>
+           <entry><literal>text/plain</literal></entry>
+          </row>
+          <row>
+           <entry><emphasis>Content-encoding</emphasis></entry>
+           <entry></entry>
+           <entry>NULL</entry>
+          </row>
+          <row>
+           <entry><emphasis>message_id</emphasis></entry>
+           <entry></entry>
+           <entry>NULL</entry>
+          </row>
+          <row>
+           <entry><emphasis>user_id</emphasis></entry>
+           <entry></entry>
+           <entry>NULL</entry>
+          </row>
+          <row>
+           <entry><emphasis>app_id</emphasis></entry>
+           <entry></entry>
+           <entry>NULL</entry>
+          </row>
+          <row>
+           <entry><emphasis>delivery_mode</emphasis></entry>
+           <entry></entry>
+           <entry>NULL</entry>
+          </row>
+          <row>
+           <entry><emphasis>priority</emphasis></entry>
+           <entry></entry>
+           <entry>NULL</entry>
+          </row>
+          <row>
+           <entry><emphasis>timestamp</emphasis></entry>
+           <entry></entry>
+           <entry>NULL</entry>
+          </row>
+          <row>
+           <entry><emphasis>expiration</emphasis></entry>
+           <entry></entry>
+           <entry>NULL</entry>
+          </row>
+          <row>
+           <entry><emphasis>type</emphasis></entry>
+           <entry></entry>
+           <entry>NULL</entry>
+          </row>
+          <row>
+           <entry><emphasis>reply_to</emphasis></entry>
+           <entry></entry>
+           <entry>NULL</entry>
+          </row>
+         </tbody>
+        </tgroup>
+       </table>
+      </para>
+     </listitem>
+    </varlistentry>
    </variablelist>
   </para>
  </refsect1>
@@ -49,7 +134,14 @@
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
+   &return.success;
+  </para>
+ </refsect1>
 
+ <refsect1 role="errors">
+  &reftitle.errors;
+  <para>
+   Throws an <classname>AMQPExchangeException</classname> on failure.
   </para>
  </refsect1>