doxygen: Trivial cleanups.
authorAndre Noll <maan@tuebingen.mpg.de>
Fri, 19 May 2017 06:22:15 +0000 (08:22 +0200)
committerAndre Noll <maan@tuebingen.mpg.de>
Sun, 25 Jun 2017 18:11:08 +0000 (20:11 +0200)
A couple of capitalization and punctuation fixes.

audiod.c
mood.c
net.c
net.h
string.c

index 20902c3..5272890 100644 (file)
--- a/audiod.c
+++ b/audiod.c
@@ -165,8 +165,8 @@ struct status_task {
 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;
 
@@ -177,7 +177,7 @@ static struct status_task status_task_struct;
 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
  */
@@ -186,11 +186,11 @@ static struct status_task *stat_task = &status_task_struct;
 struct command_task {
        /** The local listening socket. */
        int fd;
-       /** the associated task structure */
+       /** The associated task structure. */
        struct task *task;
 };
 
-/** 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++)
 
 /**
diff --git a/mood.c b/mood.c
index acc5583..9b00e61 100644 (file)
--- a/mood.c
+++ b/mood.c
@@ -82,7 +82,7 @@ struct mood {
 
 /*
  * 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;
 
diff --git a/net.c b/net.c
index 5024367..983ab0c 100644 (file)
--- a/net.c
+++ b/net.c
@@ -44,7 +44,7 @@
  *               default of 32 if not specified.
  *
  * \return Pointer to \a addr if successful, NULL on error.
- * \sa RFC 4632
+ * \sa RFC 4632.
  */
 char *parse_cidr(const char *cidr,
                 char    *addr, ssize_t addrlen,
@@ -104,7 +104,7 @@ static bool is_v4_dot_quad(const char *address)
  * \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)
 {
@@ -146,7 +146,7 @@ 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.
  *
- * \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,
@@ -191,7 +191,7 @@ failed:
  * \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)
 {
@@ -215,7 +215,7 @@ const char *stringify_port(int port, const char *transport)
  *
  * \param l4type The symbolic name of the transport-layer protocol.
  *
- * \sa ip(7), socket(2)
+ * \sa ip(7), socket(2).
  */
 static inline int sock_type(const unsigned l4type)
 {
@@ -288,7 +288,7 @@ struct flowopts *flowopt_new(void)
  * \param val  The value to set \a opt to.
  * \param len  Length of \a val.
  *
- *  \sa setsockopt(2)
+ *  \sa setsockopt(2).
  */
 void flowopt_add(struct flowopts *fo, int lev, int opt,
                const char *name, const void *val, int len)
@@ -505,7 +505,7 @@ int makesock(unsigned l4type, bool passive, const char *host, uint16_t port_numb
  * \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)
 {
@@ -551,7 +551,7 @@ static bool SS_IS_ADDR_V4MAPPED(const struct sockaddr_storage *ss)
  * \param ss Container of IPv4/6 address.
  * \return Pointer to normalized address (may be static storage).
  *
- * \sa RFC 3493
+ * \sa RFC 3493.
  */
 static const struct sockaddr *
 normalize_ip_address(const struct sockaddr_storage *ss)
diff --git a/net.h b/net.h
index a70954a..a8dd650 100644 (file)
--- a/net.h
+++ b/net.h
@@ -93,7 +93,7 @@ _static_inline_ bool is_valid_ipv4_address(const char *address)
  * \param address The address string to check.
  *
  * \return 1 if string has a valid IPv6 address syntax, 0 if not.
- * \sa RFC 4291
+ * \sa RFC 4291.
  */
 _static_inline_ bool is_valid_ipv6_address(const char *address)
 {
index 6033a00..7b80e1b 100644 (file)
--- a/string.c
+++ b/string.c
@@ -230,7 +230,7 @@ void freep(void *arg)
  * 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.
  *
- * \sa strcat(3)
+ * \sa strcat(3).
  */
 __must_check __malloc char *para_strcat(char *a, const char *b)
 {