diff --git a/modules/libcom/src/osi/epicsStackTrace.h b/modules/libcom/src/osi/epicsStackTrace.h index b0dfb0f1a..931477994 100644 --- a/modules/libcom/src/osi/epicsStackTrace.h +++ b/modules/libcom/src/osi/epicsStackTrace.h @@ -8,6 +8,11 @@ * Author: Till Straumann , 2011, 2014 */ +/** + * \file epicsStackTrace.h + * + * Functions for printing the stack trace + */ #ifndef INC_epicsStackTrace_H #define INC_epicsStackTrace_H @@ -17,24 +22,34 @@ extern "C" { #endif -/* Dump a stack trace to the errlog */ +/** \brief Dump a stack trace + * + * Dump a stack trace to the errlog. + */ LIBCOM_API void epicsStackTrace(void); /* Inquire about functionality implemented on your system */ -/* StackTrace provides numerical addresses */ +/** Bit mask to check if stack trace provides numerical addresses.*/ #define EPICS_STACKTRACE_ADDRESSES (1<<0) -/* StackTrace is able to lookup dynamic symbols */ +/** Bit mask to check if stack trace is able to lookup dynamic symbols.*/ #define EPICS_STACKTRACE_DYN_SYMBOLS (1<<1) -/* StackTrace is able to lookup global symbols */ +/** Bit mask to check if stack trace is able to lookup global symbols */ #define EPICS_STACKTRACE_GBL_SYMBOLS (1<<2) -/* StackTrace is able to lookup local symbols */ +/** Bit mask to check if stack trace is able to lookup local symbols */ #define EPICS_STACKTRACE_LCL_SYMBOLS (1<<3) -/* returns ORed bitset of supported features */ +/** \brief Get supported stacktrace features + * + * Returns an ORed bitset of supported features. Use the EPICS_STACKTRACE_ masks to + * check if a feature is supported. + * + * \return 0 if getting the stack trace is unsupported. Otherwise + * returns an ORed bitset of supported features. + */ LIBCOM_API int epicsStackTraceGetFeatures(void); #ifdef __cplusplus