doc: fsm timer_cb: explain return value
Change-Id: Ic6fbe95737862ed8b8de78058989c8b2ae330006
diff --git a/include/osmocom/core/fsm.h b/include/osmocom/core/fsm.h
index 9b6072d..fba5497 100644
--- a/include/osmocom/core/fsm.h
+++ b/include/osmocom/core/fsm.h
@@ -64,7 +64,8 @@
void (*allstate_action)(struct osmo_fsm_inst *fi, uint32_t event, void *data);
/*! \breif clean-up function, called during termination */
void (*cleanup)(struct osmo_fsm_inst *fi, enum osmo_fsm_term_cause cause);
- /*! \brief timer call-back for states with time-out */
+ /*! \brief timer call-back for states with time-out.
+ * \returns 1 to request termination, 0 to keep running. */
int (*timer_cb)(struct osmo_fsm_inst *fi);
/*! \brief logging sub-system for this FSM */
int log_subsys;