This is merely a historical archive of years 2008-2021, before the migration to mailman3.
A maintained and still updated list archive can be found at https://lists.osmocom.org/hyperkitty/list/gerrit-log@lists.osmocom.org/.
dexter gerrit-no-reply at lists.osmocom.orgdexter has uploaded this change for review. ( https://gerrit.osmocom.org/c/osmo-mgw/+/18896 ) Change subject: cosmetic: fix doxygen ...................................................................... cosmetic: fix doxygen Change-Id: I31f7ccf748d09062dbb82f3e921a90e77db02a3d --- M src/libosmo-mgcp/mgcp_network.c 1 file changed, 46 insertions(+), 46 deletions(-) git pull ssh://gerrit.osmocom.org:29418/osmo-mgw refs/changes/96/18896/1 diff --git a/src/libosmo-mgcp/mgcp_network.c b/src/libosmo-mgcp/mgcp_network.c index 8efc6b7..1ad9c1a 100644 --- a/src/libosmo-mgcp/mgcp_network.c +++ b/src/libosmo-mgcp/mgcp_network.c @@ -75,8 +75,8 @@ } /*! Determine the local rtp bind IP-address. - * \param[out] addr caller provided memory to store the resulting IP-Address - * \param[in] endp mgcp endpoint, that holds a copy of the VTY parameters + * \param[out] addr caller provided memory to store the resulting IP-Address. + * \param[in] endp mgcp endpoint, that holds a copy of the VTY parameters. * * The local bind IP-address is automatically selected by probing the * IP-Address of the interface that is pointing towards the remote IP-Address, @@ -145,12 +145,12 @@ } /*! send udp packet. - * \param[in] fd associated file descriptor - * \param[in] addr destination ip-address - * \param[in] port destination UDP port (network byte order) - * \param[in] buf buffer that holds the data to be send - * \param[in] len length of the data to be sent - * \returns bytes sent, -1 on error */ + * \param[in] fd associated file descriptor. + * \param[in] addr destination ip-address. + * \param[in] port destination UDP port (network byte order). + * \param[in] buf buffer that holds the data to be send. + * \param[in] len length of the data to be sent. + * \returns bytes sent, -1 on error. */ int mgcp_udp_send(int fd, struct in_addr *addr, int port, char *buf, int len) { struct sockaddr_in out; @@ -167,9 +167,9 @@ } /*! send RTP dummy packet (to keep NAT connection open). - * \param[in] endp mcgp endpoint that holds the RTP connection - * \param[in] conn associated RTP connection - * \returns bytes sent, -1 on error */ + * \param[in] endp mcgp endpoint that holds the RTP connection. + * \param[in] conn associated RTP connection. + * \returns bytes sent, -1 on error. */ int mgcp_send_dummy(struct mgcp_endpoint *endp, struct mgcp_conn_rtp *conn) { static char buf[] = { MGCP_DUMMY_LOAD }; @@ -395,12 +395,12 @@ } /*! dummy callback to disable transcoding (see also cfg->rtp_processing_cb). - * \param[in] associated endpoint - * \param[in] destination RTP end - * \param[in,out] pointer to buffer with voice data - * \param[in] voice data length - * \param[in] maximum size of caller provided voice data buffer - * \returns ignores input parameters, return always 0 */ + * \param[in] associated endpoint. + * \param[in] destination RTP end. + * \param[in,out] pointer to buffer with voice data. + * \param[in] voice data length. + * \param[in] maximum size of caller provided voice data buffer. + * \returns ignores input parameters, return always 0. */ int mgcp_rtp_processing_default(struct mgcp_endpoint *endp, struct mgcp_rtp_end *dst_end, char *data, int *len, int buf_size) @@ -410,10 +410,10 @@ } /*! dummy callback to disable transcoding (see also cfg->setup_rtp_processing_cb). - * \param[in] associated endpoint - * \param[in] destination RTP connnection - * \param[in] source RTP connection - * \returns ignores input parameters, return always 0 */ + * \param[in] associated endpoint. + * \param[in] destination RTP connnection. + * \param[in] source RTP connection. + * \returns ignores input parameters, return always 0. */ int mgcp_setup_rtp_processing_default(struct mgcp_endpoint *endp, struct mgcp_conn_rtp *conn_dst, struct mgcp_conn_rtp *conn_src) @@ -803,14 +803,14 @@ } /*! Send RTP/RTCP data to a specified destination connection. - * \param[in] endp associated endpoint (for configuration, logging) - * \param[in] is_rtp flag to specify if the packet is of type RTP or RTCP - * \param[in] spoofed source address (set to NULL to disable) - * \param[in] buf buffer that contains the RTP/RTCP data - * \param[in] len length of the buffer that contains the RTP/RTCP data - * \param[in] conn_src associated source connection - * \param[in] conn_dst associated destination connection - * \returns 0 on success, -1 on ERROR */ + * \param[in] endp associated endpoint (for configuration, logging). + * \param[in] is_rtp flag to specify if the packet is of type RTP or RTCP. + * \param[in] spoofed source address (set to NULL to disable). + * \param[in] buf buffer that contains the RTP/RTCP data. + * \param[in] len length of the buffer that contains the RTP/RTCP data. + * \param[in] conn_src associated source connection. + * \param[in] conn_dst associated destination connection. + * \returns 0 on success, -1 on ERROR. */ int mgcp_send(struct mgcp_endpoint *endp, int is_rtp, struct sockaddr_in *addr, char *buf, int len, struct mgcp_conn_rtp *conn_src, struct mgcp_conn_rtp *conn_dst) @@ -1259,12 +1259,12 @@ } /*! dispatch incoming RTP packet to opposite RTP connection. - * \param[in] proto protocol (MGCP_CONN_TYPE_RTP or MGCP_CONN_TYPE_RTCP) - * \param[in] addr socket address where the RTP packet has been received from - * \param[in] buf buffer that hold the RTP payload - * \param[in] buf_size size data length of buf - * \param[in] conn originating connection - * \returns 0 on success, -1 on ERROR */ + * \param[in] proto protocol (MGCP_CONN_TYPE_RTP or MGCP_CONN_TYPE_RTCP). + * \param[in] addr socket address where the RTP packet has been received from. + * \param[in] buf buffer that hold the RTP payload. + * \param[in] buf_size size data length of buf. + * \param[in] conn originating connection. + * \returns 0 on success, -1 on ERROR. */ int mgcp_dispatch_rtp_bridge_cb(int proto, struct sockaddr_in *addr, char *buf, unsigned int buf_size, struct mgcp_conn *conn) { @@ -1399,9 +1399,9 @@ } /*! set IP Type of Service parameter. - * \param[in] fd associated file descriptor - * \param[in] tos dscp value - * \returns 0 on success, -1 on ERROR */ + * \param[in] fd associated file descriptor. + * \param[in] tos dscp value. + * \returns 0 on success, -1 on ERROR. */ int mgcp_set_ip_tos(int fd, int tos) { int ret; @@ -1413,10 +1413,10 @@ } /*! bind RTP port to osmo_fd. - * \param[in] source_addr source (local) address to bind on - * \param[in] fd associated file descriptor - * \param[in] port to bind on - * \returns 0 on success, -1 on ERROR */ + * \param[in] source_addr source (local) address to bind on. + * \param[in] fd associated file descriptor. + * \param[in] port to bind on. + * \returns 0 on success, -1 on ERROR. */ int mgcp_create_bind(const char *source_addr, struct osmo_fd *fd, int port) { int rc; @@ -1492,10 +1492,10 @@ } /*! bind RTP port to endpoint/connection. - * \param[in] endp endpoint that holds the RTP connection - * \param[in] rtp_port port number to bind on - * \param[in] conn associated RTP connection - * \returns 0 on success, -1 on ERROR */ + * \param[in] endp endpoint that holds the RTP connection. + * \param[in] rtp_port port number to bind on. + * \param[in] conn associated RTP connection. + * \returns 0 on success, -1 on ERROR. */ int mgcp_bind_net_rtp_port(struct mgcp_endpoint *endp, int rtp_port, struct mgcp_conn_rtp *conn) { -- To view, visit https://gerrit.osmocom.org/c/osmo-mgw/+/18896 To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings Gerrit-Project: osmo-mgw Gerrit-Branch: master Gerrit-Change-Id: I31f7ccf748d09062dbb82f3e921a90e77db02a3d Gerrit-Change-Number: 18896 Gerrit-PatchSet: 1 Gerrit-Owner: dexter <pmaier at sysmocom.de> Gerrit-MessageType: newchange -------------- next part -------------- An HTML attachment was scrubbed... URL: <http://lists.osmocom.org/pipermail/gerrit-log/attachments/20200618/3185a3d0/attachment.htm>