From cb75bf73c78b68fa0fc47d36c401447c878459c3 Mon Sep 17 00:00:00 2001 From: Michael Davidsaver Date: Fri, 3 Jul 2026 12:37:32 -0700 Subject: [PATCH] doc --- .../src/ioc/registry/registryFunction.h | 6 ++++++ modules/libcom/src/misc/epicsExport.h | 19 +++++++++++++------ 2 files changed, 19 insertions(+), 6 deletions(-) diff --git a/modules/database/src/ioc/registry/registryFunction.h b/modules/database/src/ioc/registry/registryFunction.h index baa6d5080..5c6b97018 100644 --- a/modules/database/src/ioc/registry/registryFunction.h +++ b/modules/database/src/ioc/registry/registryFunction.h @@ -25,6 +25,12 @@ typedef struct registryFunctionRef { } registryFunctionRef; +/** @brief Add named function to global registry + * + * Most users will prefer epicsRegisterFunction() + * + * @return 1 on success, 0 on error + */ DBCORE_API int registryFunctionAdd( const char *name, REGISTRYFUNCTION func); DBCORE_API REGISTRYFUNCTION registryFunctionFind( diff --git a/modules/libcom/src/misc/epicsExport.h b/modules/libcom/src/misc/epicsExport.h index 356d62b39..52825ab30 100644 --- a/modules/libcom/src/misc/epicsExport.h +++ b/modules/libcom/src/misc/epicsExport.h @@ -116,12 +116,19 @@ typedef void (*REGISTRAR)(void); * * The epicsRegisterFunction() macro must be used to declare and register * a function that is named in a DBD \c function statement and called by - * one or more subroutine or aSub records. For example: - \code - epicsRegisterFunction(mySubInit); - epicsRegisterFunction(mySubProcess); - \endcode -* + * one or more subroutine or aSub records. For example in C code: + * \code{.c} + * epicsRegisterFunction(mySubInit); + * epicsRegisterFunction(mySubProcess); + * \endcode + * + * Place matching entries in a DBD file. + * + * \code{.dbd} + * registrar(mySubInit) + * registrar(mySubProcess) + * \endcode + * * \param fun Function's name */ #ifdef __cplusplus