Change in libosmocore[master]: src/msgb.c: fix Doxygen documentation for msgb_printf()

Vadim Yanitskiy gerrit-no-reply at lists.osmocom.org
Mon Mar 25 17:28:21 UTC 2019


Vadim Yanitskiy has uploaded this change for review. ( https://gerrit.osmocom.org/13407


Change subject: src/msgb.c: fix Doxygen documentation for msgb_printf()
......................................................................

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
---
M src/msgb.c
1 file changed, 3 insertions(+), 2 deletions(-)



  git pull ssh://gerrit.osmocom.org:29418/libosmocore refs/changes/07/13407/1

diff --git a/src/msgb.c b/src/msgb.c
index 3902f6e..ce7654a 100644
--- a/src/msgb.c
+++ b/src/msgb.c
@@ -476,8 +476,9 @@
 
 
 /*! 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

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

Gerrit-Project: libosmocore
Gerrit-Branch: master
Gerrit-MessageType: newchange
Gerrit-Change-Id: Ib708664336eef06f748d408ae02a13c754b6647a
Gerrit-Change-Number: 13407
Gerrit-PatchSet: 1
Gerrit-Owner: Vadim Yanitskiy <axilirator at gmail.com>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.osmocom.org/pipermail/gerrit-log/attachments/20190325/61f0e5d3/attachment.html>


More information about the gerrit-log mailing list