cosmetic: fix doxygen comment markers
There has obviously been a misunderstanding on how the doxygen comments work.
A comment marked '<' is for placing a comment *after* a member, to point back
to the item before it, typically
enum foo {
thing, /*!< this is a thing */
a_bobby,
}
It does not make sense to place these above the item they are describing.
We actually don't use doxygen in the osmo-mgw build, but if we have doxygen
syntax, we might as well have the correct one.
Change-Id: I9e8ea0e3bd5ae5fcc0a6fae8e26e11baa8f35e27
diff --git a/include/osmocom/mgcp/mgcp_endp.h b/include/osmocom/mgcp/mgcp_endp.h
index 9283373..3876794 100644
--- a/include/osmocom/mgcp/mgcp_endp.h
+++ b/include/osmocom/mgcp/mgcp_endp.h
@@ -42,13 +42,13 @@
/*! MGCP endpoint properties */
struct mgcp_endpoint_type {
- /*!< maximum number of connections */
+ /*! maximum number of connections */
int max_conns;
- /*!< callback that defines how to dispatch incoming RTP data */
+ /*! callback that defines how to dispatch incoming RTP data */
mgcp_dispatch_rtp_cb dispatch_rtp_cb;
- /*!< callback that implements endpoint specific cleanup actions */
+ /*! callback that implements endpoint specific cleanup actions */
mgcp_cleanup_cp cleanup_cb;
};
@@ -63,31 +63,31 @@
/*! MGCP endpoint model */
struct mgcp_endpoint {
- /*!< Call identifier string (as supplied by the call agant) */
+ /*! Call identifier string (as supplied by the call agant) */
char *callid;
- /*!< Local connection options (see mgcp_internal.h) */
+ /*! Local connection options (see mgcp_internal.h) */
struct mgcp_lco local_options;
- /*!< List with connections active on this endpoint */
+ /*! List with connections active on this endpoint */
struct llist_head conns;
- /*!< Backpointer to the MGW configuration */
+ /*! Backpointer to the MGW configuration */
struct mgcp_config *cfg;
- /*!< Backpointer to the Trunk specific configuration */
+ /*! Backpointer to the Trunk specific configuration */
struct mgcp_trunk_config *tcfg;
- /*!< Endpoint properties (see above) */
+ /*! Endpoint properties (see above) */
const struct mgcp_endpoint_type *type;
- /*!< Last MGCP transmission (in case re-transmission is required) */
+ /*! Last MGCP transmission (in case re-transmission is required) */
char *last_trans;
- /*!< Last MGCP response (in case re-transmission is required) */
+ /*! Last MGCP response (in case re-transmission is required) */
char *last_response;
- /*!< Memorize if this endpoint was choosen by the MGW (wildcarded, true)
+ /*! Memorize if this endpoint was choosen by the MGW (wildcarded, true)
* or if the user has choosen the particular endpoint explicitly. */
bool wildcarded_req;
};
diff --git a/include/osmocom/mgcp/mgcp_internal.h b/include/osmocom/mgcp/mgcp_internal.h
index b564905..7712593 100644
--- a/include/osmocom/mgcp/mgcp_internal.h
+++ b/include/osmocom/mgcp/mgcp_internal.h
@@ -221,33 +221,33 @@
/*! MGCP connection (untyped) */
struct mgcp_conn {
- /*!< list head */
+ /*! list head */
struct llist_head entry;
- /*!< Backpointer to the endpoint where the conn belongs to */
+ /*! Backpointer to the endpoint where the conn belongs to */
struct mgcp_endpoint *endp;
- /*!< type of the connection (union) */
+ /*! type of the connection (union) */
enum mgcp_conn_type type;
- /*!< mode of the connection */
+ /*! mode of the connection */
enum mgcp_connection_mode mode;
- /*!< copy of the mode to restore the original setting (VTY) */
+ /*! copy of the mode to restore the original setting (VTY) */
enum mgcp_connection_mode mode_orig;
- /*!< connection id to identify the connection */
+ /*! connection id to identify the connection */
char id[MGCP_CONN_ID_LENGTH];
- /*!< human readable name (vty, logging) */
+ /*! human readable name (vty, logging) */
char name[256];
- /*!< union with connection description */
+ /*! union with connection description */
union {
struct mgcp_conn_rtp rtp;
} u;
- /*!< pointer to optional private data */
+ /*! pointer to optional private data */
void *priv;
};
diff --git a/include/osmocom/mgcp_client/mgcp_client.h b/include/osmocom/mgcp_client/mgcp_client.h
index 3cecb8f..19c684d 100644
--- a/include/osmocom/mgcp_client/mgcp_client.h
+++ b/include/osmocom/mgcp_client/mgcp_client.h
@@ -46,10 +46,10 @@
/*! Structure to build a payload type map to allow the defiition custom payload
* types. */
struct ptmap {
- /*!< codec for which a payload type number should be defined */
+ /*! codec for which a payload type number should be defined */
enum mgcp_codecs codec;
- /*!< payload type number (96-127) */
+ /*! payload type number (96-127) */
unsigned int pt;
};
diff --git a/include/osmocom/mgcp_client/mgcp_client_fsm.h b/include/osmocom/mgcp_client/mgcp_client_fsm.h
index 47d9fab..353baff 100644
--- a/include/osmocom/mgcp_client/mgcp_client_fsm.h
+++ b/include/osmocom/mgcp_client/mgcp_client_fsm.h
@@ -14,25 +14,25 @@
* identifier is supplied it is checked against the internal state to make
* sure it is correct. */
struct mgcp_conn_peer {
- /*!< RTP connection IP-Address (optional, string e.g. "127.0.0.1") */
+ /*! RTP connection IP-Address (optional, string e.g. "127.0.0.1") */
char addr[INET_ADDRSTRLEN];
- /*!< RTP connection IP-Port (optional) */
+ /*! RTP connection IP-Port (optional) */
uint16_t port;
- /*!< RTP endpoint */
+ /*! RTP endpoint */
char endpoint[MGCP_ENDPOINT_MAXLEN];
- /*!< CALL ID (unique per connection) */
+ /*! CALL ID (unique per connection) */
unsigned int call_id;
- /*!< RTP packetization interval (optional) */
+ /*! RTP packetization interval (optional) */
unsigned int ptime;
- /*!< RTP codec list (optional) */
+ /*! RTP codec list (optional) */
enum mgcp_codecs codecs[MGCP_MAX_CODECS];
- /*!< Number of codecs in RTP codec list (optional) */
+ /*! Number of codecs in RTP codec list (optional) */
unsigned int codecs_len;
};