osmocom
/
libosmocore
mirror of https://gerrit.osmocom.org/libosmocore
11
0
Fork 1
Code Issues Releases Wiki Activity

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
This commit is contained in:
Vadim Yanitskiy 2019-03-26 00:20:35 +07:00 committed by Harald Welte
parent b8d06fb6b3
commit 914a8ec5b3
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
include/osmocom/core/msgb.h
View File

@ -339,7 +339,7 @@ static inline unsigned char *msgb_push(struct msgb *msgb, unsigned int len)
}
/*! 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 @@ static inline void msgb_push_u8(struct msgb *msg, uint8_t word)
}
/*! 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 @@ static inline void msgb_push_u16(struct msgb *msg, uint16_t word)
}
/*! 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 @@ static inline unsigned char *msgb_pull(struct msgb *msgb, unsigned int len)
}
/*! 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 @@ static inline unsigned char *msgb_pull_to_l3(struct msgb *msg)
}
/*! 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