epics/epics-base
0
0
Fork 0
Code Issues Pull Requests Projects Wiki Activity

add doxygen comments for epicsStackTrace

Browse Source
This commit is contained in:
Elaine Chandler
2022-05-11 14:30:30 -05:00
committed by Andrew Johnson
parent 0fa3337404
commit 95fcf690ad
1 changed files with 21 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
modules/libcom/src/osi/epicsStackTrace.h
View File

@@ -8,6 +8,11 @@
* Author: Till Straumann <strauman@slac.stanford.edu>, 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