diff options
| author | Vadim Yanitskiy <axilirator@gmail.com> | 2019-03-25 23:59:11 +0700 |
|---|---|---|
| committer | Harald Welte <laforge@gnumonks.org> | 2019-03-27 08:56:21 +0100 |
| commit | b8d06fb6b397071a5c9f3a261aee8231cd594314 (patch) | |
| tree | de66a0c49c092ac1f8a51873ce629830f4797d76 | |
| parent | ba426e3b0c12486a6767000da77492fe50ba26ff (diff) | |
src/msgb.c: fix Doxygen documentation for msgb_printf()
This change fixes the following Doxygen warnings:
src/msgb.c:479: warning: argument 'msg' of command @param is not
found in the argument list of
msgb_printf(struct msgb *msgb, const char *format,...)
core/msgb.h:708: warning: The following parameters of
msgb_printf(struct msgb *msgb, const char *format,...)
are not documented:
parameter 'msgb'
parameter 'format'
As a bonus, it dot-terminates all sentences.
Change-Id: Ib708664336eef06f748d408ae02a13c754b6647a
| -rw-r--r-- | src/msgb.c | 5 |
1 files changed, 3 insertions, 2 deletions
@@ -476,8 +476,9 @@ const char *msgb_hexdump(const struct msgb *msg) /*! Print a string to the end of message buffer. - * \param[in] msg message buffer - * \returns 0 on success, -EINVAL on error + * \param[in] msgb message buffer. + * \param[in] format format string. + * \returns 0 on success, -EINVAL on error. * * The resulting string is printed to the msgb without a trailing nul * character. A nul following the data tail may be written as an implementation |