[hornetq-commits] JBoss hornetq SVN: r7989 - trunk/docs/user-manual/en.

[do-not-reply at jboss.org]

Author: jmesnil
Date: 2009-09-24 11:50:40 -0400 (Thu, 24 Sep 2009)
New Revision: 7989

Modified:
   trunk/docs/user-manual/en/management.xml
Log:
documentation

* added section about removeMessages() filter. Setting it to an empty string
  means to select all messages

Modified: trunk/docs/user-manual/en/management.xml
===================================================================
--- trunk/docs/user-manual/en/management.xml	2009-09-24 11:47:36 UTC (rev 7988)
+++ trunk/docs/user-manual/en/management.xml	2009-09-24 15:50:40 UTC (rev 7989)
@@ -175,7 +175,9 @@
                   <para>Messages can also be removed from the queue by using the <literal
                         >removeMessages()</literal> method which returns a <literal
                         >boolean</literal> for the single message ID variant or the number of
-                     removed messages for the filter variant.</para>
+                     removed messages for the filter variant. The <literal>removeMessages()</literal>
+                     method takes a <literal>filter</literal> argument to remove only filtered messages. Setting
+                     the filter to an empty string will in effect remove all messages.</para>
                </listitem>
                <listitem>
                   <para>Counting messages</para>
@@ -396,7 +398,10 @@
                   <para>Messages can also be removed from the queue by using the <literal
                         >removeMessages()</literal> method which returns a <literal
                         >boolean</literal> for the single message ID variant or the number of
-                     removed messages for the filter variant.</para>
+                     removed messages for the filter variant.
+                      The <literal>removeMessages()</literal>
+                      method takes a <literal>filter</literal> argument to remove only filtered messages. Setting
+                      the filter to an empty string will in effect remove all messages.</para>
                </listitem>
                <listitem>
                   <para>Counting messages</para>