A couple of capitalization and punctuation fixes.
char *stat_item_values[NUM_STAT_ITEMS] = {NULL};
/**
char *stat_item_values[NUM_STAT_ITEMS] = {NULL};
/**
- * the current mode of operation of which can be changed by the on/off/cycle
- * commands. It is either, AUDIOD_OFF, AUDIOD_ON or AUDIOD_STANDBY.
+ * The current mode of operation (AUDIOD_OFF, AUDIOD_ON or AUDIOD_STANDBY).
+ * Set by the on/off/cycle commands.
*/
int audiod_status = AUDIOD_ON;
*/
int audiod_status = AUDIOD_ON;
static uid_t *uid_whitelist;
/**
static uid_t *uid_whitelist;
/**
- * the task that calls the status command of para_server
+ * The task that calls the status command of para_server.
*
* \sa struct status_task
*/
*
* \sa struct status_task
*/
struct command_task {
/** The local listening socket. */
int fd;
struct command_task {
/** The local listening socket. */
int fd;
- /** the associated task structure */
+ /** The associated task structure. */
-/** iterate over all supported audio formats */
+/** Iterate over all supported audio formats. */
#define FOR_EACH_AUDIO_FORMAT(af) for (af = 0; af < NUM_AUDIO_FORMATS; af++)
/**
#define FOR_EACH_AUDIO_FORMAT(af) for (af = 0; af < NUM_AUDIO_FORMATS; af++)
/**
/*
* If current_mood is NULL then no mood is currently open. If
/*
* If current_mood is NULL then no mood is currently open. If
- * current_mood->name is NULL, the dummy mood is currently open
+ * current_mood->name is NULL, the dummy mood is currently open.
*/
static struct mood *current_mood;
*/
static struct mood *current_mood;
* default of 32 if not specified.
*
* \return Pointer to \a addr if successful, NULL on error.
* default of 32 if not specified.
*
* \return Pointer to \a addr if successful, NULL on error.
*/
char *parse_cidr(const char *cidr,
char *addr, ssize_t addrlen,
*/
char *parse_cidr(const char *cidr,
char *addr, ssize_t addrlen,
* \param host The host string to check.
* \return True if \a host passes the syntax checks.
*
* \param host The host string to check.
* \return True if \a host passes the syntax checks.
*
- * \sa RFC 3986, 3.2.2; RFC 1123, 2.1; RFC 1034, 3.5
+ * \sa RFC 3986, 3.2.2; RFC 1123, 2.1; RFC 1034, 3.5.
*/
static bool host_string_ok(const char *host)
{
*/
static bool host_string_ok(const char *host)
{
* \a host and \a port are undefined. If no port number was present in \a url,
* \a port is set to -1.
*
* \a host and \a port are undefined. If no port number was present in \a url,
* \a port is set to -1.
*
- * \sa RFC 3986, 3.2.2/3.2.3
+ * \sa RFC 3986, 3.2.2/3.2.3.
*/
char *parse_url(const char *url,
char *host, ssize_t hostlen,
*/
char *parse_url(const char *url,
char *host, ssize_t hostlen,
* \param transport Transport protocol name (e.g. "udp", "tcp"), or NULL.
* \return Pointer to static result buffer.
*
* \param transport Transport protocol name (e.g. "udp", "tcp"), or NULL.
* \return Pointer to static result buffer.
*
- * \sa getservent(3), services(5), nsswitch.conf(5)
+ * \sa getservent(3), services(5), nsswitch.conf(5).
*/
const char *stringify_port(int port, const char *transport)
{
*/
const char *stringify_port(int port, const char *transport)
{
*
* \param l4type The symbolic name of the transport-layer protocol.
*
*
* \param l4type The symbolic name of the transport-layer protocol.
*
+ * \sa ip(7), socket(2).
*/
static inline int sock_type(const unsigned l4type)
{
*/
static inline int sock_type(const unsigned l4type)
{
* \param val The value to set \a opt to.
* \param len Length of \a val.
*
* \param val The value to set \a opt to.
* \param len Length of \a val.
*
*/
void flowopt_add(struct flowopts *fo, int lev, int opt,
const char *name, const void *val, int len)
*/
void flowopt_add(struct flowopts *fo, int lev, int opt,
const char *name, const void *val, int len)
* \return Positive integer (socket descriptor) on success, negative value
* otherwise.
*
* \return Positive integer (socket descriptor) on success, negative value
* otherwise.
*
- * \sa makesock(), ip(7), ipv6(7), bind(2), listen(2).
+ * \sa \ref makesock(), ip(7), ipv6(7), bind(2), listen(2).
*/
int para_listen(unsigned l4type, uint16_t port, struct flowopts *fo)
{
*/
int para_listen(unsigned l4type, uint16_t port, struct flowopts *fo)
{
* \param ss Container of IPv4/6 address.
* \return Pointer to normalized address (may be static storage).
*
* \param ss Container of IPv4/6 address.
* \return Pointer to normalized address (may be static storage).
*
*/
static const struct sockaddr *
normalize_ip_address(const struct sockaddr_storage *ss)
*/
static const struct sockaddr *
normalize_ip_address(const struct sockaddr_storage *ss)
* \param address The address string to check.
*
* \return 1 if string has a valid IPv6 address syntax, 0 if not.
* \param address The address string to check.
*
* \return 1 if string has a valid IPv6 address syntax, 0 if not.
*/
_static_inline_ bool is_valid_ipv6_address(const char *address)
{
*/
_static_inline_ bool is_valid_ipv6_address(const char *address)
{
* return \a a without making a copy of \a a. Otherwise, construct the
* concatenation \a c, free \a a (but not \a b) and return \a c.
*
* return \a a without making a copy of \a a. Otherwise, construct the
* concatenation \a c, free \a a (but not \a b) and return \a c.
*
*/
__must_check __malloc char *para_strcat(char *a, const char *b)
{
*/
__must_check __malloc char *para_strcat(char *a, const char *b)
{