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_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;
};