misc: Doxygen tweaks: fixed some typos and minor errors
Doxygen generates quite a lot of warnings on libosmocore. Some of them
are obvious typos - this patch aims to fix such low-hanging fruit.
diff --git a/src/bits.c b/src/bits.c
index f3453e5..6be6d7a 100644
--- a/src/bits.c
+++ b/src/bits.c
@@ -180,8 +180,8 @@
}
/*! \brief reverse bit-order of each byte in a buffer
- * \param buf buffer containing bytes to be bit-reversed
- * \param[in] length of buffer in bytes
+ * \param[in] buf buffer containing bytes to be bit-reversed
+ * \param[in] len length of buffer in bytes
*
* This function reverses the bits in each byte of the buffer
*/
diff --git a/src/bitvec.c b/src/bitvec.c
index 714c11b..8da5a48 100644
--- a/src/bitvec.c
+++ b/src/bitvec.c
@@ -132,7 +132,7 @@
/*! \brief set a bit at given position in a bit vector
* \param[in] bv bit vector on which to operate
- * \param[in] bitnum number of bit to be set
+ * \param[in] bitnr number of bit to be set
* \param[in] bit value to which the bit is to be set
*/
int bitvec_set_bit_pos(struct bitvec *bv, unsigned int bitnr,
diff --git a/src/conv.c b/src/conv.c
index ebc3eda..f13deef 100644
--- a/src/conv.c
+++ b/src/conv.c
@@ -27,7 +27,7 @@
*/
/*! \file conv.c
- * \file Osmocom convolutional encoder and decoder
+ * Osmocom convolutional encoder and decoder
*/
#include "config.h"
#ifdef HAVE_ALLOCA_H
diff --git a/src/crcXXgen.c.tpl b/src/crcXXgen.c.tpl
index 2a4bf21..7e45c11 100644
--- a/src/crcXXgen.c.tpl
+++ b/src/crcXXgen.c.tpl
@@ -27,7 +27,7 @@
*/
/*! \file crcXXgen.c
- * \file Osmocom generic CRC routines (for max XX bits poly)
+ * Osmocom generic CRC routines (for max XX bits poly)
*/
#include <stdint.h>
diff --git a/src/gsm/auth_core.c b/src/gsm/auth_core.c
index 5cf8dfc..3a0866b 100644
--- a/src/gsm/auth_core.c
+++ b/src/gsm/auth_core.c
@@ -93,7 +93,7 @@
/*! \brief Generate authentication vector
* \param[out] vec Generated authentication vector
* \param[in] aud Subscriber-specific key material
- * \param[in] rand Random challenge to be used
+ * \param[in] _rand Random challenge to be used
*
* This function performs the core cryptographic function of the AUC,
* computing authentication triples/quintuples based on the permanent
@@ -125,7 +125,7 @@
* \param[in] aud Subscriber-specific key material
* \param[in] rand_auts RAND value sent by the SIM/MS
* \param[in] auts AUTS value sent by the SIM/MS
- * \param[in] rand Random challenge to be used to generate vector
+ * \param[in] _rand Random challenge to be used to generate vector
*
* This function performs a special variant of the core cryptographic
* function of the AUC: computing authentication triples/quintuples
diff --git a/src/gsm/lapd_core.c b/src/gsm/lapd_core.c
index 0dc78eb..b33cf6e 100644
--- a/src/gsm/lapd_core.c
+++ b/src/gsm/lapd_core.c
@@ -25,7 +25,7 @@
* @{
*/
-/*! \file lapd.c */
+/*! \file lapd_core.c */
/*!
* Notes on Buffering: rcv_buffer, tx_queue, tx_hist, send_buffer, send_queue
@@ -2167,3 +2167,4 @@
return rc;
}
+/*! @} */
diff --git a/src/gsm/tlv_parser.c b/src/gsm/tlv_parser.c
index d18a6bf..8cb2139 100644
--- a/src/gsm/tlv_parser.c
+++ b/src/gsm/tlv_parser.c
@@ -6,7 +6,7 @@
/*! \addtogroup tlv
* @{
*/
-/*! \file tlv.c */
+/*! \file tlv_parser.c */
struct tlv_definition tvlv_att_def;
struct tlv_definition vtvlv_gan_att_def;
diff --git a/src/gsmtap_util.c b/src/gsmtap_util.c
index 77ab0c6..82690a9 100644
--- a/src/gsmtap_util.c
+++ b/src/gsmtap_util.c
@@ -49,7 +49,7 @@
/*! \brief convert RSL channel number to GSMTAP channel type
- * \param[in] rsl_cantype RSL channel type
+ * \param[in] rsl_chantype RSL channel type
* \param[in] link_id RSL link identifier
* \returns GSMTAP channel type
*/
@@ -216,7 +216,7 @@
/*! \brief Send a \ref msgb through a GSMTAP source
* \param[in] gti GSMTAP instance
- * \param[in] msgb message buffer
+ * \param[in] msg message buffer
*/
int gsmtap_sendmsg(struct gsmtap_inst *gti, struct msgb *msg)
{
@@ -339,7 +339,7 @@
/*! \brief Open GSMTAP source socket, connect and register osmo_fd
* \param[in] host host name or IP address in string format
* \param[in] port UDP port number in host byte order
- * \param[in] osmo_wq_mode Register \ref osmo_wqueue (1) or not (0)
+ * \param[in] ofd_wq_mode Register \ref osmo_wqueue (1) or not (0)
*
* Open GSMTAP source (sending) socket, connect it to host/port,
* allocate 'struct gsmtap_inst' and optionally osmo_fd/osmo_wqueue
diff --git a/src/msgb.c b/src/msgb.c
index c8564db..359a545 100644
--- a/src/msgb.c
+++ b/src/msgb.c
@@ -74,7 +74,7 @@
/*! \brief Enqueue message buffer to tail of a queue
* \param[in] queue linked list header of queue
- * \param[in] msgb message buffer to be added to the queue
+ * \param[in] msg message buffer to be added to the queue
*
* The function will append the specified message buffer \a msg to the
* queue implemented by \ref llist_head \a queue
@@ -89,7 +89,7 @@
* \returns message buffer (if any) or NULL if queue empty
*
* The function will remove the first message buffer from the queue
- * implemented by 'ref llist_head \a queue.
+ * implemented by \ref llist_head \a queue.
*/
struct msgb *msgb_dequeue(struct llist_head *queue)
{
@@ -105,7 +105,7 @@
}
/*! \brief Re-set all message buffer pointers
- * \param[in] m message buffer that is to be resetted
+ * \param[in] msg message buffer that is to be resetted
*
* This will re-set the various internal pointers into the underlying
* message buffer, i.e. remvoe all headroom and treat the msgb as
diff --git a/src/serial.c b/src/serial.c
index a025ae9..66ee756 100644
--- a/src/serial.c
+++ b/src/serial.c
@@ -27,7 +27,7 @@
*/
/*! \file serial.c
- * \file Osmocom serial port helpers
+ * Osmocom serial port helpers
*/
#include <errno.h>
diff --git a/src/socket.c b/src/socket.c
index a5530d0..6ff00f0 100644
--- a/src/socket.c
+++ b/src/socket.c
@@ -129,7 +129,7 @@
}
/*! \brief Initialize a socket and fill \ref osmo_fd
- * \param[out] osmocom file descriptor (will be filled in)
+ * \param[out] ofd file descriptor (will be filled in)
* \param[in] family Address Family like AF_INET, AF_INET6, AF_UNSPEC
* \param[in] type Socket type like SOCK_DGRAM, SOCK_STREAM
* \param[in] proto Protocol like IPPROTO_TCP, IPPROTO_UDP
diff --git a/src/timer.c b/src/timer.c
index 98cbf6e..5988aef 100644
--- a/src/timer.c
+++ b/src/timer.c
@@ -128,7 +128,7 @@
/*! \brief compute the remaining time of a timer
* \param[in] timer the to-be-checked timer
- * \param[in] the current time (NULL if not known)
+ * \param[in] now the current time (NULL if not known)
* \param[out] remaining remaining time until timer fires
* \return 0 if timer has not expired yet, -1 if it has
*