doc: fixed typos and other misspellings

This commit is contained in:
Oleg Hahm 2014-11-30 21:32:12 +01:00
parent cc73296d43
commit df9c09d946
9 changed files with 27 additions and 26 deletions

View File

@ -12,7 +12,7 @@
* @brief Common files for all MSB-A2 based boards * @brief Common files for all MSB-A2 based boards
* @{ * @{
* *
* @files msba2-common.h * @file
* @brief MSB-A2 Common Board Definitions * @brief MSB-A2 Common Board Definitions
* *
* @author Kaspar Schleiser <kaspar@schleiser.de> * @author Kaspar Schleiser <kaspar@schleiser.de>

View File

@ -62,7 +62,7 @@ extern "C" {
extern const netdev_driver_t nativenet_driver; extern const netdev_driver_t nativenet_driver;
/** /**
* @brief Default @netdev API device * @brief Default @ref netdev API device
*/ */
extern netdev_t nativenet_default_dev; extern netdev_t nativenet_default_dev;

View File

@ -37,7 +37,7 @@ extern "C" {
* *
* This method can be used before the UART system was initialized. * This method can be used before the UART system was initialized.
* *
* Special charactes that are understood: '\n' and '\r'. * Special charactes that are understood: '\n' and '\\r'.
* Use DOS newlines. * Use DOS newlines.
*/ */
void videoram_putc(char c); void videoram_putc(char c);

View File

@ -60,14 +60,14 @@ typedef enum {
/** /**
* @brief Radio frame protocol * @brief Radio frame protocol
* *
* @detail Sends frames as defined by radio_packet_t. * @details Sends frames as defined by radio_packet_t.
*/ */
NETDEV_PROTO_RADIO = 0x0001, NETDEV_PROTO_RADIO = 0x0001,
/** /**
* @brief IEEE 802.15.4 * @brief IEEE 802.15.4
* *
* @detail Sends frames as defined by ieee802154_frame_t * @details Sends frames as defined by ieee802154_frame_t
*/ */
NETDEV_PROTO_802154 = 0x0002, NETDEV_PROTO_802154 = 0x0002,
NETDEV_PROTO_6LOWPAN = 0x0003, /**< 6LoWPAN. */ NETDEV_PROTO_6LOWPAN = 0x0003, /**< 6LoWPAN. */
@ -85,7 +85,7 @@ typedef enum {
/** /**
* @brief Communication type for the device as defined by @ref netdev_proto_t * @brief Communication type for the device as defined by @ref netdev_proto_t
* *
* @detail If a driver does not support the type (but the setting of the * @details If a driver does not support the type (but the setting of the
* option is supported) it @ref netdev_driver_t::set_option() shall result * option is supported) it @ref netdev_driver_t::set_option() shall result
* with -EPROTONOSUPPORT. * with -EPROTONOSUPPORT.
* *
@ -113,9 +113,9 @@ typedef enum {
EUI-64 in IEEE 802.15.4) */ EUI-64 in IEEE 802.15.4) */
/** /**
* @brief Last value for @netdev_opt_t defined here * @brief Last value for @ref netdev_opt_t defined here
* *
* @detail Specific devices or modules like @ref netapi that utilize these * @details Specific devices or modules like @ref netapi that utilize these
* values to may define higher values, but they must be greater * values to may define higher values, but they must be greater
* or equal to @ref NETDEV_OPT_LAST. * or equal to @ref NETDEV_OPT_LAST.
*/ */
@ -183,7 +183,7 @@ typedef int (*netdev_rcv_data_cb_t)(netdev_t *dev, void *src, size_t src_len,
/** /**
* @brief Network device API definition. * @brief Network device API definition.
* *
* @details This is a set of functions that must be implemented by any driver * @details This is a set of functions that must be implemented by any driver
* for a network device. * for a network device.
*/ */
typedef struct { typedef struct {

View File

@ -99,7 +99,7 @@ uint32_t sdbm_hash(const uint8_t *buf, size_t len);
uint32_t kr_hash(const uint8_t *buf, size_t len); uint32_t kr_hash(const uint8_t *buf, size_t len);
/** /**
* @bief sax_hash * @brief sax_hash
* *
* Shift, Add, XOR * Shift, Add, XOR
* *

View File

@ -402,7 +402,7 @@ int net_if_get_eui64(net_if_eui64_t *eui64, int if_id, int force_generation);
/** /**
* @brief Parses a string to an EUI-64. * @brief Parses a string to an EUI-64.
* @detail The parsing will be back to front, every non-hexadecimal character * @details The parsing will be back to front, every non-hexadecimal character
* and every hexadecimal character beyond the count of 8 will be * and every hexadecimal character beyond the count of 8 will be
* ignored * ignored
* *

View File

@ -128,8 +128,9 @@ typedef enum {
* but interpret them **always optimisticly**. * but interpret them **always optimisticly**.
* *
* A protocol should at least always answer with an acknowledgement of * A protocol should at least always answer with an acknowledgement of
* result @netapi NETAPI_STATUS_OK if the operation was successfull or * result @ref netapi NETAPI_STATUS_OK if the operation was
* with errno -ENOTSUP if the operation is not supported. * successfull or with errno -ENOTSUP if the operation is not
* supported.
*/ */
typedef enum { typedef enum {
/** /**

View File

@ -37,9 +37,9 @@ extern "C" {
#ifndef PKTBUF_SIZE #ifndef PKTBUF_SIZE
/** /**
* @brief Maximum size of the packet buffer. * @brief Maximum size of the packet buffer.
* *
* @detail The rational here is to have at least space for 4 full-MTU IPv6 * @details The rational here is to have at least space for 4 full-MTU IPv6
* packages (2 incoming, 2 outgoing; 2 * 2 * 1280 B = 5 KiB) + * packages (2 incoming, 2 outgoing; 2 * 2 * 1280 B = 5 KiB) +
* Meta-Data (roughly estimated to 1 KiB; might be smaller) * Meta-Data (roughly estimated to 1 KiB; might be smaller)
*/ */
@ -63,7 +63,7 @@ void *pktbuf_alloc(size_t size);
* @brief Reallocates new space in the packet buffer, without changing the * @brief Reallocates new space in the packet buffer, without changing the
* content. * content.
* *
* @datail If enough memory is available behind it or *size* is smaller than * @details If enough memory is available behind it or *size* is smaller than
* the original size the packet will not be moved. Otherwise, it will * the original size the packet will not be moved. Otherwise, it will
* be moved. If no space is available nothing happens. * be moved. If no space is available nothing happens.
* *
@ -95,7 +95,7 @@ void *pktbuf_insert(const void *data, size_t size);
/** /**
* @brief Copies packet data into the packet buffer, safely. * @brief Copies packet data into the packet buffer, safely.
* *
* @detail Use this instead of memcpy, since it is thread-safe and checks if * @details Use this instead of memcpy, since it is thread-safe and checks if
* *pkt* is * *pkt* is
* *
* -# in the buffer at all * -# in the buffer at all
@ -118,7 +118,7 @@ int pktbuf_copy(void *pkt, const void *data, size_t data_len);
/** /**
* @brief Marks the data as being processed. * @brief Marks the data as being processed.
* *
* @detail Internally this increments just a counter on the data. * @details Internally this increments just a counter on the data.
* @ref pktbuf_release() decrements it. If the counter is <=0 the * @ref pktbuf_release() decrements it. If the counter is <=0 the
* reserved data block in the buffer will be made available again. * reserved data block in the buffer will be made available again.
* *
@ -131,7 +131,7 @@ void pktbuf_hold(const void *pkt);
* *
* @param[in] pkt The packet you want mark as not being processed anymore. * @param[in] pkt The packet you want mark as not being processed anymore.
* *
* @detail Internally this decrements just a counter on the data. * @details Internally this decrements just a counter on the data.
* @ref pktbuf_hold() increments and any allocation * @ref pktbuf_hold() increments and any allocation
* operation initializes it. If the counter is <=0 the reserved data * operation initializes it. If the counter is <=0 the reserved data
* block in the buffer will be made available again. * block in the buffer will be made available again.

View File

@ -211,7 +211,7 @@ int accept(int socket, struct sockaddr *__restrict address,
/** /**
* @brief Bind a name to a socket. * @brief Bind a name to a socket.
* @detail The bind() function shall assign a local socket address *address* * @details The bind() function shall assign a local socket address *address*
* to a socket identified by descriptor socket that has no local * to a socket identified by descriptor socket that has no local
* socket address assigned. Sockets created with the socket() function * socket address assigned. Sockets created with the socket() function
* are initially unnamed; they are identified only by their address * are initially unnamed; they are identified only by their address
@ -238,7 +238,7 @@ int bind(int socket, const struct sockaddr *address,
/** /**
* @brief Connect a socket. * @brief Connect a socket.
* @detail The connect() function shall attempt to make a connection on a * @details The connect() function shall attempt to make a connection on a
* connection-mode socket or to set or reset the peer address of a * connection-mode socket or to set or reset the peer address of a
* connectionless-mode socket. * connectionless-mode socket.
* *
@ -306,7 +306,7 @@ int listen(int socket, int backlog);
/** /**
* @brief Receive a message from a connected socket. * @brief Receive a message from a connected socket.
* @detail Shall receive a message from a connection-mode or * @details Shall receive a message from a connection-mode or
* connectionless-mode socket. It is normally used with connected * connectionless-mode socket. It is normally used with connected
* sockets because it does not permit the application to retrieve the * sockets because it does not permit the application to retrieve the
* source address of received data. * source address of received data.
@ -331,7 +331,7 @@ ssize_t recv(int socket, void *buffer, size_t length, int flags);
/** /**
* @brief Receive a message from a socket. * @brief Receive a message from a socket.
* @detail The recvfrom() function shall receive a message from a * @details The recvfrom() function shall receive a message from a
* connection-mode or connectionless-mode socket. It is normally used * connection-mode or connectionless-mode socket. It is normally used
* with connectionless-mode sockets because it permits the application * with connectionless-mode sockets because it permits the application
* to retrieve the source address of received data. * to retrieve the source address of received data.
@ -369,7 +369,7 @@ ssize_t recvfrom(int socket, void *__restrict buffer, size_t length, int flags,
/** /**
* @brief Send a message on a socket. * @brief Send a message on a socket.
* @detail Shall initiate transmission of a message from the specified socket * @details Shall initiate transmission of a message from the specified socket
* to its peer. The send() function shall send a message only when the * to its peer. The send() function shall send a message only when the
* socket is connected. If the socket is a connectionless-mode socket, * socket is connected. If the socket is a connectionless-mode socket,
* the message shall be sent to the pre-specified peer address. * the message shall be sent to the pre-specified peer address.
@ -392,7 +392,7 @@ ssize_t send(int socket, const void *buffer, size_t length, int flags);
/** /**
* @brief Send a message on a socket. * @brief Send a message on a socket.
* @detail Shall send a message through a connection-mode or * @details Shall send a message through a connection-mode or
* connectionless-mode socket. If the socket is a connectionless-mode * connectionless-mode socket. If the socket is a connectionless-mode
* socket, the message shall be sent to the address specified by * socket, the message shall be sent to the address specified by
* *dest_addr* if no pre-specified peer address has been set. If a * *dest_addr* if no pre-specified peer address has been set. If a
@ -447,7 +447,7 @@ int setsockopt(int socket, int level, int option_name, const void *option_value,
/** /**
* @brief Create an endpoint for communication. * @brief Create an endpoint for communication.
* @detail Shall create an unbound socket in a communications domain, and * @details Shall create an unbound socket in a communications domain, and
* return a file descriptor that can be used in later function calls * return a file descriptor that can be used in later function calls
* that operate on sockets. * that operate on sockets.
* *