michaelh/zephyr
1
0
Fork 0
Code Releases Activity

spell: fix doxygen comment typos: /subsys

Browse source 
Fix doxygen comment typos used to generate API docs

Change-Id: I3efff6f5fa26f87d1e658d6336fef01ce45f5bb0
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
This commit is contained in:
David B. Kinder 2017-04-19 11:05:01 -07:00 • committed by Anas Nashif
commit 0ffb648210
11 changed files with 26 additions and 26 deletions
Download patch file Download diff file Expand all files Collapse all files

2
subsys/bluetooth/controller/ticker/ticker.h
View file

@ -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 * \param[in] instance_index Timer mode instance 0 or 1 (uses RTC0 CMP0 or
* CMP1 respectively). * 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] node
* \param[in] count_user * \param[in] count_user
* \param[in] user * \param[in] user

4
subsys/logging/event_logger.c
View file

@ -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 * @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 * @details Add an event message to the ring buffer and signal the sync
* semaphore using the internal function _sem_give_non_preemptible to inform * semaphore using the internal function _sem_give_non_preemptible to inform
* that there are event messages available, avoiding the preemptible * 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 * should be only used for special cases where the sys_event_logger_put
* does not satisfy the needs. * does not satisfy the needs.
* *

2
subsys/net/ip/6lo.h
View file

@ -38,7 +38,7 @@ bool net_6lo_compress(struct net_buf *buf, bool iphc,
fragment_handler_t fragment); 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 * @details After this IPv6 packet and next header(if UDP), headers
* are uncompressed as per RFC 6282. After header uncompression data * are uncompressed as per RFC 6282. After header uncompression data

18
subsys/net/ip/ipv6.h
View file

@ -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); 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 iface A valid pointer on a network interface
* @param addr The IPv6 address to match * @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 net_nbr *net_ipv6_nbr_lookup(struct net_if *iface,
struct in6_addr *addr); 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. * whatever interface there is configured for the neighbor address.
* @param idx Index of the link layer address in the address array * @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); 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 * @param iface Network interface to match. If NULL, then use
* whatever interface there is configured for the neighbor address. * whatever interface there is configured for the neighbor address.
* @param idx Index of the link layer address in the address array * @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, struct in6_addr *net_ipv6_nbr_lookup_by_index(struct net_if *iface,
uint8_t idx); 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. * there exists an entry in the cache update its state and lladdr.
* *
* @param iface A valid pointer on a network interface * @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 * otherwise
* @param state Initial state of the neighbor entry in the cache * @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 net_nbr *net_ipv6_nbr_add(struct net_if *iface,
struct in6_addr *addr, 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); 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 iface A valid pointer on a network interface
* @param addr Neighbor IPv6 address * @param addr Neighbor IPv6 address

4
subsys/net/ip/l2/ieee802154/ieee802154_fragment.c
View file

@ -32,7 +32,7 @@
static uint16_t datagram_tag; 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. * IPv6 packets simultaneously.
*/ */
struct frag_cache { 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 * create a new cache. If number of unused cache are out then
* discard the fragments. * discard the fragments.
*/ */

10
subsys/net/ip/l2/ieee802154/ieee802154_fragment.h
View file

@ -21,12 +21,12 @@
/** /**
* @brief Fragment IPv6 packet as per RFC 6282 * @brief Fragment IPv6 packet as per RFC 6282
* *
* @details After IPv6 compression, transimission of IPv6 over 802.15.4 * @details After IPv6 compression, transmission of IPv6 over 802.15.4
* needs to be fragmented. Every fragment will have frgmentation header * needs to be fragmented. Every fragment will have fragmentation header
* data size, data offset, data tag and payload. * data size, data offset, data tag and payload.
* *
* @param Pointer to network buffer * @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 * @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 * @brief Reassemble 802.15.4 fragments as per RFC 6282
* *
* @details If the data does not fit into sinle fragment whole IPv6 packet * @details If the data does not fit into single fragment whole IPv6 packet
* comes in number of fragments. This funtion will reassemble them all as * comes in number of fragments. This function will reassemble them all as
* per data tag, data offset and data size. First packet is uncompressed * per data tag, data offset and data size. First packet is uncompressed
* immediately after reception. * immediately after reception.
* *

2
subsys/net/ip/nbr.h
View file

@ -151,7 +151,7 @@ struct net_nbr *net_nbr_ref(struct net_nbr *nbr);
/** /**
* @brief Get a free neighbor from specific table. * @brief Get a free neighbor from specific table.
* @param table Neighbor 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); struct net_nbr *net_nbr_get(struct net_nbr_table *table);

2
subsys/net/ip/rpl.h
View file

@ -130,7 +130,7 @@ extern "C" {
* RPL modes * RPL modes
* *
* The RPL module can be in either of three modes: mesh mode * 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, * (NET_RPL_MODE_LEAF). In mesh mode, nodes forward data for other nodes,
* and are reachable by others. In feather mode, nodes can forward * and are reachable by others. In feather mode, nodes can forward
* data for other nodes, but are not reachable themselves. In leaf * data for other nodes, but are not reachable themselves. In leaf

4
subsys/net/lib/dns/dns_pack.h
View file

@ -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. * @retval -ENOMEM if the buffer in msg has no enough space to store the header.
* The header is always 12 bytes length. * The header is always 12 bytes length.
* @retval -EINVAL if the src_id does not match the header's id, or if the * @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 * 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. * 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, * @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 size Buffer size
* @param qname Domain name represented as a sequence of labels. * @param qname Domain name represented as a sequence of labels.
* See RFC 1035, 4.1.2. Question section format. * 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 id Transaction Identifier
* @param qtype Query type: AA, AAAA. See enum dns_rr_type * @param qtype Query type: AA, AAAA. See enum dns_rr_type
* @retval 0 on success * @retval 0 on success

2
subsys/usb/class/cdc_acm.c
View file

@ -488,7 +488,7 @@ static void cdc_acm_baudrate_set(struct device *dev, uint32_t baudrate)
* *
* @param dev CDC ACM device struct. * @param dev CDC ACM device struct.
* *
* @return 0 allways. * @return 0 always.
*/ */
static int cdc_acm_init(struct device *dev) static int cdc_acm_init(struct device *dev)
{ {

2
subsys/usb/usb_device.c
View file

@ -49,7 +49,7 @@
* callback is called. * callback is called.
* When an IN request arrives, the callback is called immediately to either * 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 * 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 * Standard request handler handles the 'chapter 9' processing, specifically
* the standard device requests in table 9-3 from the universal serial bus * the standard device requests in table 9-3 from the universal serial bus