[MERGED] libosmocore[master]: fsm: doc: add missing file, line args; fix ws + tweak on one...

This is merely a historical archive of years 2008-2021, before the migration to mailman3.

A maintained and still updated list archive can be found at https://lists.osmocom.org/hyperkitty/list/gerrit-log@lists.osmocom.org/.

Harald Welte gerrit-no-reply at lists.osmocom.org
Sat Dec 24 17:11:53 UTC 2016


Harald Welte has submitted this change and it was merged.

Change subject: fsm: doc: add missing file, line args; fix ws + tweak on one line
......................................................................


fsm: doc: add missing file, line args; fix ws + tweak on one line

Change-Id: I6af0d43ab0082e45df676c1d69b26310b59a8031
---
M src/fsm.c
1 file changed, 7 insertions(+), 1 deletion(-)

Approvals:
  Harald Welte: Looks good to me, approved
  Jenkins Builder: Verified



diff --git a/src/fsm.c b/src/fsm.c
index 319c842..8675f75 100644
--- a/src/fsm.c
+++ b/src/fsm.c
@@ -317,6 +317,8 @@
  *  \param[in] new_state The new state into which we should change
  *  \param[in] timeout_secs Timeout in seconds (if !=0)
  *  \param[in] T Timer number (if \ref timeout_secs != 0)
+ *  \param[in] file Calling source file (from osmo_fsm_inst_state_chg macro)
+ *  \param[in] line Calling source line (from osmo_fsm_inst_state_chg macro)
  *  \returns 0 on success; negative on error
  */
 int _osmo_fsm_inst_state_chg(struct osmo_fsm_inst *fi, uint32_t new_state,
@@ -371,6 +373,8 @@
  *  \param[in] fi FSM instance
  *  \param[in] event Event to send to FSM instance
  *  \param[in] data Data to pass along with the event
+ *  \param[in] file Calling source file (from osmo_fsm_inst_dispatch macro)
+ *  \param[in] line Calling source line (from osmo_fsm_inst_dispatch macro)
  *  \returns 0 in case of success; negative on error
  */
 int _osmo_fsm_inst_dispatch(struct osmo_fsm_inst *fi, uint32_t event, void *data,
@@ -421,7 +425,9 @@
  *
  *  \param[in] fi FSM instance to be terminated
  *  \param[in] cause Cause / reason for termination
- *  \param[in] data Opaqueevent data to be passed to parent
+ *  \param[in] data Opaque event data to be passed with the parent term event
+ *  \param[in] file Calling source file (from osmo_fsm_inst_term macro)
+ *  \param[in] line Calling source line (from osmo_fsm_inst_term macro)
  */
 void _osmo_fsm_inst_term(struct osmo_fsm_inst *fi,
 			 enum osmo_fsm_term_cause cause, void *data,

-- 
To view, visit https://gerrit.osmocom.org/1493
To unsubscribe, visit https://gerrit.osmocom.org/settings

Gerrit-MessageType: merged
Gerrit-Change-Id: I6af0d43ab0082e45df676c1d69b26310b59a8031
Gerrit-PatchSet: 2
Gerrit-Project: libosmocore
Gerrit-Branch: master
Gerrit-Owner: Neels Hofmeyr <nhofmeyr at sysmocom.de>
Gerrit-Reviewer: Harald Welte <laforge at gnumonks.org>
Gerrit-Reviewer: Jenkins Builder



More information about the gerrit-log mailing list