diff options
| author | Harald Welte <laforge@gnumonks.org> | 2011-08-17 16:19:46 +0200 |
|---|---|---|
| committer | Harald Welte <laforge@gnumonks.org> | 2011-08-17 17:14:12 +0200 |
| commit | af8e4352b5880a20cfdaf89303a71e222ab8badd (patch) | |
| tree | b1933332f6e4bca60057262404a1aaea855882e6 /include | |
| parent | eee3790d246600c9145f9b972e67ebfded8fde98 (diff) | |
doxygen: Add documentation to signal.[ch]
Diffstat (limited to 'include')
| -rw-r--r-- | include/osmocom/core/signal.h | 12 |
1 files changed, 10 insertions, 2 deletions
diff --git a/include/osmocom/core/signal.h b/include/osmocom/core/signal.h index 2442e510..097aa193 100644 --- a/include/osmocom/core/signal.h +++ b/include/osmocom/core/signal.h @@ -3,13 +3,18 @@ #include <stdint.h> +/*! \defgroup signal Intra-application signals + * @{ + */ +/*! \file signal.h */ + /* subsystem signaling numbers: we split the numberspace for applications and * libraries: from 0 to UINT_MAX/2 for applications, from UINT_MAX/2 to * UINT_MAX for libraries. */ #define OSMO_SIGNAL_SS_APPS 0 #define OSMO_SIGNAL_SS_RESERVED 2147483648 -/* signal subsystems. */ +/*! \brief signal subsystems */ enum { SS_L_GLOBAL = OSMO_SIGNAL_SS_RESERVED, SS_L_INPUT, @@ -19,11 +24,12 @@ enum { #define OSMO_SIGNAL_T_APPS 0 #define OSMO_SIGNAL_T_RESERVED 2147483648 -/* signal types. */ +/*! \brief signal types. */ enum { S_L_GLOBAL_SHUTDOWN = OSMO_SIGNAL_T_RESERVED, }; +/*! signal callback function type */ typedef int osmo_signal_cbfn(unsigned int subsys, unsigned int signal, void *handler_data, void *signal_data); @@ -34,4 +40,6 @@ void osmo_signal_unregister_handler(unsigned int subsys, osmo_signal_cbfn *cbfn, /* Dispatch */ void osmo_signal_dispatch(unsigned int subsys, unsigned int signal, void *signal_data); +/*! }@ */ + #endif /* OSMO_SIGNAL_H */ |