doxygen: fix various typos in commands \param and \returns

Change-Id: If87cec3739449c6a54e24fb2cb81e746d8244da2
This commit is contained in:
Vadim Yanitskiy 2023-02-28 03:30:27 +07:00 committed by laforge
parent 2a0b121f48
commit 64277a0217
11 changed files with 14 additions and 14 deletions

View File

@ -44,7 +44,7 @@ static const struct osmo_ecu_ops *g_ecu_ops[_NUM_OSMO_ECU_CODECS];
/*! initialize an ECU instance for given codec. /*! initialize an ECU instance for given codec.
* \param[in] ctx talloc context from which to allocate * \param[in] ctx talloc context from which to allocate
* \parma[in] codec codec for which to initialize/create ECU */ * \param[in] codec codec for which to initialize/create ECU */
struct osmo_ecu_state *osmo_ecu_init(void *ctx, enum osmo_ecu_codec codec) struct osmo_ecu_state *osmo_ecu_init(void *ctx, enum osmo_ecu_codec codec)
{ {
if (codec >= ARRAY_SIZE(g_ecu_ops)) if (codec >= ARRAY_SIZE(g_ecu_ops))

View File

@ -74,7 +74,7 @@ static bool str_in_list(const char **list, const char *key)
* *
* Constraints: Keys up to a maximum length of 255 characters are supported. * Constraints: Keys up to a maximum length of 255 characters are supported.
* *
* \oaram[out] out caller-allocated array of pointers for the generated output * \param[out] out caller-allocated array of pointers for the generated output
* \param[in] out_len size of out (number of pointers) * \param[in] out_len size of out (number of pointers)
* \param[in] in input environment (NULL-terminated list of pointers like **environ) * \param[in] in input environment (NULL-terminated list of pointers like **environ)
* \param[in] whitelist whitelist of permitted keys in environment (like **environ) * \param[in] whitelist whitelist of permitted keys in environment (like **environ)
@ -131,7 +131,7 @@ int osmo_environment_filter(char **out, size_t out_len, char **in, const char **
* Constraints: If the same key exists in 'out' and 'in', duplicate keys are * Constraints: If the same key exists in 'out' and 'in', duplicate keys are
* generated. It is a simple append, without any duplicate checks. * generated. It is a simple append, without any duplicate checks.
* *
* \oaram[out] out caller-allocated array of pointers for the generated output * \param[out] out caller-allocated array of pointers for the generated output
* \param[in] out_len size of out (number of pointers) * \param[in] out_len size of out (number of pointers)
* \param[in] in input environment (NULL-terminated list of pointers like **environ) * \param[in] in input environment (NULL-terminated list of pointers like **environ)
* \returns number of entries filled in 'out'; negative on error */ * \returns number of entries filled in 'out'; negative on error */

View File

@ -54,7 +54,7 @@ static int osmo_mnl_fd_cb(struct osmo_fd *ofd, unsigned int what)
} }
/*! create an osmocom-wrapped limnl netlink socket. /*! create an osmocom-wrapped limnl netlink socket.
* \parma[in] ctx talloc context from which to allocate * \param[in] ctx talloc context from which to allocate
* \param[in] bus netlink socket bus ID (see NETLINK_* constants) * \param[in] bus netlink socket bus ID (see NETLINK_* constants)
* \param[in] groups groups of messages to bind/subscribe to * \param[in] groups groups of messages to bind/subscribe to
* \param[in] mnl_cb callback function called for each incoming message * \param[in] mnl_cb callback function called for each incoming message

View File

@ -96,7 +96,7 @@ int ctrl_parse_get_num(vector vline, int i, long *num)
/*! Send a CTRL command to all connections. /*! Send a CTRL command to all connections.
* \param[in] ctrl global control handle * \param[in] ctrl global control handle
* \param[in] cmd command to send to all connections in \ctrl * \param[in] cmd command to send to all connections in ctrl
* \returns number of times the command has been sent */ * \returns number of times the command has been sent */
int ctrl_cmd_send_to_all(struct ctrl_handle *ctrl, struct ctrl_cmd *cmd) int ctrl_cmd_send_to_all(struct ctrl_handle *ctrl, struct ctrl_cmd *cmd)
{ {
@ -1048,7 +1048,7 @@ struct ctrl_handle *ctrl_interface_setup2(void *data, uint16_t default_port, ctr
* This function is used by e.g. library code to install lookup helpers * This function is used by e.g. library code to install lookup helpers
* for additional nodes in the control interface. * for additional nodes in the control interface.
* \param[in] lookup The lookup helper function * \param[in] lookup The lookup helper function
* \retuns - on success; negative on error. * \returns - on success; negative on error.
*/ */
int ctrl_lookup_register(ctrl_cmd_lookup lookup) int ctrl_lookup_register(ctrl_cmd_lookup lookup)
{ {

View File

@ -532,7 +532,7 @@ static int gprs_ns_tx_simple(struct gprs_nsvc *nsvc, uint8_t pdu_type)
/*! Transmit a NS-RESET on a given NSVC /*! Transmit a NS-RESET on a given NSVC
* \param[in] nsvc NS-VC used for transmission * \param[in] nsvc NS-VC used for transmission
* \paam[in] cause Numeric NS cause value * \param[in] cause Numeric NS cause value
*/ */
int gprs_ns_tx_reset(struct gprs_nsvc *nsvc, uint8_t cause) int gprs_ns_tx_reset(struct gprs_nsvc *nsvc, uint8_t cause)
{ {

View File

@ -282,7 +282,7 @@ int ns2_tx_block_ack(struct gprs_ns2_vc *nsvc, uint16_t *nsvci)
/*! Transmit a NS-RESET on a given NS-VC. /*! Transmit a NS-RESET on a given NS-VC.
* \param[in] nsvc NS-VC used for transmission * \param[in] nsvc NS-VC used for transmission
* \paam[in] cause Numeric NS cause value * \param[in] cause Numeric NS cause value
* \returns 0 in case of success */ * \returns 0 in case of success */
int ns2_tx_reset(struct gprs_ns2_vc *nsvc, uint8_t cause) int ns2_tx_reset(struct gprs_ns2_vc *nsvc, uint8_t cause)
{ {

View File

@ -293,7 +293,7 @@ enum sms_alphabet gsm338_get_sms_alphabet(uint8_t dcs)
* \param[in] type GSM340_TYPE_* * \param[in] type GSM340_TYPE_*
* \param[in] plan Numbering Plan * \param[in] plan Numbering Plan
* \param[in] number string containing number * \param[in] number string containing number
* \reurns number of bytes of \a oa that have been used */ * \returns number of bytes of \a oa that have been used */
int gsm340_gen_oa(uint8_t *oa, unsigned int oa_len, uint8_t type, int gsm340_gen_oa(uint8_t *oa, unsigned int oa_len, uint8_t type,
uint8_t plan, const char *number) uint8_t plan, const char *number)
{ {
@ -348,7 +348,7 @@ int gsm411_push_rp_header(struct msgb *msg, uint8_t rp_msg_type,
* \param[in] proto Protocol * \param[in] proto Protocol
* \param[in] trans Transaction * \param[in] trans Transaction
* \param[in] msg_type Message Type * \param[in] msg_type Message Type
* \retrns 0 */ * \returns 0 */
int gsm411_push_cp_header(struct msgb *msg, uint8_t proto, uint8_t trans, int gsm411_push_cp_header(struct msgb *msg, uint8_t proto, uint8_t trans,
uint8_t msg_type) uint8_t msg_type)
{ {

View File

@ -369,7 +369,7 @@ int gsm48_encode_bearer_cap(struct msgb *msg, int lv_only,
/*! Decode TS 04.08 Call Control Capabilities IE (10.5.4.5a) /*! Decode TS 04.08 Call Control Capabilities IE (10.5.4.5a)
* \param[out] Caller-provided memory for decoded CC capabilities * \param[out] Caller-provided memory for decoded CC capabilities
* \param[in] lv Length-Value of IE * \param[in] lv Length-Value of IE
* \retursns 0 on success; negative on error */ * \returns 0 on success; negative on error */
int gsm48_decode_cccap(struct gsm_mncc_cccap *ccap, const uint8_t *lv) int gsm48_decode_cccap(struct gsm_mncc_cccap *ccap, const uint8_t *lv)
{ {
uint8_t in_len = lv[0]; uint8_t in_len = lv[0];

View File

@ -253,7 +253,7 @@ int lapdm_channel_init2(struct lapdm_channel *lc, enum lapdm_mode mode,
* \param[in] t200_ms_dcch per-SAPI array of T200 in milli-seconds for DCCH * \param[in] t200_ms_dcch per-SAPI array of T200 in milli-seconds for DCCH
* \param[in] t200_ms_acch per-SAPI array of T200 in milli-seconds for SACCH * \param[in] t200_ms_acch per-SAPI array of T200 in milli-seconds for SACCH
* \param[in] chan_t GSM channel type (to correctly set N200) * \param[in] chan_t GSM channel type (to correctly set N200)
* \parma[in] name_pfx human-readable name (copied by function + extended with ACCH/DCCH) * \param[in] name_pfx human-readable name (copied by function + extended with ACCH/DCCH)
*/ */
int lapdm_channel_init3(struct lapdm_channel *lc, enum lapdm_mode mode, int lapdm_channel_init3(struct lapdm_channel *lc, enum lapdm_mode mode,
const int *t200_ms_dcch, const int *t200_ms_acch, enum gsm_chan_t chan_t, const int *t200_ms_dcch, const int *t200_ms_acch, enum gsm_chan_t chan_t,

View File

@ -126,7 +126,7 @@ int osmo_tlvp_merge(struct tlv_parsed *dst, const struct tlv_parsed *src)
* \param[inout] msg Caller-allocated message buffer with sufficient tailroom * \param[inout] msg Caller-allocated message buffer with sufficient tailroom
* \param[in] type TLV type/format to use during encode * \param[in] type TLV type/format to use during encode
* \param[in] tag Tag of TLV to be encoded * \param[in] tag Tag of TLV to be encoded
* \parma[in] len Length of TLV to be encoded * \param[in] len Length of TLV to be encoded
* \param[in] val Value part of TLV to be encoded * \param[in] val Value part of TLV to be encoded
* \returns 0 on success; negative in case of error */ * \returns 0 on success; negative in case of error */
int tlv_encode_one(struct msgb *msg, enum tlv_type type, uint8_t tag, int tlv_encode_one(struct msgb *msg, enum tlv_type type, uint8_t tag,

View File

@ -197,7 +197,7 @@ static ubit_t mux_schan_provide_bit(struct osmo_i460_subchan *schan)
/*! provide one byte with the subchan-specific bits of given sub-channel. /*! provide one byte with the subchan-specific bits of given sub-channel.
* \param[in] schan sub-channel that is to provide bits * \param[in] schan sub-channel that is to provide bits
* \parma[out] mask bitmask of those bits filled in * \param[out] mask bitmask of those bits filled in
* \returns bits of given sub-channel */ * \returns bits of given sub-channel */
static uint8_t mux_subchan_provide_bits(struct osmo_i460_subchan *schan, uint8_t *mask) static uint8_t mux_subchan_provide_bits(struct osmo_i460_subchan *schan, uint8_t *mask)
{ {