<p>Harald Welte <strong>merged</strong> this change.</p><p><a href="https://gerrit.osmocom.org/9741">View Change</a></p><div style="white-space:pre-wrap">Approvals:
Jenkins Builder: Verified
Harald Welte: Looks good to me, approved
</div><pre style="font-family: monospace,monospace; white-space: pre-wrap;">cosmetic: fix doxygen comment markers<br><br>There has obviously been a misunderstanding on how the doxygen comments work.<br>A comment marked '<' is for placing a comment *after* a member, to point back<br>to the item before it, typically<br><br> enum foo {<br> thing, /*!< this is a thing */<br> a_bobby,<br> }<br><br>It does not make sense to place these above the item they are describing.<br><br>We actually don't use doxygen in the osmo-mgw build, but if we have doxygen<br>syntax, we might as well have the correct one.<br><br>Change-Id: I9e8ea0e3bd5ae5fcc0a6fae8e26e11baa8f35e27<br>---<br>M include/osmocom/mgcp/mgcp_endp.h<br>M include/osmocom/mgcp/mgcp_internal.h<br>M include/osmocom/mgcp_client/mgcp_client.h<br>M include/osmocom/mgcp_client/mgcp_client_fsm.h<br>4 files changed, 30 insertions(+), 30 deletions(-)<br><br></pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;"><span>diff --git a/include/osmocom/mgcp/mgcp_endp.h b/include/osmocom/mgcp/mgcp_endp.h</span><br><span>index 9283373..3876794 100644</span><br><span>--- a/include/osmocom/mgcp/mgcp_endp.h</span><br><span>+++ b/include/osmocom/mgcp/mgcp_endp.h</span><br><span>@@ -42,13 +42,13 @@</span><br><span> </span><br><span> /*! MGCP endpoint properties */</span><br><span> struct mgcp_endpoint_type {</span><br><span style="color: hsl(0, 100%, 40%);">- /*!< maximum number of connections */</span><br><span style="color: hsl(120, 100%, 40%);">+ /*! maximum number of connections */</span><br><span> int max_conns;</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">- /*!< callback that defines how to dispatch incoming RTP data */</span><br><span style="color: hsl(120, 100%, 40%);">+ /*! callback that defines how to dispatch incoming RTP data */</span><br><span> mgcp_dispatch_rtp_cb dispatch_rtp_cb;</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">- /*!< callback that implements endpoint specific cleanup actions */</span><br><span style="color: hsl(120, 100%, 40%);">+ /*! callback that implements endpoint specific cleanup actions */</span><br><span> mgcp_cleanup_cp cleanup_cb;</span><br><span> };</span><br><span> </span><br><span>@@ -63,31 +63,31 @@</span><br><span> /*! MGCP endpoint model */</span><br><span> struct mgcp_endpoint {</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">- /*!< Call identifier string (as supplied by the call agant) */</span><br><span style="color: hsl(120, 100%, 40%);">+ /*! Call identifier string (as supplied by the call agant) */</span><br><span> char *callid;</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">- /*!< Local connection options (see mgcp_internal.h) */</span><br><span style="color: hsl(120, 100%, 40%);">+ /*! Local connection options (see mgcp_internal.h) */</span><br><span> struct mgcp_lco local_options;</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">- /*!< List with connections active on this endpoint */</span><br><span style="color: hsl(120, 100%, 40%);">+ /*! List with connections active on this endpoint */</span><br><span> struct llist_head conns;</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">- /*!< Backpointer to the MGW configuration */</span><br><span style="color: hsl(120, 100%, 40%);">+ /*! Backpointer to the MGW configuration */</span><br><span> struct mgcp_config *cfg;</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">- /*!< Backpointer to the Trunk specific configuration */</span><br><span style="color: hsl(120, 100%, 40%);">+ /*! Backpointer to the Trunk specific configuration */</span><br><span> struct mgcp_trunk_config *tcfg;</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">- /*!< Endpoint properties (see above) */</span><br><span style="color: hsl(120, 100%, 40%);">+ /*! Endpoint properties (see above) */</span><br><span> const struct mgcp_endpoint_type *type;</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">- /*!< Last MGCP transmission (in case re-transmission is required) */</span><br><span style="color: hsl(120, 100%, 40%);">+ /*! Last MGCP transmission (in case re-transmission is required) */</span><br><span> char *last_trans;</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">- /*!< Last MGCP response (in case re-transmission is required) */</span><br><span style="color: hsl(120, 100%, 40%);">+ /*! Last MGCP response (in case re-transmission is required) */</span><br><span> char *last_response;</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">- /*!< Memorize if this endpoint was choosen by the MGW (wildcarded, true)</span><br><span style="color: hsl(120, 100%, 40%);">+ /*! Memorize if this endpoint was choosen by the MGW (wildcarded, true)</span><br><span> * or if the user has choosen the particular endpoint explicitly. */</span><br><span> bool wildcarded_req;</span><br><span> };</span><br><span>diff --git a/include/osmocom/mgcp/mgcp_internal.h b/include/osmocom/mgcp/mgcp_internal.h</span><br><span>index b564905..7712593 100644</span><br><span>--- a/include/osmocom/mgcp/mgcp_internal.h</span><br><span>+++ b/include/osmocom/mgcp/mgcp_internal.h</span><br><span>@@ -221,33 +221,33 @@</span><br><span> </span><br><span> /*! MGCP connection (untyped) */</span><br><span> struct mgcp_conn {</span><br><span style="color: hsl(0, 100%, 40%);">- /*!< list head */</span><br><span style="color: hsl(120, 100%, 40%);">+ /*! list head */</span><br><span> struct llist_head entry;</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">- /*!< Backpointer to the endpoint where the conn belongs to */</span><br><span style="color: hsl(120, 100%, 40%);">+ /*! Backpointer to the endpoint where the conn belongs to */</span><br><span> struct mgcp_endpoint *endp;</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">- /*!< type of the connection (union) */</span><br><span style="color: hsl(120, 100%, 40%);">+ /*! type of the connection (union) */</span><br><span> enum mgcp_conn_type type;</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">- /*!< mode of the connection */</span><br><span style="color: hsl(120, 100%, 40%);">+ /*! mode of the connection */</span><br><span> enum mgcp_connection_mode mode;</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">- /*!< copy of the mode to restore the original setting (VTY) */</span><br><span style="color: hsl(120, 100%, 40%);">+ /*! copy of the mode to restore the original setting (VTY) */</span><br><span> enum mgcp_connection_mode mode_orig;</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">- /*!< connection id to identify the connection */</span><br><span style="color: hsl(120, 100%, 40%);">+ /*! connection id to identify the connection */</span><br><span> char id[MGCP_CONN_ID_LENGTH];</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">- /*!< human readable name (vty, logging) */</span><br><span style="color: hsl(120, 100%, 40%);">+ /*! human readable name (vty, logging) */</span><br><span> char name[256];</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">- /*!< union with connection description */</span><br><span style="color: hsl(120, 100%, 40%);">+ /*! union with connection description */</span><br><span> union {</span><br><span> struct mgcp_conn_rtp rtp;</span><br><span> } u;</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">- /*!< pointer to optional private data */</span><br><span style="color: hsl(120, 100%, 40%);">+ /*! pointer to optional private data */</span><br><span> void *priv;</span><br><span> };</span><br><span> </span><br><span>diff --git a/include/osmocom/mgcp_client/mgcp_client.h b/include/osmocom/mgcp_client/mgcp_client.h</span><br><span>index 3cecb8f..19c684d 100644</span><br><span>--- a/include/osmocom/mgcp_client/mgcp_client.h</span><br><span>+++ b/include/osmocom/mgcp_client/mgcp_client.h</span><br><span>@@ -46,10 +46,10 @@</span><br><span> /*! Structure to build a payload type map to allow the defiition custom payload</span><br><span> * types. */</span><br><span> struct ptmap {</span><br><span style="color: hsl(0, 100%, 40%);">- /*!< codec for which a payload type number should be defined */</span><br><span style="color: hsl(120, 100%, 40%);">+ /*! codec for which a payload type number should be defined */</span><br><span> enum mgcp_codecs codec;</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">- /*!< payload type number (96-127) */</span><br><span style="color: hsl(120, 100%, 40%);">+ /*! payload type number (96-127) */</span><br><span> unsigned int pt;</span><br><span> };</span><br><span> </span><br><span>diff --git a/include/osmocom/mgcp_client/mgcp_client_fsm.h b/include/osmocom/mgcp_client/mgcp_client_fsm.h</span><br><span>index 47d9fab..353baff 100644</span><br><span>--- a/include/osmocom/mgcp_client/mgcp_client_fsm.h</span><br><span>+++ b/include/osmocom/mgcp_client/mgcp_client_fsm.h</span><br><span>@@ -14,25 +14,25 @@</span><br><span> * identifier is supplied it is checked against the internal state to make</span><br><span> * sure it is correct. */</span><br><span> struct mgcp_conn_peer {</span><br><span style="color: hsl(0, 100%, 40%);">- /*!< RTP connection IP-Address (optional, string e.g. "127.0.0.1") */</span><br><span style="color: hsl(120, 100%, 40%);">+ /*! RTP connection IP-Address (optional, string e.g. "127.0.0.1") */</span><br><span> char addr[INET_ADDRSTRLEN];</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">- /*!< RTP connection IP-Port (optional) */</span><br><span style="color: hsl(120, 100%, 40%);">+ /*! RTP connection IP-Port (optional) */</span><br><span> uint16_t port;</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">- /*!< RTP endpoint */</span><br><span style="color: hsl(120, 100%, 40%);">+ /*! RTP endpoint */</span><br><span> char endpoint[MGCP_ENDPOINT_MAXLEN];</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">- /*!< CALL ID (unique per connection) */</span><br><span style="color: hsl(120, 100%, 40%);">+ /*! CALL ID (unique per connection) */</span><br><span> unsigned int call_id;</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">- /*!< RTP packetization interval (optional) */</span><br><span style="color: hsl(120, 100%, 40%);">+ /*! RTP packetization interval (optional) */</span><br><span> unsigned int ptime;</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">- /*!< RTP codec list (optional) */</span><br><span style="color: hsl(120, 100%, 40%);">+ /*! RTP codec list (optional) */</span><br><span> enum mgcp_codecs codecs[MGCP_MAX_CODECS];</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">- /*!< Number of codecs in RTP codec list (optional) */</span><br><span style="color: hsl(120, 100%, 40%);">+ /*! Number of codecs in RTP codec list (optional) */</span><br><span> unsigned int codecs_len;</span><br><span> };</span><br><span> </span><br><span></span><br></pre><p>To view, visit <a href="https://gerrit.osmocom.org/9741">change 9741</a>. To unsubscribe, or for help writing mail filters, visit <a href="https://gerrit.osmocom.org/settings">settings</a>.</p><div itemscope itemtype="http://schema.org/EmailMessage"><div itemscope itemprop="action" itemtype="http://schema.org/ViewAction"><link itemprop="url" href="https://gerrit.osmocom.org/9741"/><meta itemprop="name" content="View Change"/></div></div>
<div style="display:none"> Gerrit-Project: osmo-mgw </div>
<div style="display:none"> Gerrit-Branch: master </div>
<div style="display:none"> Gerrit-MessageType: merged </div>
<div style="display:none"> Gerrit-Change-Id: I9e8ea0e3bd5ae5fcc0a6fae8e26e11baa8f35e27 </div>
<div style="display:none"> Gerrit-Change-Number: 9741 </div>
<div style="display:none"> Gerrit-PatchSet: 1 </div>
<div style="display:none"> Gerrit-Owner: Neels Hofmeyr <nhofmeyr@sysmocom.de> </div>
<div style="display:none"> Gerrit-Reviewer: Harald Welte <laforge@gnumonks.org> </div>
<div style="display:none"> Gerrit-Reviewer: Jenkins Builder </div>