From 393ac727851e9d0e3ec0668f762e1c1962ddb510 Mon Sep 17 00:00:00 2001 From: Michael Davidsaver Date: Thu, 5 Oct 2017 15:33:48 +0200 Subject: [PATCH] minor doc --- src/client/pva/client.h | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/src/client/pva/client.h b/src/client/pva/client.h index 6cb578b..2c76ed2 100644 --- a/src/client/pva/client.h +++ b/src/client/pva/client.h @@ -311,11 +311,12 @@ public: /** Begin subscription w/o callbacks * - * @param event If not NULL, then subscription events are signaled to this epicsEvent. Test with poll(). - * Otherwise an internal epicsEvent is allocated for use with wait() + * @param event If not NULL, then subscription events are signaled to this epicsEvent. + * Use MonitorSync::test() to see if a subscription has an event waiting. + * Otherwise an internal epicsEvent is allocated for use with MonitorSync::wait() * - * @note For simple usage with a single MonitorSync, pass event=NULL and call wait(). - * If more than one MonitorSync is being created, then pass a custom epicsEvent and use test() to find + * @note For simple usage with a single MonitorSync, pass event=NULL and call MonitorSync::wait(). + * If more than one MonitorSync is being created, then pass a custom epicsEvent and use MonitorSync::test() to find * which subscriptions have events pending. */ MonitorSync monitor(const epics::pvData::PVStructure::const_shared_pointer& pvRequest = epics::pvData::PVStructure::const_shared_pointer(),