From c80d0e5c8ec607dd4e10e28a07a22ac765dbb9b6 Mon Sep 17 00:00:00 2001 From: Marty Kraimer Date: Tue, 30 Nov 2004 13:37:17 +0000 Subject: [PATCH] add comments --- src/db/dbNotify.h | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/src/db/dbNotify.h b/src/db/dbNotify.h index 79b431635..9cc37a784 100644 --- a/src/db/dbNotify.h +++ b/src/db/dbNotify.h @@ -87,7 +87,12 @@ epicsShareFunc int epicsShareAPI dbNotifyDump(void); * and all records processed because of that record complete processing. * For asynchronous records completion means completion of the asyn phase. * - * User code calls dbPutNotify and dbNotifyCancel. + * User code calls putNotifyInit, putNotifyCleanup, + * dbPutNotify, and dbNotifyCancel. + * + * The use must allocate storage for "struct putNotify" + * putNotifyInit must be called before the first call to dbPutNotify + * and putNotifyCleanup must be called when the user is done with putNotify. * * After dbPutNotify is called it may not called for the same putNotify * until the putCallback is complete. The use can call dbNotifyCancel