Fix a few typos in the man pages

[catta] / avahi-common / address.h

diff --git a/avahi-common/address.h b/avahi-common/address.h
index 95eb3923b1ffde3432eb19016395e492625028ff..6023a0303a888427aa51d94917bf426f2534a408 100644 (file)
--- a/avahi-common/address.h
+++ b/avahi-common/address.h
@@ -29,9 +29,7 @@
 
 #include <avahi-common/cdecl.h>
 
-#ifndef DOXYGEN_SHOULD_SKIP_THIS
 AVAHI_C_DECL_BEGIN
-#endif
 
 /** Protocol family specification, takes the values AVAHI_PROTO_INET, AVAHI_PROTO_INET6, AVAHI_PROTO_UNSPEC */
 typedef int AvahiProtocol;
@@ -55,45 +53,57 @@ enum {
 #define AVAHI_ADDRESS_STR_MAX 40 /* IPv6 Max = 4*8 + 7 + 1 for NUL */
 
 /** Return TRUE if the specified interface index is valid */
-#define AVAHI_IF_VALID(ifindex) (((ifindex) >= 0) || ((ifindex) == AVAHI_PROTO_UNSPEC))
+#define AVAHI_IF_VALID(ifindex) (((ifindex) >= 0) || ((ifindex) == AVAHI_IF_UNSPEC))
 
 /** Return TRUE if the specified protocol is valid */
 #define AVAHI_PROTO_VALID(protocol) (((protocol) == AVAHI_PROTO_INET) || ((protocol) == AVAHI_PROTO_INET6) || ((protocol) == AVAHI_PROTO_UNSPEC))
 
 /** An IPv4 address */
-typedef struct {
+typedef struct AvahiIPv4Address {
     uint32_t address; /**< Address data in network byte order. */
 } AvahiIPv4Address;
 
 /** An IPv6 address */
-typedef struct {
+typedef struct AvahiIPv6Address {
     uint8_t address[16]; /**< Address data */
 } AvahiIPv6Address;
 
 /** Protocol (address family) independent address structure */
-typedef struct {
+typedef struct AvahiAddress {
     AvahiProtocol proto; /**< Address family */
 
     union {
-        AvahiIPv6Address ipv6;  /** Address when IPv6 */
-        AvahiIPv4Address ipv4;  /** Address when IPv4 */
-        uint8_t data[1];        /** Type independant data field */
+        AvahiIPv6Address ipv6;  /**< Address when IPv6 */
+        AvahiIPv4Address ipv4;  /**< Address when IPv4 */
+        uint8_t data[1];        /**< Type-independent data field */
     } data;
 } AvahiAddress;
 
+/** @{ \name Comparison */
+
 /** Compare two addresses. Returns 0 when equal, a negative value when a < b, a positive value when a > b. */
 int avahi_address_cmp(const AvahiAddress *a, const AvahiAddress *b);
 
+/** @} */
+
+/** @{ \name String conversion */
+
 /** Convert the specified address *a to a human readable character string, use AVAHI_ADDRESS_STR_MAX to allocate an array of the right size */
 char *avahi_address_snprint(char *ret_s, size_t length, const AvahiAddress *a);
 
-/** Convert the specifeid human readable character string to an
+/** Convert the specified human readable character string to an
  * address structure. Set af to AVAHI_UNSPEC for automatic address
  * family detection. */
 AvahiAddress *avahi_address_parse(const char *s, AvahiProtocol af, AvahiAddress *ret_addr);
 
+/** @} */
+
+/** \cond fulldocs */
 /** Generate the DNS reverse lookup name for an IPv4 or IPv6 address. */
-char* avahi_reverse_lookup_name(char *ret_s, size_t length, const AvahiAddress *a);
+char* avahi_reverse_lookup_name(const AvahiAddress *a, char *ret_s, size_t length);
+/** \endcond */
+
+/** @{ \name Protocol/address family handling */
 
 /** Map AVAHI_PROTO_xxx constants to Unix AF_xxx constants */
 int avahi_proto_to_af(AvahiProtocol proto);
@@ -104,8 +114,8 @@ AvahiProtocol avahi_af_to_proto(int af);
 /** Return a textual representation of the specified protocol number. i.e. "IPv4", "IPv6" or "UNSPEC" */
 const char* avahi_proto_to_string(AvahiProtocol proto);
 
-#ifndef DOXYGEN_SHOULD_SKIP_THIS
+/** @} */
+
 AVAHI_C_DECL_END
-#endif
 
 #endif