summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorAlfred E. Heggestad <alfred.heggestad@gmail.com>2016-12-10 11:21:23 +0100
committerAlfred E. Heggestad <alfred.heggestad@gmail.com>2016-12-10 11:21:23 +0100
commit8330bae7c671443c6b78d7f94c34809da6f1bd18 (patch)
treeb8fa6e0f3f2f5fd225650bd5e22d7a8e04957ca3 /src
parent3aa871a496a36bc2a2b76fc2b326d7e19e493077 (diff)
update doxygen comments
Diffstat (limited to 'src')
-rw-r--r--src/audio.c4
-rw-r--r--src/call.c6
-rw-r--r--src/ua.c4
-rw-r--r--src/video.c12
4 files changed, 13 insertions, 13 deletions
diff --git a/src/audio.c b/src/audio.c
index c204755..43af671 100644
--- a/src/audio.c
+++ b/src/audio.c
@@ -76,7 +76,7 @@ enum {
*/
struct autx {
struct ausrc_st *ausrc; /**< Audio Source */
- struct ausrc_prm ausrc_prm;
+ struct ausrc_prm ausrc_prm; /**< Audio Source parameters */
const struct aucodec *ac; /**< Current audio encoder */
struct auenc_state *enc; /**< Audio encoder state (optional) */
struct aubuf *aubuf; /**< Packetize outgoing stream */
@@ -123,7 +123,7 @@ struct autx {
*/
struct aurx {
struct auplay_st *auplay; /**< Audio Player */
- struct auplay_prm auplay_prm;
+ struct auplay_prm auplay_prm; /**< Audio Player parameters */
const struct aucodec *ac; /**< Current audio decoder */
struct audec_state *dec; /**< Audio decoder state (optional) */
struct aubuf *aubuf; /**< Incoming audio buffer */
diff --git a/src/call.c b/src/call.c
index 48baaf0..704f04a 100644
--- a/src/call.c
+++ b/src/call.c
@@ -64,7 +64,7 @@ struct call {
time_t time_start; /**< Time when call started */
time_t time_conn; /**< Time when call initiated */
time_t time_stop; /**< Time when call stopped */
- bool outgoing;
+ bool outgoing; /**< True if outgoing, false if incoming */
bool got_offer; /**< Got SDP Offer from Peer */
bool on_hold; /**< True if call is on hold */
struct mnat_sess *mnats; /**< Media NAT session */
@@ -76,8 +76,8 @@ struct call {
call_dtmf_h *dtmfh; /**< DTMF handler */
void *arg; /**< Handler argument */
- struct config_avt config_avt;
- struct config_call config_call;
+ struct config_avt config_avt; /**< AVT config */
+ struct config_call config_call; /**< Call config */
uint32_t rtp_timeout_ms; /**< RTP Timeout in [ms] */
uint32_t linenum; /**< Line number from 1 to N */
diff --git a/src/ua.c b/src/ua.c
index c260c9d..0a85628 100644
--- a/src/ua.c
+++ b/src/ua.c
@@ -28,7 +28,7 @@ struct ua {
char *cuser; /**< SIP Contact username */
char *pub_gruu; /**< SIP Public GRUU */
int af; /**< Preferred Address Family */
- int af_media;
+ int af_media; /**< Preferred Address Family for media */
enum presence_status my_status; /**< Presence Status */
};
@@ -51,7 +51,7 @@ static struct {
bool use_tcp; /**< Use TCP transport */
bool use_tls; /**< Use TLS transport */
bool prefer_ipv6; /**< Force IPv6 transport */
- sip_msg_h *subh;
+ sip_msg_h *subh; /**< Subscribe handler */
ua_exit_h *exith; /**< UA Exit handler */
void *arg; /**< UA Exit handler argument */
char *eprm; /**< Extra UA parameters */
diff --git a/src/video.c b/src/video.c
index baadc60..6af81a9 100644
--- a/src/video.c
+++ b/src/video.c
@@ -92,12 +92,12 @@ struct vtx {
struct lock *lock; /**< Lock for encoder */
struct vidframe *frame; /**< Source frame */
struct vidframe *mute_frame; /**< Frame with muted video */
- struct lock *lock_tx; /**< Protect the sendq */
+ struct lock *lock_tx; /**< Protect the sendq */
struct list sendq; /**< Tx-Queue (struct vidqent) */
struct tmr tmr_rtp; /**< Timer for sending RTP */
- unsigned skipc; /**< Number of frames skipped */
+ unsigned skipc; /**< Number of frames skipped */
struct list filtl; /**< Filters in encoding order */
- char device[64];
+ char device[64]; /**< Source device name */
int muted_frames; /**< # of muted frames sent */
uint32_t ts_tx; /**< Outgoing RTP timestamp */
bool picup; /**< Send picture update */
@@ -133,7 +133,7 @@ struct vrx {
struct list filtl; /**< Filters in decoding order */
struct tmr tmr_picup; /**< Picture update timer */
enum vidorient orient; /**< Display orientation */
- char device[64];
+ char device[64]; /**< Display device name */
bool fullscreen; /**< Fullscreen flag */
int pt_rx; /**< Incoming RTP payload type */
int frames; /**< Number of frames received */
@@ -154,8 +154,8 @@ struct video {
bool started; /**< True if video is started */
char *peer; /**< Peer URI */
bool nack_pli; /**< Send NACK/PLI to peer */
- video_err_h *errh;
- void *arg;
+ video_err_h *errh; /**< Error handler */
+ void *arg; /**< Error handler argument */
};