minor doxygen updates (#125)

This commit is contained in:
Alfred E. Heggestad 2018-04-04 19:57:14 +02:00 committed by Richard Aas
parent 6bbb5eb45c
commit 72e89eeeae
5 changed files with 32 additions and 7 deletions

View file

@ -8,7 +8,9 @@
#include "../mqueue.h"
/** Emulate pipe on Windows -- pipe() with select() is not working */
/*
* Emulate pipe on Windows -- pipe() with select() is not working
*/
int pipe(int fds[2])
{
SOCKET s, rd, wr;

View file

@ -26,7 +26,12 @@
#define UNIX_NTP_OFFSET 0x83aa7e80
/** Convert from Unix time to NTP time */
/**
* Convert from Unix time to NTP time
*
* @param ntp NTP time to convert to (output)
* @param tv Unix time to convert from (input)
*/
void unix2ntp(struct ntp_time *ntp, const struct timeval *tv)
{
ntp->hi = (uint32_t)(tv->tv_sec + UNIX_NTP_OFFSET);
@ -34,7 +39,12 @@ void unix2ntp(struct ntp_time *ntp, const struct timeval *tv)
}
/** Convert from NTP time to Unix time */
/**
* Convert from NTP time to Unix time
*
* @param tv Unix time to convert to (output)
* @param ntp NTP time to convert from (input)
*/
void ntp2unix(struct timeval *tv, const struct ntp_time *ntp)
{
tv->tv_sec = ntp->hi - UNIX_NTP_OFFSET;
@ -64,14 +74,26 @@ int ntp_time_get(struct ntp_time *ntp)
}
/** Convert NTP time to middle 32-bits (compact representation) */
/**
* Convert NTP time to middle 32-bits (compact representation)
*
* @param ntp NTP time
*
* @return NTP time in compact representation
*/
uint32_t ntp_compact(const struct ntp_time *ntp)
{
return ntp ? ((ntp->hi & 0xffff) << 16 | (ntp->lo >> 16)) : 0;
}
/** Convert NTP compact representation to microseconds */
/**
* Convert NTP compact representation to microseconds
*
* @param ntpc NTP time in compact representation
*
* @return NTP time in microseconds
*/
uint64_t ntp_compact2us(uint32_t ntpc)
{
const uint32_t hi = (ntpc >> 16) & 0xffff;

View file

@ -36,7 +36,7 @@ void source_init_seq(struct rtp_source *s, uint16_t seq)
}
/**
/*
* See RFC 3550 - A.1 RTP Data Header Validity Checks
*/
int source_update_seq(struct rtp_source *s, uint16_t seq)

View file

@ -158,7 +158,7 @@ inet_ntop6(const u_char *src, char *dst, size_t size)
#endif
/**
/*
* Implementation of inet_ntop()
*/
const char* inet_ntop(int af, const void *src, char *dst, size_t size);

View file

@ -5,6 +5,7 @@
*/
/** SRTP Protocol values */
enum {
GCM_TAGLEN = 16, /**< GCM taglength in bytes */
};