summaryrefslogtreecommitdiffstats
path: root/include/osmocom/core
diff options
context:
space:
mode:
authorNeels Hofmeyr <nhofmeyr@sysmocom.de>2017-06-20 00:17:59 +0200
committerNeels Hofmeyr <nhofmeyr@sysmocom.de>2017-06-23 00:18:22 +0000
commit87e4550585c643e97e0003119b254251ac5ed1d4 (patch)
tree9287f66aba70e9253f4d62926c54dddeb492895e /include/osmocom/core
parent249fb71a2e124acb191b7cd4d2c3af6a45da4a5e (diff)
doxygen: enable AUTOBRIEF, drop \brief
Especially for short descriptions, it is annoying to have to type \brief for every single API doc. Drop all \brief and enable the AUTOBRIEF feature of doxygen, which always takes the first sentence of an API doc as the brief description. Change-Id: I11a8a821b065a128108641a2a63fb5a2b1916e87
Diffstat (limited to 'include/osmocom/core')
-rw-r--r--include/osmocom/core/application.h8
-rw-r--r--include/osmocom/core/bitXXgen.h.tpl16
-rw-r--r--include/osmocom/core/bitcomp.h2
-rw-r--r--include/osmocom/core/bits.h30
-rw-r--r--include/osmocom/core/bitvec.h20
-rw-r--r--include/osmocom/core/byteswap.h4
-rw-r--r--include/osmocom/core/conv.h56
-rw-r--r--include/osmocom/core/crcXXgen.h.tpl10
-rw-r--r--include/osmocom/core/defs.h6
-rw-r--r--include/osmocom/core/fsm.h90
-rw-r--r--include/osmocom/core/gsmtap.h4
-rw-r--r--include/osmocom/core/gsmtap_util.h10
-rw-r--r--include/osmocom/core/linuxlist.h58
-rw-r--r--include/osmocom/core/logging.h98
-rw-r--r--include/osmocom/core/msgb.h96
-rw-r--r--include/osmocom/core/panic.h2
-rw-r--r--include/osmocom/core/prim.h28
-rw-r--r--include/osmocom/core/rate_ctr.h62
-rw-r--r--include/osmocom/core/select.h10
-rw-r--r--include/osmocom/core/sercomm.h42
-rw-r--r--include/osmocom/core/signal.h4
-rw-r--r--include/osmocom/core/socket.h2
-rw-r--r--include/osmocom/core/stat_item.h50
-rw-r--r--include/osmocom/core/statistics.h30
-rw-r--r--include/osmocom/core/strrb.h12
-rw-r--r--include/osmocom/core/timer.h16
-rw-r--r--include/osmocom/core/timer_compat.h2
-rw-r--r--include/osmocom/core/utils.h18
-rw-r--r--include/osmocom/core/write_queue.h14
29 files changed, 400 insertions, 400 deletions
diff --git a/include/osmocom/core/application.h b/include/osmocom/core/application.h
index ecaeaa8a..266fa9bb 100644
--- a/include/osmocom/core/application.h
+++ b/include/osmocom/core/application.h
@@ -2,16 +2,16 @@
/*!
* \file application.h
- * \brief Routines for helping with the osmocom application setup.
+ * Routines for helping with the osmocom application setup.
*/
-/*! \brief information containing the available logging subsystems */
+/*! information containing the available logging subsystems */
struct log_info;
-/*! \brief one instance of a logging target (file, stderr, ...) */
+/*! one instance of a logging target (file, stderr, ...) */
struct log_target;
-/*! \brief the default logging target, logging to stderr */
+/*! the default logging target, logging to stderr */
extern struct log_target *osmo_stderr_target;
void osmo_init_ignore_signals(void);
diff --git a/include/osmocom/core/bitXXgen.h.tpl b/include/osmocom/core/bitXXgen.h.tpl
index 7480a8f4..6881d87d 100644
--- a/include/osmocom/core/bitXXgen.h.tpl
+++ b/include/osmocom/core/bitXXgen.h.tpl
@@ -22,7 +22,7 @@
#pragma once
-/*! \brief load unaligned n-byte integer (little-endian encoding) into uintXX_t
+/*! load unaligned n-byte integer (little-endian encoding) into uintXX_t
* \param[in] p Buffer where integer is stored
* \param[in] n Number of bytes stored in p
* \returns XX bit unsigned integer
@@ -36,7 +36,7 @@ static inline uintXX_t osmo_loadXXle_ext(const void *p, uint8_t n)
return r;
}
-/*! \brief load unaligned n-byte integer (big-endian encoding) into uintXX_t
+/*! load unaligned n-byte integer (big-endian encoding) into uintXX_t
* \param[in] p Buffer where integer is stored
* \param[in] n Number of bytes stored in p
* \returns XX bit unsigned integer
@@ -51,7 +51,7 @@ static inline uintXX_t osmo_loadXXbe_ext(const void *p, uint8_t n)
}
-/*! \brief store unaligned n-byte integer (little-endian encoding) from uintXX_t
+/*! store unaligned n-byte integer (little-endian encoding) from uintXX_t
* \param[in] x unsigned XX bit integer
* \param[out] p Buffer to store integer
* \param[in] n Number of bytes to store
@@ -63,7 +63,7 @@ static inline void osmo_storeXXle_ext(uintXX_t x, void *p, uint8_t n)
for(i = 0; i < n; q[i] = (x >> i * 8) & 0xFF, i++);
}
-/*! \brief store unaligned n-byte integer (big-endian encoding) from uintXX_t
+/*! store unaligned n-byte integer (big-endian encoding) from uintXX_t
* \param[in] x unsigned XX bit integer
* \param[out] p Buffer to store integer
* \param[in] n Number of bytes to store
@@ -79,26 +79,26 @@ static inline void osmo_storeXXbe_ext(uintXX_t x, void *p, uint8_t n)
/* Convenience function for most-used cases */
-/*! \brief load unaligned XX-bit integer (little-endian encoding) */
+/*! load unaligned XX-bit integer (little-endian encoding) */
static inline uintXX_t osmo_loadXXle(const void *p)
{
return osmo_loadXXle_ext(p, XX / 8);
}
-/*! \brief load unaligned XX-bit integer (big-endian encoding) */
+/*! load unaligned XX-bit integer (big-endian encoding) */
static inline uintXX_t osmo_loadXXbe(const void *p)
{
return osmo_loadXXbe_ext(p, XX / 8);
}
-/*! \brief store unaligned XX-bit integer (little-endian encoding) */
+/*! store unaligned XX-bit integer (little-endian encoding) */
static inline void osmo_storeXXle(uintXX_t x, void *p)
{
osmo_storeXXle_ext(x, p, XX / 8);
}
-/*! \brief store unaligned XX-bit integer (big-endian encoding) */
+/*! store unaligned XX-bit integer (big-endian encoding) */
static inline void osmo_storeXXbe(uintXX_t x, void *p)
{
osmo_storeXXbe_ext(x, p, XX / 8);
diff --git a/include/osmocom/core/bitcomp.h b/include/osmocom/core/bitcomp.h
index e87c0e10..a184a1cf 100644
--- a/include/osmocom/core/bitcomp.h
+++ b/include/osmocom/core/bitcomp.h
@@ -27,7 +27,7 @@
*/
/*! \file bitcomp.h
- * \brief Osmocom bit compression routines
+ * Osmocom bit compression routines
*/
#include <stdint.h>
diff --git a/include/osmocom/core/bits.h b/include/osmocom/core/bits.h
index 5535920e..61af716c 100644
--- a/include/osmocom/core/bits.h
+++ b/include/osmocom/core/bits.h
@@ -12,18 +12,18 @@
*/
/*! \file bits.h
- * \brief Osmocom bit level support code
+ * Osmocom bit level support code
*
* NOTE on the endianess of pbit_t:
* Bits in a pbit_t are ordered MSB first, i.e. 0x80 is the first bit.
* Bit i in a pbit_t array is array[i/8] & (1<<(7-i%8))
*/
-typedef int8_t sbit_t; /*!< \brief soft bit (-127...127) */
-typedef uint8_t ubit_t; /*!< \brief unpacked bit (0 or 1) */
-typedef uint8_t pbit_t; /*!< \brief packed bis (8 bits in a byte) */
+typedef int8_t sbit_t; /*!< soft bit (-127...127) */
+typedef uint8_t ubit_t; /*!< unpacked bit (0 or 1) */
+typedef uint8_t pbit_t; /*!< packed bis (8 bits in a byte) */
-/*! \brief determine how many bytes we would need for \a num_bits packed bits
+/*! determine how many bytes we would need for \a num_bits packed bits
* \param[in] num_bits Number of packed bits
* \returns number of bytes needed for \a num_bits packed bits
*/
@@ -81,31 +81,31 @@ int osmo_pbit2ubit_ext(ubit_t *out, unsigned int out_ofs,
/* BIT REVERSAL */
-/*! \brief bit-reversal mode for osmo_bit_reversal() */
+/*! bit-reversal mode for osmo_bit_reversal() */
enum osmo_br_mode {
- /*! \brief reverse all bits in a 32bit dword */
+ /*! reverse all bits in a 32bit dword */
OSMO_BR_BITS_IN_DWORD = 31,
- /*! \brief reverse byte order in a 32bit dword */
+ /*! reverse byte order in a 32bit dword */
OSMO_BR_BYTES_IN_DWORD = 24,
- /*! \brief reverse bits of each byte in a 32bit dword */
+ /*! reverse bits of each byte in a 32bit dword */
OSMO_BR_BITS_IN_BYTE = 7,
- /*! \brief swap the two 16bit words in a 32bit dword */
+ /*! swap the two 16bit words in a 32bit dword */
OSMO_BR_WORD_SWAP = 16,
};
-/*! \brief generic bit reversal function */
+/*! generic bit reversal function */
uint32_t osmo_bit_reversal(uint32_t x, enum osmo_br_mode k);
-/* \brief reverse the bits within each byte of a 32bit word */
+/* reverse the bits within each byte of a 32bit word */
uint32_t osmo_revbytebits_32(uint32_t x);
-/* \brief reverse the bits within a byte */
+/* reverse the bits within a byte */
uint32_t osmo_revbytebits_8(uint8_t x);
-/* \brief reverse the bits of each byte in a given buffer */
+/* reverse the bits of each byte in a given buffer */
void osmo_revbytebits_buf(uint8_t *buf, int len);
-/*! \brief left circular shift
+/*! left circular shift
* \param[in] in The 16 bit unsigned integer to be rotated
* \param[in] shift Number of bits to shift \a in to, [0;16] bits
* \returns shifted value
diff --git a/include/osmocom/core/bitvec.h b/include/osmocom/core/bitvec.h
index 6944770c..9187ce23 100644
--- a/include/osmocom/core/bitvec.h
+++ b/include/osmocom/core/bitvec.h
@@ -29,7 +29,7 @@
*/
/*! \file bitvec.h
- * \brief Osmocom bit vector abstraction
+ * Osmocom bit vector abstraction
*
* These functions assume a MSB (most significant bit) first layout of the
* bits, so that for instance the 5 bit number abcde (a is MSB) can be
@@ -44,22 +44,22 @@
#include <osmocom/core/talloc.h>
#include <stdbool.h>
-/*! \brief A single GSM bit
+/*! A single GSM bit
*
* In GSM mac blocks, every bit can be 0 or 1, or L or H. L/H are
* defined relative to the 0x2b padding pattern */
enum bit_value {
- ZERO = 0, /*!< \brief A zero (0) bit */
- ONE = 1, /*!< \brief A one (1) bit */
- L = 2, /*!< \brief A CSN.1 "L" bit */
- H = 3, /*!< \brief A CSN.1 "H" bit */
+ ZERO = 0, /*!< A zero (0) bit */
+ ONE = 1, /*!< A one (1) bit */
+ L = 2, /*!< A CSN.1 "L" bit */
+ H = 3, /*!< A CSN.1 "H" bit */
};
-/*! \brief structure describing a bit vector */
+/*! structure describing a bit vector */
struct bitvec {
- unsigned int cur_bit; /*!< \brief cursor to the next unused bit */
- unsigned int data_len; /*!< \brief length of data array in bytes */
- uint8_t *data; /*!< \brief pointer to data array */
+ unsigned int cur_bit; /*!< cursor to the next unused bit */
+ unsigned int data_len; /*!< length of data array in bytes */
+ uint8_t *data; /*!< pointer to data array */
};
enum bit_value bitvec_get_bit_pos(const struct bitvec *bv, unsigned int bitnr);
diff --git a/include/osmocom/core/byteswap.h b/include/osmocom/core/byteswap.h
index 1f09c2b1..4274b8fb 100644
--- a/include/osmocom/core/byteswap.h
+++ b/include/osmocom/core/byteswap.h
@@ -2,7 +2,7 @@
#include <stdint.h>
#include <osmocom/core/endian.h>
-/*! \brief byte-swap a 32bit word
+/*! byte-swap a 32bit word
* \param[in] in to be swapped 32bit word
* \returns byte-swapped 32bit word */
static inline uint32_t osmo_swab32(uint32_t in)
@@ -17,7 +17,7 @@ static inline uint32_t osmo_swab32(uint32_t in)
return out;
}
-/*! \brief byte-swap a 16bit word
+/*! byte-swap a 16bit word
* \param[in] in to be swapped 16bit word
* \returns byte-swapped 16bit word */
static inline uint16_t osmo_swab16(uint16_t in)
diff --git a/include/osmocom/core/conv.h b/include/osmocom/core/conv.h
index e7f6bd6a..1888fe13 100644
--- a/include/osmocom/core/conv.h
+++ b/include/osmocom/core/conv.h
@@ -34,7 +34,7 @@
#include <osmocom/core/bits.h>
-/*! \brief possibe termination types
+/*! possibe termination types
*
* The termination type will determine which state the encoder/decoder
* can start/end with. This is mostly taken care of in the high level API
@@ -42,31 +42,31 @@
* proper calls yourself.
*/
enum osmo_conv_term {
- CONV_TERM_FLUSH = 0, /*!< \brief Flush encoder state */
- CONV_TERM_TRUNCATION, /*!< \brief Direct truncation */
- CONV_TERM_TAIL_BITING, /*!< \brief Tail biting */
+ CONV_TERM_FLUSH = 0, /*!< Flush encoder state */
+ CONV_TERM_TRUNCATION, /*!< Direct truncation */
+ CONV_TERM_TAIL_BITING, /*!< Tail biting */
};
-/*! \brief structure describing a given convolutional code
+/*! structure describing a given convolutional code
*
* The only required fields are N,K and the next_output/next_state arrays. The
* other can be left to default value of zero depending on what the code does.
* If 'len' is left at 0 then only the low level API can be used.
*/
struct osmo_conv_code {
- int N; /*!< \brief Inverse of code rate */
- int K; /*!< \brief Constraint length */
- int len; /*!< \brief # of data bits */
+ int N; /*!< Inverse of code rate */
+ int K; /*!< Constraint length */
+ int len; /*!< # of data bits */
- enum osmo_conv_term term; /*!< \brief Termination type */
+ enum osmo_conv_term term; /*!< Termination type */
- const uint8_t (*next_output)[2];/*!< \brief Next output array */
- const uint8_t (*next_state)[2]; /*!< \brief Next state array */
+ const uint8_t (*next_output)[2];/*!< Next output array */
+ const uint8_t (*next_state)[2]; /*!< Next state array */
- const uint8_t *next_term_output;/*!< \brief Flush termination output */
- const uint8_t *next_term_state; /*!< \brief Flush termination state */
+ const uint8_t *next_term_output;/*!< Flush termination output */
+ const uint8_t *next_term_state; /*!< Flush termination state */
- const int *puncture; /*!< \brief Punctured bits indexes */
+ const int *puncture; /*!< Punctured bits indexes */
};
@@ -80,12 +80,12 @@ int osmo_conv_get_output_length(const struct osmo_conv_code *code, int len);
/* Low level API */
-/*! \brief convolutional encoder state */
+/*! convolutional encoder state */
struct osmo_conv_encoder {
- const struct osmo_conv_code *code; /*!< \brief for which code? */
- int i_idx; /*!< \brief Next input bit index */
- int p_idx; /*!< \brief Current puncture index */
- uint8_t state; /*!< \brief Current state */
+ const struct osmo_conv_code *code; /*!< for which code? */
+ int i_idx; /*!< Next input bit index */
+ int p_idx; /*!< Current puncture index */
+ uint8_t state; /*!< Current state */
};
void osmo_conv_encode_init(struct osmo_conv_encoder *encoder,
@@ -105,20 +105,20 @@ int osmo_conv_encode(const struct osmo_conv_code *code,
/* Low level API */
-/*! \brief convolutional decoder state */
+/*! convolutional decoder state */
struct osmo_conv_decoder {
- const struct osmo_conv_code *code; /*!< \brief for which code? */
+ const struct osmo_conv_code *code; /*!< for which code? */
- int n_states; /*!< \brief number of states */
+ int n_states; /*!< number of states */
- int len; /*!< \brief Max o_idx (excl. termination) */
+ int len; /*!< Max o_idx (excl. termination) */
- int o_idx; /*!< \brief output index */
- int p_idx; /*!< \brief puncture index */
+ int o_idx; /*!< output index */
+ int p_idx; /*!< puncture index */
- unsigned int *ae; /*!< \brief accumulated error */
- unsigned int *ae_next; /*!< \brief next accumulated error (tmp in scan) */
- uint8_t *state_history; /*!< \brief state history [len][n_states] */
+ unsigned int *ae; /*!< accumulated error */
+ unsigned int *ae_next; /*!< next accumulated error (tmp in scan) */
+ uint8_t *state_history; /*!< state history [len][n_states] */
};
void osmo_conv_decode_init(struct osmo_conv_decoder *decoder,
diff --git a/include/osmocom/core/crcXXgen.h.tpl b/include/osmocom/core/crcXXgen.h.tpl
index 164f7201..47188090 100644
--- a/include/osmocom/core/crcXXgen.h.tpl
+++ b/include/osmocom/core/crcXXgen.h.tpl
@@ -35,12 +35,12 @@
#include <osmocom/core/bits.h>
-/*! \brief structure describing a given CRC code of max XX bits */
+/*! structure describing a given CRC code of max XX bits */
struct osmo_crcXXgen_code {
- int bits; /*!< \brief Actual number of bits of the CRC */
- uintXX_t poly; /*!< \brief Polynom (normal representation, MSB omitted */
- uintXX_t init; /*!< \brief Initialization value of the CRC state */
- uintXX_t remainder; /*!< \brief Remainder of the CRC (final XOR) */
+ int bits; /*!< Actual number of bits of the CRC */
+ uintXX_t poly; /*!< Polynom (normal representation, MSB omitted */
+ uintXX_t init; /*!< Initialization value of the CRC state */
+ uintXX_t remainder; /*!< Remainder of the CRC (final XOR) */
};
uintXX_t osmo_crcXXgen_compute_bits(const struct osmo_crcXXgen_code *code,
diff --git a/include/osmocom/core/defs.h b/include/osmocom/core/defs.h
index 51ac4e51..88c41b91 100644
--- a/include/osmocom/core/defs.h
+++ b/include/osmocom/core/defs.h
@@ -5,10 +5,10 @@
*/
/*! \file defs.h
- * \brief General definitions that are meant to be included from header files.
+ * General definitions that are meant to be included from header files.
*/
-/*! \brief Check for gcc and version.
+/*! Check for gcc and version.
*
* \note Albeit glibc provides a features.h file that contains a similar
* definition (__GNUC_PREREQ), this definition has been copied from there
@@ -23,7 +23,7 @@
# define OSMO_GNUC_PREREQ(maj, min) 0
#endif
-/*! \brief Set the deprecated attribute with a message.
+/*! Set the deprecated attribute with a message.
*/
#if defined(__clang__)
# define _OSMO_HAS_ATTRIBUTE_DEPRECATED __has_attribute(deprecated)
diff --git a/include/osmocom/core/fsm.h b/include/osmocom/core/fsm.h
index f42dd0c6..fb182f35 100644
--- a/include/osmocom/core/fsm.h
+++ b/include/osmocom/core/fsm.h
@@ -12,21 +12,21 @@
*/
/*! \file fsm.h
- * \brief Finite State Machine
+ * Finite State Machine
*/
struct osmo_fsm_inst;
enum osmo_fsm_term_cause {
- /*! \brief terminate because parent terminated */
+ /*! terminate because parent terminated */
OSMO_FSM_TERM_PARENT,
- /*! \brief terminate on explicit user request */
+ /*! terminate on explicit user request */
OSMO_FSM_TERM_REQUEST,
- /*! \brief regular termination of process */
+ /*! regular termination of process */
OSMO_FSM_TERM_REGULAR,
- /*! \brief erroneous termination of process */
+ /*! erroneous termination of process */
OSMO_FSM_TERM_ERROR,
- /*! \brief termination due to time-out */
+ /*! termination due to time-out */
OSMO_FSM_TERM_TIMEOUT,
};
@@ -37,80 +37,80 @@ static inline const char *osmo_fsm_term_cause_name(enum osmo_fsm_term_cause caus
}
-/*! \brief description of a rule in the FSM */
+/*! description of a rule in the FSM */
struct osmo_fsm_state {
- /*! \brief bit-mask of permitted input events for this state */
+ /*! bit-mask of permitted input events for this state */
uint32_t in_event_mask;
- /*! \brief bit-mask to which other states this state may transiton */
+ /*! bit-mask to which other states this state may transiton */
uint32_t out_state_mask;
- /*! \brief human-readable name of this state */
+ /*! human-readable name of this state */
const char *name;
- /*! \brief function to be called for events arriving in this state */
+ /*! function to be called for events arriving in this state */
void (*action)(struct osmo_fsm_inst *fi, uint32_t event, void *data);
- /*! \brief function to be called just after entering the state */
+ /*! function to be called just after entering the state */
void (*onenter)(struct osmo_fsm_inst *fi, uint32_t prev_state);
- /*! \brief function to be called just before leaving the state */
+ /*! function to be called just before leaving the state */
void (*onleave)(struct osmo_fsm_inst *fi, uint32_t next_state);
};
-/*! \brief a description of an osmocom finite state machine */
+/*! a description of an osmocom finite state machine */
struct osmo_fsm {
- /*! \brief global list */
+ /*! global list */
struct llist_head list;
- /*! \brief list of instances of this FSM */
+ /*! list of instances of this FSM */
struct llist_head instances;
- /*! \brief human readable name */
+ /*! human readable name */
const char *name;
- /*! \brief table of state transition rules */
+ /*! table of state transition rules */
const struct osmo_fsm_state *states;
- /*! \brief number of entries in \ref states */
+ /*! number of entries in \ref states */
unsigned int num_states;
- /*! \brief bit-mask of events permitted in all states */
+ /*! bit-mask of events permitted in all states */
uint32_t allstate_event_mask;
- /*! \brief function pointer to be called for allstate events */
+ /*! function pointer to be called for allstate events */
void (*allstate_action)(struct osmo_fsm_inst *fi, uint32_t event, void *data);
- /*! \brief clean-up function, called during termination */
+ /*! clean-up function, called during termination */
void (*cleanup)(struct osmo_fsm_inst *fi, enum osmo_fsm_term_cause cause);
- /*! \brief timer call-back for states with time-out.
+ /*! timer call-back for states with time-out.
* \returns 1 to request termination, 0 to keep running. */
int (*timer_cb)(struct osmo_fsm_inst *fi);
- /*! \brief logging sub-system for this FSM */
+ /*! logging sub-system for this FSM */
int log_subsys;
- /*! \brief human-readable names of events */
+ /*! human-readable names of events */
const struct value_string *event_names;
};
-/*! \brief a single instanceof an osmocom finite state machine */
+/*! a single instanceof an osmocom finite state machine */
struct osmo_fsm_inst {
- /*! \brief member in the fsm->instances list */
+ /*! member in the fsm->instances list */
struct llist_head list;
- /*! \brief back-pointer to the FSM of which we are an instance */
+ /*! back-pointer to the FSM of which we are an instance */
struct osmo_fsm *fsm;
- /*! \brief human readable identifier */
+ /*! human readable identifier */
const char *id;
- /*! \brief human readable fully-qualified name */
+ /*! human readable fully-qualified name */
const char *name;
- /*! \brief some private data of this instance */
+ /*! some private data of this instance */
void *priv;
- /*! \brief logging level for this FSM */
+ /*! logging level for this FSM */
int log_level;
- /*! \brief current state of the FSM */
+ /*! current state of the FSM */
uint32_t state;
- /*! \brief timer number for states with time-out */
+ /*! timer number for states with time-out */
int T;
- /*! \brief timer back-end for states with time-out */
+ /*! timer back-end for states with time-out */
struct osmo_timer_list timer;
- /*! \brief support for fsm-based procedures */
+ /*! support for fsm-based procedures */
struct {
- /*! \brief the parent FSM that has created us */
+ /*! the parent FSM that has created us */
struct osmo_fsm_inst *parent;
- /*! \brief the event we should send upon termination */
+ /*! the event we should send upon termination */
uint32_t parent_term_event;
- /*! \brief a list of children processes */
+ /*! a list of children processes */
struct llist_head children;
- /*! \brief \ref llist_head linked to parent->proc.children */
+ /*! \ref llist_head linked to parent->proc.children */
struct llist_head child;
} proc;
};
@@ -156,11 +156,11 @@ const char *osmo_fsm_event_name(struct osmo_fsm *fsm, uint32_t event);
const char *osmo_fsm_inst_name(struct osmo_fsm_inst *fi);
const char *osmo_fsm_state_name(struct osmo_fsm *fsm, uint32_t state);
-/*! \brief return the name of the state the FSM instance is currently in. */
+/*! return the name of the state the FSM instance is currently in. */
static inline const char *osmo_fsm_inst_state_name(struct osmo_fsm_inst *fi)
{ return osmo_fsm_state_name(fi->fsm, fi->state); }
-/*! \brief perform a state change of the given FSM instance
+/*! perform a state change of the given FSM instance
*
* This is a macro that calls _osmo_fsm_inst_state_chg() with the given
* parameters as well as the caller's source file and line number for logging
@@ -173,7 +173,7 @@ int _osmo_fsm_inst_state_chg(struct osmo_fsm_inst *fi, uint32_t new_state,
unsigned long timeout_secs, int T,
const char *file, int line);
-/*! \brief dispatch an event to an osmocom finite state machine instance
+/*! dispatch an event to an osmocom finite state machine instance
*
* This is a macro that calls _osmo_fsm_inst_dispatch() with the given
* parameters as well as the caller's source file and line number for logging
@@ -184,7 +184,7 @@ int _osmo_fsm_inst_state_chg(struct osmo_fsm_inst *fi, uint32_t new_state,
int _osmo_fsm_inst_dispatch(struct osmo_fsm_inst *fi, uint32_t event, void *data,
const char *file, int line);
-/*! \brief Terminate FSM instance with given cause
+/*! Terminate FSM instance with given cause
*
* This is a macro that calls _osmo_fsm_inst_term() with the given parameters
* as well as the caller's source file and line number for logging purposes.
@@ -196,7 +196,7 @@ void _osmo_fsm_inst_term(struct osmo_fsm_inst *fi,
enum osmo_fsm_term_cause cause, void *data,
const char *file, int line);
-/*! \brief Terminate all child FSM instances of an FSM instance.
+/*! Terminate all child FSM instances of an FSM instance.
*
* This is a macro that calls _osmo_fsm_inst_term_children() with the given
* parameters as well as the caller's source file and line number for logging
diff --git a/include/osmocom/core/gsmtap.h b/include/osmocom/core/gsmtap.h
index f9d6f0a4..0dc25bb3 100644
--- a/include/osmocom/core/gsmtap.h
+++ b/include/osmocom/core/gsmtap.h
@@ -238,7 +238,7 @@ enum {
};
/* ====== DO NOT MAKE UNAPPROVED MODIFICATIONS HERE ===== */
-/*! \brief Structure of the GTMTAP pseudo-header */
+/*! Structure of the GTMTAP pseudo-header */
struct gsmtap_hdr {
uint8_t version; /*!< version, set to 0x01 currently */
uint8_t hdr_len; /*!< length in number of 32bit words */
@@ -258,7 +258,7 @@ struct gsmtap_hdr {
} __attribute__((packed));
-/*! \brief Structure of the GTMTAP libosmocore logging header */
+/*! Structure of the GTMTAP libosmocore logging header */
struct gsmtap_osmocore_log_hdr {
struct {
uint32_t sec;
diff --git a/include/osmocom/core/gsmtap_util.h b/include/osmocom/core/gsmtap_util.h
index 2e3d068d..b60257e2 100644
--- a/include/osmocom/core/gsmtap_util.h
+++ b/include/osmocom/core/gsmtap_util.h
@@ -19,14 +19,14 @@ struct msgb *gsmtap_makemsg(uint16_t arfcn, uint8_t ts, uint8_t chan_type,
uint8_t ss, uint32_t fn, int8_t signal_dbm,
uint8_t snr, const uint8_t *data, unsigned int len);
-/*! \brief one gsmtap instance */
+/*! one gsmtap instance */
struct gsmtap_inst {
- int ofd_wq_mode; /*!< \brief wait queue mode? */
- struct osmo_wqueue wq; /*!< \brief the wait queue */
- struct osmo_fd sink_ofd;/*!< \brief file descriptor */
+ int ofd_wq_mode; /*!< wait queue mode? */
+ struct osmo_wqueue wq; /*!< the wait queue */
+ struct osmo_fd sink_ofd;/*!< file descriptor */
};
-/*! \brief obtain the file descriptor associated with a gsmtap instance
+/*! obtain the file descriptor associated with a gsmtap instance
* \param[in] gti GSMTAP instance
* \returns file descriptor of GSMTAP instance */
static inline int gsmtap_inst_fd(struct gsmtap_inst *gti)
diff --git a/include/osmocom/core/linuxlist.h b/include/osmocom/core/linuxlist.h
index 7d850776..5098c5f5 100644
--- a/include/osmocom/core/linuxlist.h
+++ b/include/osmocom/core/linuxlist.h
@@ -7,7 +7,7 @@
/*!
* \file linuxlist.h
*
- * \brief Simple doubly linked list implementation.
+ * Simple doubly linked list implementation.
*
* Some of the internal functions ("__xxx") are useful when
* manipulating whole llists rather than single entries, as
@@ -24,7 +24,7 @@
static inline void prefetch(const void *x) {;}
-/*! \brief cast a member of a structure out to the containing structure
+/*! cast a member of a structure out to the containing structure
*
* \param[in] ptr the pointer to the member.
* \param[in] type the type of the container struct this is embedded in.
@@ -43,15 +43,15 @@ static inline void prefetch(const void *x) {;}
#define LLIST_POISON1 ((void *) 0x00100100)
#define LLIST_POISON2 ((void *) 0x00200200)
-/*! \brief (double) linked list header structure */
+/*! (double) linked list header structure */
struct llist_head {
- /*! \brief Pointer to next and previous item */
+ /*! Pointer to next and previous item */
struct llist_head *next, *prev;
};
#define LLIST_HEAD_INIT(name) { &(name), &(name) }
-/*! \brief define a statically-initialized \ref llist_head
+/*! define a statically-initialized \ref llist_head
* \param[in] name Variable name
*
* This is a helper macro that will define a named variable of type
@@ -59,12 +59,12 @@ struct llist_head {
#define LLIST_HEAD(name) \
struct llist_head name = LLIST_HEAD_INIT(name)
-/*! \brief initialize a \ref llist_head to point back to self */
+/*! initialize a \ref llist_head to point back to self */
#define INIT_LLIST_HEAD(ptr) do { \
(ptr)->next = (ptr); (ptr)->prev = (ptr); \
} while (0)
-/*! \brief Insert a new entry between two known consecutive entries.
+/*! Insert a new entry between two known consecutive entries.
*
* This is only for internal llist manipulation where we know
* the prev/next entries already!
@@ -79,7 +79,7 @@ static inline void __llist_add(struct llist_head *_new,
prev->next = _new;
}
-/*! \brief add a new entry into a linked list (at head)
+/*! add a new entry into a linked list (at head)
* \param _new New entry to be added
* \param head \ref llist_head to add it after
*
@@ -91,7 +91,7 @@ static inline void llist_add(struct llist_head *_new, struct llist_head *head)
__llist_add(_new, head, head->next);
}
-/*! \brief add a new entry into a linked list (at tail)
+/*! add a new entry into a linked list (at tail)
* \param _new New entry to be added
* \param head Head of linked list to whose tail we shall add \a _new
*
@@ -116,7 +116,7 @@ static inline void __llist_del(struct llist_head * prev, struct llist_head * nex
prev->next = next;