svn: /phpdoc/en/trunk/reference/amqp/ amqpexchange/bind.xml amqpqueue/ack.xml amqpqueue/construct.xml amqpqueue/declare.xml

pdezwart Wed, 30 Jun 2010 00:58:26 +0000 Revision: http://svn.php.net/viewvc?view=revision&revision=300868 Log: Documenting AMQPQueue::bind and AMQP::ack. Cleaning up definitions. Changed paths: U phpdoc/en/trunk/reference/amqp/amqpexchange/bind.xml U phpdoc/en/trunk/reference/amqp/amqpqueue/ack.xml U phpdoc/en/trunk/reference/amqp/amqpqueue/construct.xml U phpdoc/en/trunk/reference/amqp/amqpqueue/declare.xml Modified: phpdoc/en/trunk/reference/amqp/amqpexchange/bind.xml =================================================================== --- phpdoc/en/trunk/reference/amqp/amqpexchange/bind.xml 2010-06-30 00:25:51 UTC (rev 300867) +++ phpdoc/en/trunk/reference/amqp/amqpexchange/bind.xml 2010-06-30 00:58:26 UTC (rev 300868) @@ -12,14 +12,11 @@ <methodsynopsis> <modifier>public</modifier> <type>void</type><methodname>AMQPExchange::bind</methodname> <methodparam><type>string</type><parameter>queue_name</parameter></methodparam> - <methodparam choice="opt"><type>string</type><parameter>routing_key</parameter><initializer>""</initializer></methodparam> + <methodparam><type>string</type><parameter>routing_key</parameter></methodparam> </methodsynopsis> <para> - + Bind an exchange to a queue using the specified routing key. </para> - - &warn.undocumented.func; - </refsect1> <refsect1 role="parameters"> Modified: phpdoc/en/trunk/reference/amqp/amqpqueue/ack.xml =================================================================== --- phpdoc/en/trunk/reference/amqp/amqpqueue/ack.xml 2010-06-30 00:25:51 UTC (rev 300867) +++ phpdoc/en/trunk/reference/amqp/amqpqueue/ack.xml 2010-06-30 00:58:26 UTC (rev 300868) @@ -11,16 +11,13 @@ &reftitle.description; <methodsynopsis> <modifier>public</modifier> <type>void</type><methodname>AMQPQueue::ack</methodname> - <methodparam><type>string</type><parameter>exchange_name</parameter></methodparam> - <methodparam choice="opt"><type>string</type><parameter>routing_key</parameter><initializer>""</initializer></methodparam> + <methodparam><type>int</type><parameter>delivery_tag</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>NULL</initializer></methodparam> </methodsynopsis> <para> This method allows the acknowledgement of a message that is retrieved with the <constant>AMQP_NOACK</constant> flag through <methodname>AMQPQueue::get</methodname> or <methodname>AMQPQueue::consume</methodname> </para> - - &warn.undocumented.func; - </refsect1> <refsect1 role="parameters"> @@ -35,6 +32,14 @@ </para> </listitem> </varlistentry> + <varlistentry> + <term><parameter>flags</parameter></term> + <listitem> + <para> + The only valid flag that can be passed is <constant>AMQP_MULTIPLE</constant>. + </para> + </listitem> + </varlistentry> </variablelist> </para> </refsect1> Modified: phpdoc/en/trunk/reference/amqp/amqpqueue/construct.xml =================================================================== --- phpdoc/en/trunk/reference/amqp/amqpqueue/construct.xml 2010-06-30 00:25:51 UTC (rev 300867) +++ phpdoc/en/trunk/reference/amqp/amqpqueue/construct.xml 2010-06-30 00:58:26 UTC (rev 300868) @@ -15,11 +15,8 @@ <methodparam choice="opt"><type>string</type><parameter>queue_name</parameter><initializer>""</initializer></methodparam> </methodsynopsis> <para> - + Creates an <classname>AMQPQueue</classname> instance representing an AMQP queue on the broker. </para> - - &warn.undocumented.func; - </refsect1> <refsect1 role="parameters"> @@ -38,7 +35,7 @@ <term><parameter>queue_name</parameter></term> <listitem> <para> - The name of the queue to construct. + The name of the queue to construct. If no queue name is specified, the broker will generate one. </para> </listitem> </varlistentry> Modified: phpdoc/en/trunk/reference/amqp/amqpqueue/declare.xml =================================================================== --- phpdoc/en/trunk/reference/amqp/amqpqueue/declare.xml 2010-06-30 00:25:51 UTC (rev 300867) +++ phpdoc/en/trunk/reference/amqp/amqpqueue/declare.xml 2010-06-30 00:58:26 UTC (rev 300868) @@ -12,10 +12,10 @@ <methodsynopsis> <modifier>public</modifier> <type>void</type><methodname>AMQPQueue::declare</methodname> <methodparam><type>string</type><parameter>queue_name</parameter></methodparam> - <methodparam choice="opt"><type>string</type><parameter>flags</parameter><initializer>NULL</initializer></methodparam> + <methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer><constant>AMQP_AUTODELETE</constant></initializer></methodparam> </methodsynopsis> <para> - Declare a new queue. + Declare a new queue on the broker. </para> </refsect1> @@ -35,7 +35,7 @@ <term><parameter>flags</parameter></term> <listitem> <para> - A bitmask of any of the flags: <constant>AMQP_NOACK</constant>. + A bitmask of any of the flags: <constant>AMQP_AUTODELETE</constant>, <constant>AMQP_PASSIVE</constant>, <constant>AMQP_DURABLE</constant>, <constant>AMQP_NOACK</constant>. </para> </listitem> </varlistentry>