diff --git a/documentation/Makefile.headers b/documentation/Makefile.headers index bc14cf525..136a6dffc 100644 --- a/documentation/Makefile.headers +++ b/documentation/Makefile.headers @@ -83,6 +83,7 @@ database_HEADERS += dbUnitTest database_HEADERS += devSup database_HEADERS += drvSup database_HEADERS += initHooks +database_HEADERS += iocInit record_HEADERS += aaiRecord record_HEADERS += aaoRecord diff --git a/modules/database/src/ioc/misc/iocInit.h b/modules/database/src/ioc/misc/iocInit.h index 1acd8ee8f..7c9048428 100644 --- a/modules/database/src/ioc/misc/iocInit.h +++ b/modules/database/src/ioc/misc/iocInit.h @@ -7,7 +7,8 @@ * EPICS BASE is distributed subject to a Software License Agreement found * in file LICENSE that is included with this distribution. \*************************************************************************/ -/* iocInit.h ioc initialization */ +/** @file iocInit.h + * @brief ioc initialization */ #ifndef INCiocInith #define INCiocInith @@ -22,15 +23,30 @@ enum iocStateEnum { extern "C" { #endif -/** Query present IOC run state +/** Query the present IOC run state * @since 3.15.8 */ DBCORE_API enum iocStateEnum getIocState(void); + +/** @brief Initalizes the IOC in two distinct parts - iocBuild and iocRun + */ DBCORE_API int iocInit(void); + +/** @brief Puts the IOC into a quiescent state without allowing the various internal threads it starts to actually run */ DBCORE_API int iocBuild(void); +/** @brief Allows to start an IOC without its Channel Access parts. It can then be shutdown cleanly using iocShutdown. + * Feature only intended to be used for test programs, not production IOCs. */ DBCORE_API int iocBuildIsolated(void); +/** @brief Brings the IOC online after iocBuild or iocPause*/ DBCORE_API int iocRun(void); + +/** @brief Freezes all internal operations + * + * the iocRun command can restart it from where it left off or the ioc can be shut down. Pausing may not always be safe as not all drivers and device support may have been written with the possibility of pausing an IOC in mind. + */ DBCORE_API int iocPause(void); + +/** @brief Exits the program, shutsdown the IOC */ DBCORE_API int iocShutdown(void); #ifdef __cplusplus