Change in libosmocore[master]: core/msgb.h: fix incorrect Doxygen parameter description

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/13408 )

Change subject: core/msgb.h: fix incorrect Doxygen parameter description
......................................................................

core/msgb.h: fix incorrect Doxygen parameter description

  core/msgb.h:414: warning: argument 'msgb' of command @param is not
                   found in the argument list of
                   msgb_pull_to_l2(struct msgb *msg)
  core/msgb.h:399: warning: argument 'msgb' of command @param is not
                   found in the argument list of
                   msgb_pull_to_l3(struct msgb *msg)

  core/msgb.h:351: warning: argument 'msgb' of command @param is not
                   found in the argument list of
                   msgb_push_u16(struct msgb *msg, uint16_t word)
  core/msgb.h:361: warning: argument 'msgb' of command @param is not
                   found in the argument list of
                   msgb_push_u32(struct msgb *msg, uint32_t word)
  core/msgb.h:341: warning: argument 'msgb' of command @param is not
                   found in the argument list of
                   msgb_push_u8(struct msgb *msg, uint8_t word)

Change-Id: I5d660933ecfa89c631319eccf9e3d5c1986ec8ff
---
M include/osmocom/core/msgb.h
1 file changed, 5 insertions(+), 5 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/include/osmocom/core/msgb.h b/include/osmocom/core/msgb.h
index 273fc16..5029225 100644
--- a/include/osmocom/core/msgb.h
+++ b/include/osmocom/core/msgb.h
@@ -339,7 +339,7 @@
 }
 
 /*! prepend a uint8 value to the head of the message
- *  \param[in] msgb message buffer
+ *  \param[in] msg message buffer
  *  \param[in] word unsigned 8bit byte to be prepended
  */
 static inline void msgb_push_u8(struct msgb *msg, uint8_t word)
@@ -349,7 +349,7 @@
 }
 
 /*! prepend a uint16 value to the head of the message
- *  \param[in] msgb message buffer
+ *  \param[in] msg message buffer
  *  \param[in] word unsigned 16bit byte to be prepended
  */
 static inline void msgb_push_u16(struct msgb *msg, uint16_t word)
@@ -359,7 +359,7 @@
 }
 
 /*! prepend a uint32 value to the head of the message
- *  \param[in] msgb message buffer
+ *  \param[in] msg message buffer
  *  \param[in] word unsigned 32bit byte to be prepended
  */
 static inline void msgb_push_u32(struct msgb *msg, uint32_t word)
@@ -396,7 +396,7 @@
 }
 
 /*! remove (pull) all headers in front of l3h from the message buffer.
- *  \param[in] msgb message buffer with a valid l3h
+ *  \param[in] msg message buffer with a valid l3h
  *  \returns pointer to new start of msgb (l3h)
  *
  * This function moves the \a data pointer of the \ref msgb further back
@@ -411,7 +411,7 @@
 }
 
 /*! remove (pull) all headers in front of l2h from the message buffer.
- *  \param[in] msgb message buffer with a valid l2h
+ *  \param[in] msg message buffer with a valid l2h
  *  \returns pointer to new start of msgb (l2h)
  *
  * This function moves the \a data pointer of the \ref msgb further back

-- 
To view, visit https://gerrit.osmocom.org/13408
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: I5d660933ecfa89c631319eccf9e3d5c1986ec8ff
Gerrit-Change-Number: 13408
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/68354a9c/attachment.html>


More information about the gerrit-log mailing list