Change in libosmocore[master]: Doxygen: fix documentation of osmo_timer_setup()

Harald Welte gerrit-no-reply at lists.osmocom.org
Wed Mar 27 09:51:56 UTC 2019


Harald Welte has submitted this change and it was merged. ( https://gerrit.osmocom.org/13411 )

Change subject: Doxygen: fix documentation of osmo_timer_setup()
......................................................................

Doxygen: fix documentation of osmo_timer_setup()

This change fixes the following Doxygen warnings:

  timer.c:69: warning: argument 'callback' of command @param is not
              found in the argument list of
              osmo_timer_setup(struct osmo_timer_list *timer,
                               void(*cb)(void *data), void *data)
  timer.c:69: warning: argument 'pointer' of command @param is not
              found in the argument list of
              osmo_timer_setup(struct osmo_timer_list *timer,
                               void(*cb)(void *data), void *data)
  core/timer.h:70: warning: The following parameters of
                   osmo_timer_setup(struct osmo_timer_list *timer,
                   void(*cb)(void *data), void *data)
                   are not documented:
                     parameter 'cb'
                     parameter 'data'

Change-Id: If5668f40a7bfde2f4f22329a071c8c6eff23b99e
---
M src/timer.c
1 file changed, 2 insertions(+), 2 deletions(-)

Approvals:
  Jenkins Builder: Verified
  Pau Espin Pedrol: Looks good to me, but someone else must approve
  Harald Welte: Looks good to me, approved



diff --git a/src/timer.c b/src/timer.c
index 02160a1..0b2e3dd 100644
--- a/src/timer.c
+++ b/src/timer.c
@@ -68,8 +68,8 @@
 
 /*! set up timer callback and data
  *  \param[in] timer the timer that should be added
- *  \param[in] callback function to be called when timer expires
- *  \param[in] pointer to data that passed to the callback function
+ *  \param[in] cb function to be called when timer expires
+ *  \param[in] data pointer to data that passed to the callback function
  */
 void osmo_timer_setup(struct osmo_timer_list *timer, void (*cb)(void *data),
 		      void *data)

-- 
To view, visit https://gerrit.osmocom.org/13411
To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings

Gerrit-Project: libosmocore
Gerrit-Branch: master
Gerrit-MessageType: merged
Gerrit-Change-Id: If5668f40a7bfde2f4f22329a071c8c6eff23b99e
Gerrit-Change-Number: 13411
Gerrit-PatchSet: 2
Gerrit-Owner: Vadim Yanitskiy <axilirator at gmail.com>
Gerrit-Reviewer: Harald Welte <laforge at gnumonks.org>
Gerrit-Reviewer: Jenkins Builder (1000002)
Gerrit-Reviewer: Pau Espin Pedrol <pespin at sysmocom.de>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.osmocom.org/pipermail/gerrit-log/attachments/20190327/4ac57add/attachment.html>


More information about the gerrit-log mailing list