paulmataruso/osmo-mgw
1
0
Fork 0
mirror of https://gitea.osmocom.org/cellular-infrastructure/osmo-mgw.git synced 2025-11-02 04:53:24 +00:00
Code Issues Packages Projects Releases Wiki Activity

cosmetic: fix doxygen comment markers

Browse Source 
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
This commit is contained in:
Neels Hofmeyr
2018-06-26 00:05:53 +02:00
parent 704c4f0adf
commit 8838c62fe9
4 changed files with 30 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
include/osmocom/mgcp/mgcp_endp.h
View File

@@ -42,13 +42,13 @@ typedef void (*mgcp_cleanup_cp) (struct mgcp_endpoint *endp,
/*! MGCP endpoint properties */ /*! MGCP endpoint properties */
struct mgcp_endpoint_type { struct mgcp_endpoint_type {
/*!< maximum number of connections */ /*! maximum number of connections */
int max_conns; 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; 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; mgcp_cleanup_cp cleanup_cb;
}; };
@@ -63,31 +63,31 @@ extern const struct mgcp_endpoint_typeset ep_typeset;
/*! MGCP endpoint model */ /*! MGCP endpoint model */
struct mgcp_endpoint { struct mgcp_endpoint {
/*!< Call identifier string (as supplied by the call agant) */ /*! Call identifier string (as supplied by the call agant) */
char *callid; char *callid;
/*!< Local connection options (see mgcp_internal.h) */ /*! Local connection options (see mgcp_internal.h) */
struct mgcp_lco local_options; struct mgcp_lco local_options;
/*!< List with connections active on this endpoint */ /*! List with connections active on this endpoint */
struct llist_head conns; struct llist_head conns;
/*!< Backpointer to the MGW configuration */ /*! Backpointer to the MGW configuration */
struct mgcp_config *cfg; struct mgcp_config *cfg;
/*!< Backpointer to the Trunk specific configuration */ /*! Backpointer to the Trunk specific configuration */
struct mgcp_trunk_config *tcfg; struct mgcp_trunk_config *tcfg;
/*!< Endpoint properties (see above) */ /*! Endpoint properties (see above) */
const struct mgcp_endpoint_type *type; 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; char *last_trans;
/*!< Last MGCP response (in case re-transmission is required) */ /*! Last MGCP response (in case re-transmission is required) */
char *last_response; 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. */ * or if the user has choosen the particular endpoint explicitly. */
bool wildcarded_req; bool wildcarded_req;
}; };

18
include/osmocom/mgcp/mgcp_internal.h
View File

@@ -221,33 +221,33 @@ enum mgcp_conn_type {
/*! MGCP connection (untyped) */ /*! MGCP connection (untyped) */
struct mgcp_conn { struct mgcp_conn {
/*!< list head */ /*! list head */
struct llist_head entry; 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; struct mgcp_endpoint *endp;
/*!< type of the connection (union) */ /*! type of the connection (union) */
enum mgcp_conn_type type; enum mgcp_conn_type type;
/*!< mode of the connection */ /*! mode of the connection */
enum mgcp_connection_mode mode; 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; enum mgcp_connection_mode mode_orig;
/*!< connection id to identify the connection */ /*! connection id to identify the connection */
char id[MGCP_CONN_ID_LENGTH]; char id[MGCP_CONN_ID_LENGTH];
/*!< human readable name (vty, logging) */ /*! human readable name (vty, logging) */
char name[256]; char name[256];
/*!< union with connection description */ /*! union with connection description */
union { union {
struct mgcp_conn_rtp rtp; struct mgcp_conn_rtp rtp;
} u; } u;
/*!< pointer to optional private data */ /*! pointer to optional private data */
void *priv; void *priv;
}; };

4
include/osmocom/mgcp_client/mgcp_client.h
View File

@@ -46,10 +46,10 @@ enum mgcp_codecs {
/*! Structure to build a payload type map to allow the defiition custom payload /*! Structure to build a payload type map to allow the defiition custom payload
* types. */ * types. */
struct ptmap { 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; enum mgcp_codecs codec;
/*!< payload type number (96-127) */ /*! payload type number (96-127) */
unsigned int pt; unsigned int pt;
}; };

14
include/osmocom/mgcp_client/mgcp_client_fsm.h
View File

@@ -14,25 +14,25 @@
* identifier is supplied it is checked against the internal state to make * identifier is supplied it is checked against the internal state to make
* sure it is correct. */ * sure it is correct. */
struct mgcp_conn_peer { 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]; char addr[INET_ADDRSTRLEN];
/*!< RTP connection IP-Port (optional) */ /*! RTP connection IP-Port (optional) */
uint16_t port; uint16_t port;
/*!< RTP endpoint */ /*! RTP endpoint */
char endpoint[MGCP_ENDPOINT_MAXLEN]; char endpoint[MGCP_ENDPOINT_MAXLEN];
/*!< CALL ID (unique per connection) */ /*! CALL ID (unique per connection) */
unsigned int call_id; unsigned int call_id;
/*!< RTP packetization interval (optional) */ /*! RTP packetization interval (optional) */
unsigned int ptime; unsigned int ptime;
/*!< RTP codec list (optional) */ /*! RTP codec list (optional) */
enum mgcp_codecs codecs[MGCP_MAX_CODECS]; 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; unsigned int codecs_len;
}; };