doc: Change "None" return value to "N/A"

Improves documentation consistency by using "N/A" instead of "None"
when the routine does not return a value.

Change-Id: I429a159b3037742cbc431db0cb4828ab9d6d35c3
Signed-off-by: Peter Mitsis <peter.mitsis@windriver.com>
This commit is contained in:
Peter Mitsis 2015-11-20 13:53:02 -05:00 committed by Anas Nashif
commit 42bb6227dc
6 changed files with 14 additions and 14 deletions

View file

@ -168,7 +168,7 @@ uint8_t bt_conn_enc_key_size(struct bt_conn *conn);
* @param auto_conn boolean value. If true, auto connect is enabled, * @param auto_conn boolean value. If true, auto connect is enabled,
* if false, auto connect is disabled. * if false, auto connect is disabled.
* *
* @return none * @return N/A
*/ */
void bt_conn_set_auto_conn(struct bt_conn *conn, bool auto_conn); void bt_conn_set_auto_conn(struct bt_conn *conn, bool auto_conn);

View file

@ -173,7 +173,7 @@ int bt_uuid_cmp(const struct bt_uuid *u1, const struct bt_uuid *u2);
* @param str pointer where to put converted string * @param str pointer where to put converted string
* @param len length of str * @param len length of str
* *
* @return none * @return N/A
*/ */
void bt_uuid_to_str(const struct bt_uuid *uuid, char *str, size_t len); void bt_uuid_to_str(const struct bt_uuid *uuid, char *str, size_t len);

View file

@ -42,7 +42,7 @@ struct uart_console_input {
* @param lines nano_fifo queue of entered lines which to be processed * @param lines nano_fifo queue of entered lines which to be processed
* in the application code. * in the application code.
* *
* @return None * @return N/A
*/ */
void uart_register_input(struct nano_fifo *avail, struct nano_fifo *lines); void uart_register_input(struct nano_fifo *avail, struct nano_fifo *lines);

View file

@ -202,7 +202,7 @@ struct uart_k20_dev_data {
* @param clk_freq Clock frequency * @param clk_freq Clock frequency
* @param baud_rate Baud rate to set * @param baud_rate Baud rate to set
* *
* @return None * @return N/A
*/ */
static ALWAYS_INLINE void _k20_uart_baud_rate_set(volatile struct K20_UART *uart_p, static ALWAYS_INLINE void _k20_uart_baud_rate_set(volatile struct K20_UART *uart_p,
uint32_t clk_freq, uint32_t clk_freq,
@ -234,7 +234,7 @@ static ALWAYS_INLINE void _k20_uart_baud_rate_set(volatile struct K20_UART *uart
* *
* @param uart_p UART data * @param uart_p UART data
* *
* @return None * @return N/A
*/ */
static inline void _k20_uart_fifo_enable(volatile struct K20_UART *uart_p) static inline void _k20_uart_fifo_enable(volatile struct K20_UART *uart_p)
{ {

View file

@ -49,7 +49,7 @@ typedef struct _dnode sys_dnode_t;
* *
* @param list the doubly-linked list * @param list the doubly-linked list
* *
* @return None * @return N/A
*/ */
static inline void sys_dlist_init(sys_dlist_t *list) static inline void sys_dlist_init(sys_dlist_t *list)
@ -133,7 +133,7 @@ static inline sys_dnode_t *sys_dlist_peek_next(sys_dlist_t *list,
* @param list the doubly-linked list to operate on * @param list the doubly-linked list to operate on
* @param node the element to append * @param node the element to append
* *
* @return None * @return N/A
*/ */
static inline void sys_dlist_append(sys_dlist_t *list, sys_dnode_t *node) static inline void sys_dlist_append(sys_dlist_t *list, sys_dnode_t *node)
@ -151,7 +151,7 @@ static inline void sys_dlist_append(sys_dlist_t *list, sys_dnode_t *node)
* @param list the doubly-linked list to operate on * @param list the doubly-linked list to operate on
* @param node the element to append * @param node the element to append
* *
* @return None * @return N/A
*/ */
static inline void sys_dlist_prepend(sys_dlist_t *list, sys_dnode_t *node) static inline void sys_dlist_prepend(sys_dlist_t *list, sys_dnode_t *node)
@ -172,7 +172,7 @@ static inline void sys_dlist_prepend(sys_dlist_t *list, sys_dnode_t *node)
* @param insert_point the insert point in the list: if NULL, insert at head * @param insert_point the insert point in the list: if NULL, insert at head
* @param node the element to append * @param node the element to append
* *
* @return None * @return N/A
*/ */
static inline void sys_dlist_insert_after(sys_dlist_t *list, static inline void sys_dlist_insert_after(sys_dlist_t *list,
@ -197,7 +197,7 @@ static inline void sys_dlist_insert_after(sys_dlist_t *list,
* @param insert_point the insert point in the list: if NULL, insert at tail * @param insert_point the insert point in the list: if NULL, insert at tail
* @param node the element to insert * @param node the element to insert
* *
* @return None * @return N/A
*/ */
static inline void sys_dlist_insert_before(sys_dlist_t *list, static inline void sys_dlist_insert_before(sys_dlist_t *list,
@ -226,7 +226,7 @@ static inline void sys_dlist_insert_before(sys_dlist_t *list,
* insert point * insert point
* @param data parameter to cond() * @param data parameter to cond()
* *
* @return None * @return N/A
*/ */
static inline void sys_dlist_insert_at(sys_dlist_t *list, sys_dnode_t *node, static inline void sys_dlist_insert_at(sys_dlist_t *list, sys_dnode_t *node,
@ -251,7 +251,7 @@ static inline void sys_dlist_insert_at(sys_dlist_t *list, sys_dnode_t *node,
* *
* @param node the node to remove * @param node the node to remove
* *
* @return None * @return N/A
*/ */
static inline void sys_dlist_remove(sys_dnode_t *node) static inline void sys_dlist_remove(sys_dnode_t *node)

View file

@ -227,7 +227,7 @@ extern void fiber_abort(void);
* *
* @param timeout number of system ticks to sleep * @param timeout number of system ticks to sleep
* *
* @return None * @return N/A
*/ */
extern void fiber_sleep(int32_t timeout); extern void fiber_sleep(int32_t timeout);
@ -263,7 +263,7 @@ extern void fiber_delayed_start_cancel(void *handle);
* *
* @param handle A handle returned when asking to start the fiber * @param handle A handle returned when asking to start the fiber
* *
* @return None * @return N/A
*/ */
extern void fiber_fiber_delayed_start_cancel(void *handle); extern void fiber_fiber_delayed_start_cancel(void *handle);
#endif #endif