From cb97d662a74b8de6d7265a0863edbf88d0486f28 Mon Sep 17 00:00:00 2001 From: Michael Davidsaver Date: Mon, 8 Aug 2022 17:11:03 -0700 Subject: [PATCH] doc --- modules/database/src/ioc/db/dbLink.h | 13 +++++++++++++ modules/libcom/src/iocsh/iocsh.h | 1 + 2 files changed, 14 insertions(+) diff --git a/modules/database/src/ioc/db/dbLink.h b/modules/database/src/ioc/db/dbLink.h index d1e454485..9b4e9a9f0 100644 --- a/modules/database/src/ioc/db/dbLink.h +++ b/modules/database/src/ioc/db/dbLink.h @@ -410,8 +410,21 @@ DBCORE_API long dbLoadLinkArray(struct link *, short dbrType, void *pbuffer, DBCORE_API long dbGetNelements(const struct link *plink, long *pnElements); DBCORE_API int dbIsLinkConnected(const struct link *plink); /* 0 or 1 */ DBCORE_API int dbGetLinkDBFtype(const struct link *plink); +/** \brief Fetch current value from link. + * \param dbrType Database DBR code + * \param pbuffer Destination buffer + * \param nRequest If !NULL. Caller initializes with number of elements requested, + * On success, set to number of elements written to pbuffer. + * \return 0 on success + * + * When called with `nRequest==NULL`, treated as a request for one (1) + * element. + * + * see lset::getValue + */ DBCORE_API long dbTryGetLink(struct link *, short dbrType, void *pbuffer, long *nRequest); +/** see dbTryGetLink() */ DBCORE_API long dbGetLink(struct link *, short dbrType, void *pbuffer, long *options, long *nRequest); DBCORE_API long dbGetControlLimits(const struct link *plink, double *low, diff --git a/modules/libcom/src/iocsh/iocsh.h b/modules/libcom/src/iocsh/iocsh.h index ef0d5c50d..2c8da0998 100644 --- a/modules/libcom/src/iocsh/iocsh.h +++ b/modules/libcom/src/iocsh/iocsh.h @@ -287,6 +287,7 @@ LIBCOM_API int epicsStdCall iocshRun(const char *cmd, const char* macros); * * @param err 0 - success (no op), !=0 - error * @return The err argument value. + * @since 7.0.3.1 */ LIBCOM_API int iocshSetError(int err);