Deprecated enableQueueEvents() in the doxygen comments. Use setInt() instead.

git-svn-id: https://svn.apache.org/repos/asf/qpid/trunk@821003 13f79535-47bb-0310-9956-ffa450edef68

1 files changed, 15 insertions, 0 deletions

diff --git a/qpid/cpp/include/qpid/client/QueueOptions.h b/qpid/cpp/include/qpid/client/QueueOptions.h
index 9418cb092d..f8a4963f06 100644
--- a/qpid/cpp/include/qpid/client/QueueOptions.h
+++ b/qpid/cpp/include/qpid/client/QueueOptions.h
@@ -90,7 +90,22 @@ class QueueOptions: public framing::FieldTable
      * Turns on event generation for this queue (either enqueue only
      * or for enqueue and dequeue events); the events can then be
      * processed by a regsitered broker plugin.
+     *
+     * DEPRECATED
+     *
+     * This is confusing to anyone who sees only the function call
+     * and not the variable name / doxygen. Consider the following call:
+     *
+     * options.enableQueueEvents(false);
+     *
+     * It looks like it disables queue events, but what it really does is
+     * enable both enqueue and dequeue events.
+     *
+     * Use setInt() instead:
+     *
+     * options.setInt("qpid.queue_event_generation", 2);
      */
+
     QPID_CLIENT_EXTERN void enableQueueEvents(bool enqueueOnly);
 
     static QPID_CLIENT_EXTERN const std::string strMaxCountKey;