From 0ffb648210318e5c1397b4be2186c87830ffc5f2 Mon Sep 17 00:00:00 2001 From: "David B. Kinder" Date: Wed, 19 Apr 2017 11:05:01 -0700 Subject: [PATCH] spell: fix doxygen comment typos: /subsys Fix doxygen comment typos used to generate API docs Change-Id: I3efff6f5fa26f87d1e658d6336fef01ce45f5bb0 Signed-off-by: David B. Kinder --- subsys/bluetooth/controller/ticker/ticker.h | 2 +- subsys/logging/event_logger.c | 4 ++-- subsys/net/ip/6lo.h | 2 +- subsys/net/ip/ipv6.h | 18 +++++++++--------- .../net/ip/l2/ieee802154/ieee802154_fragment.c | 4 ++-- .../net/ip/l2/ieee802154/ieee802154_fragment.h | 10 +++++----- subsys/net/ip/nbr.h | 2 +- subsys/net/ip/rpl.h | 2 +- subsys/net/lib/dns/dns_pack.h | 4 ++-- subsys/usb/class/cdc_acm.c | 2 +- subsys/usb/usb_device.c | 2 +- 11 files changed, 26 insertions(+), 26 deletions(-) diff --git a/subsys/bluetooth/controller/ticker/ticker.h b/subsys/bluetooth/controller/ticker/ticker.h index e065d1d7975..18607123adb 100644 --- a/subsys/bluetooth/controller/ticker/ticker.h +++ b/subsys/bluetooth/controller/ticker/ticker.h @@ -88,7 +88,7 @@ typedef void (*ticker_op_func) (uint32_t status, void *op_context); * * \param[in] instance_index Timer mode instance 0 or 1 (uses RTC0 CMP0 or * CMP1 respectively). -* \param[in] count_node Max. no. of ticker nodes to initialise. +* \param[in] count_node Max. no. of ticker nodes to initialize. * \param[in] node * \param[in] count_user * \param[in] user diff --git a/subsys/logging/event_logger.c b/subsys/logging/event_logger.c index 11a659fcaed..9722508751d 100644 --- a/subsys/logging/event_logger.c +++ b/subsys/logging/event_logger.c @@ -50,12 +50,12 @@ void sys_event_logger_put(struct event_logger *logger, uint16_t event_id, /** * @brief Send an event message to the logger with a non preemptible - * behaviour. + * behavior. * * @details Add an event message to the ring buffer and signal the sync * semaphore using the internal function _sem_give_non_preemptible to inform * that there are event messages available, avoiding the preemptible - * behaviour when the function is called from a task. This function + * behavior when the function is called from a task. This function * should be only used for special cases where the sys_event_logger_put * does not satisfy the needs. * diff --git a/subsys/net/ip/6lo.h b/subsys/net/ip/6lo.h index e521ea7d96d..06a3641d501 100644 --- a/subsys/net/ip/6lo.h +++ b/subsys/net/ip/6lo.h @@ -38,7 +38,7 @@ bool net_6lo_compress(struct net_buf *buf, bool iphc, fragment_handler_t fragment); /** - * @brief Unompress IPv6 packet as per RFC 6282 + * @brief Uncompress IPv6 packet as per RFC 6282 * * @details After this IPv6 packet and next header(if UDP), headers * are uncompressed as per RFC 6282. After header uncompression data diff --git a/subsys/net/ip/ipv6.h b/subsys/net/ip/ipv6.h index 1bd0be00548..3cd1a6c4cab 100644 --- a/subsys/net/ip/ipv6.h +++ b/subsys/net/ip/ipv6.h @@ -240,12 +240,12 @@ typedef void (*net_nbr_cb_t)(struct net_nbr *nbr, void *user_data); struct net_buf *net_ipv6_prepare_for_send(struct net_buf *buf); /** - * @brief Look for a neighbour from it's address on an iface + * @brief Look for a neighbor from it's address on an iface * * @param iface A valid pointer on a network interface * @param addr The IPv6 address to match * - * @return A valid pointer on a neighbour on success, NULL otherwise + * @return A valid pointer on a neighbor on success, NULL otherwise */ struct net_nbr *net_ipv6_nbr_lookup(struct net_if *iface, struct in6_addr *addr); @@ -257,26 +257,26 @@ struct net_nbr *net_ipv6_nbr_lookup(struct net_if *iface, * whatever interface there is configured for the neighbor address. * @param idx Index of the link layer address in the address array * - * @return A valid pointer on a neighbour on success, NULL otherwise + * @return A valid pointer on a neighbor on success, NULL otherwise */ struct net_nbr *net_ipv6_get_nbr(struct net_if *iface, uint8_t idx); /** - * @brief Look for a neighbour from it's link local address index + * @brief Look for a neighbor from it's link local address index * * @param iface Network interface to match. If NULL, then use * whatever interface there is configured for the neighbor address. * @param idx Index of the link layer address in the address array * - * @return A valid pointer on a neighbour on success, NULL otherwise + * @return A valid pointer on a neighbor on success, NULL otherwise */ struct in6_addr *net_ipv6_nbr_lookup_by_index(struct net_if *iface, uint8_t idx); /** - * @brief Add a neighbour to neighbor cache + * @brief Add a neighbor to neighbor cache * - * Add a neighbour to the cache after performing a lookup and in case + * Add a neighbor to the cache after performing a lookup and in case * there exists an entry in the cache update its state and lladdr. * * @param iface A valid pointer on a network interface @@ -286,7 +286,7 @@ struct in6_addr *net_ipv6_nbr_lookup_by_index(struct net_if *iface, * otherwise * @param state Initial state of the neighbor entry in the cache * - * @return A valid pointer on a neighbour on success, NULL otherwise + * @return A valid pointer on a neighbor on success, NULL otherwise */ struct net_nbr *net_ipv6_nbr_add(struct net_if *iface, struct in6_addr *addr, @@ -295,7 +295,7 @@ struct net_nbr *net_ipv6_nbr_add(struct net_if *iface, enum net_ipv6_nbr_state state); /** - * @brief Remove a neighbour from neighbor cache. + * @brief Remove a neighbor from neighbor cache. * * @param iface A valid pointer on a network interface * @param addr Neighbor IPv6 address diff --git a/subsys/net/ip/l2/ieee802154/ieee802154_fragment.c b/subsys/net/ip/l2/ieee802154/ieee802154_fragment.c index 9cc33f27bf4..e7e587d093f 100644 --- a/subsys/net/ip/l2/ieee802154/ieee802154_fragment.c +++ b/subsys/net/ip/l2/ieee802154/ieee802154_fragment.c @@ -32,7 +32,7 @@ static uint16_t datagram_tag; /** - * Reasseble cache : Depends on cache size it used for reassemble + * Reassemble cache : Depends on cache size it used for reassemble * IPv6 packets simultaneously. */ struct frag_cache { @@ -364,7 +364,7 @@ static void reass_timeout(struct k_work *work) } /** - * Upon receiption of first fragment with respective of size and tag + * Upon reception of first fragment with respective of size and tag * create a new cache. If number of unused cache are out then * discard the fragments. */ diff --git a/subsys/net/ip/l2/ieee802154/ieee802154_fragment.h b/subsys/net/ip/l2/ieee802154/ieee802154_fragment.h index 92517d71211..803d111b10e 100644 --- a/subsys/net/ip/l2/ieee802154/ieee802154_fragment.h +++ b/subsys/net/ip/l2/ieee802154/ieee802154_fragment.h @@ -21,12 +21,12 @@ /** * @brief Fragment IPv6 packet as per RFC 6282 * - * @details After IPv6 compression, transimission of IPv6 over 802.15.4 - * needs to be fragmented. Every fragment will have frgmentation header + * @details After IPv6 compression, transmission of IPv6 over 802.15.4 + * needs to be fragmented. Every fragment will have fragmentation header * data size, data offset, data tag and payload. * * @param Pointer to network buffer - * @param Header difference between origianl IPv6 header and compressed header + * @param Header difference between original IPv6 header and compressed header * * @return True in case of success, false otherwise */ @@ -35,8 +35,8 @@ bool ieee802154_fragment(struct net_buf *buf, int hdr_diff); /** * @brief Reassemble 802.15.4 fragments as per RFC 6282 * - * @details If the data does not fit into sinle fragment whole IPv6 packet - * comes in number of fragments. This funtion will reassemble them all as + * @details If the data does not fit into single fragment whole IPv6 packet + * comes in number of fragments. This function will reassemble them all as * per data tag, data offset and data size. First packet is uncompressed * immediately after reception. * diff --git a/subsys/net/ip/nbr.h b/subsys/net/ip/nbr.h index 09570219d46..cb391a4eea9 100644 --- a/subsys/net/ip/nbr.h +++ b/subsys/net/ip/nbr.h @@ -151,7 +151,7 @@ struct net_nbr *net_nbr_ref(struct net_nbr *nbr); /** * @brief Get a free neighbor from specific table. * @param table Neighbor table - * @return Pointer to neighbor, NULL if no free neigtbors + * @return Pointer to neighbor, NULL if no free neighbors */ struct net_nbr *net_nbr_get(struct net_nbr_table *table); diff --git a/subsys/net/ip/rpl.h b/subsys/net/ip/rpl.h index 06b9c126603..bc0daa0e1c1 100644 --- a/subsys/net/ip/rpl.h +++ b/subsys/net/ip/rpl.h @@ -130,7 +130,7 @@ extern "C" { * RPL modes * * The RPL module can be in either of three modes: mesh mode - * (NET_RPL_MODE_MESH), feater mode (NET_RPL_MODE_FEATHER), and leaf mode + * (NET_RPL_MODE_MESH), feather mode (NET_RPL_MODE_FEATHER), and leaf mode * (NET_RPL_MODE_LEAF). In mesh mode, nodes forward data for other nodes, * and are reachable by others. In feather mode, nodes can forward * data for other nodes, but are not reachable themselves. In leaf diff --git a/subsys/net/lib/dns/dns_pack.h b/subsys/net/lib/dns/dns_pack.h index 8b50243cd7a..1cfcf75bf05 100644 --- a/subsys/net/lib/dns/dns_pack.h +++ b/subsys/net/lib/dns/dns_pack.h @@ -265,7 +265,7 @@ int dns_unpack_answer(struct dns_msg_t *dns_msg, int dname_ptr, uint32_t *ttl); * @retval -ENOMEM if the buffer in msg has no enough space to store the header. * The header is always 12 bytes length. * @retval -EINVAL if the src_id does not match the header's id, or if the - * eader's QR value is not DNS_RESPONSE or if the header's OPCODE value is not + * header's QR value is not DNS_RESPONSE or if the header's OPCODE value is not * DNS_QUERY, or if the header's Z value is not 0 or if the question counter * is not 1 or the answer counter is less than 1. * @retval RFC 1035 RCODEs (> 0) 1 Format error, 2 Server failure, 3 Name Error, @@ -281,7 +281,7 @@ int dns_unpack_response_header(struct dns_msg_t *msg, int src_id); * @param size Buffer size * @param qname Domain name represented as a sequence of labels. * See RFC 1035, 4.1.2. Question section format. - * @param qname_len Number of octects in qname. + * @param qname_len Number of octets in qname. * @param id Transaction Identifier * @param qtype Query type: AA, AAAA. See enum dns_rr_type * @retval 0 on success diff --git a/subsys/usb/class/cdc_acm.c b/subsys/usb/class/cdc_acm.c index 8eb2bdc0ca7..24769135a99 100644 --- a/subsys/usb/class/cdc_acm.c +++ b/subsys/usb/class/cdc_acm.c @@ -488,7 +488,7 @@ static void cdc_acm_baudrate_set(struct device *dev, uint32_t baudrate) * * @param dev CDC ACM device struct. * - * @return 0 allways. + * @return 0 always. */ static int cdc_acm_init(struct device *dev) { diff --git a/subsys/usb/usb_device.c b/subsys/usb/usb_device.c index 4465edc1ac8..948c5b77a23 100644 --- a/subsys/usb/usb_device.c +++ b/subsys/usb/usb_device.c @@ -49,7 +49,7 @@ * callback is called. * When an IN request arrives, the callback is called immediately to either * put the control transfer data in the data store, or to get a pointer to - * control transfer data. The data is then packetised and sent to the host. + * control transfer data. The data is then packetized and sent to the host. * * Standard request handler handles the 'chapter 9' processing, specifically * the standard device requests in table 9-3 from the universal serial bus