From 11786ff10be85f26bd690e1f9467395e43623ed1 Mon Sep 17 00:00:00 2001 From: Emiel Bruijntjes Date: Sat, 10 Mar 2018 14:55:23 +0100 Subject: [PATCH] update docblock in boostasio class to warn users about the possible low quality of the code --- include/amqpcpp/libboostasio.h | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/include/amqpcpp/libboostasio.h b/include/amqpcpp/libboostasio.h index acdf538..613ff73 100644 --- a/include/amqpcpp/libboostasio.h +++ b/include/amqpcpp/libboostasio.h @@ -1,15 +1,20 @@ /** * LibBoostAsio.h * - * Implementation for the AMQP::TcpHandler that is optimized for boost::asio. You can - * use this class instead of a AMQP::TcpHandler class, just pass the boost asio service - * to the constructor and you're all set. See tests/libboostasio.cpp for example. + * Implementation for the AMQP::TcpHandler for boost::asio. You can use this class + * instead of a AMQP::TcpHandler class, just pass the boost asio service to the + * constructor and you're all set. See tests/libboostasio.cpp for example. + * + * Watch out: this class was not implemented or reviewed by the original author of + * AMQP-CPP. However, we do get a lot of questions and issues from users of this class, + * so we cannot guarantee its quality. If you run into such issues too, it might be + * better to implement your own handler that interact with boost. + * * * @author Gavin Smith - * - * */ + /** * Include guard */