doxygen: change comment style to match javadoc
Change-Id: I5266caff9ef2ee26c556f6e144eca020ae9169bd Signed-off-by: Anas Nashif <anas.nashif@intel.com>
This commit is contained in:
parent
1b1905e2ef
commit
d89bcd300c
7 changed files with 13 additions and 13 deletions
|
@ -1,4 +1,4 @@
|
|||
/*! @file
|
||||
/** @file
|
||||
* @brief Simple UART driver
|
||||
*
|
||||
* A simple UART driver allowing application to handle all aspects of received
|
||||
|
|
|
@ -25,7 +25,7 @@ static struct device *config_levels[] = {
|
|||
__initconfig_end,
|
||||
};
|
||||
|
||||
/*!
|
||||
/**
|
||||
* @brief Execute all the driver init functions at a given level
|
||||
*
|
||||
* @details Driver init objects are created with the
|
||||
|
@ -45,7 +45,7 @@ void _sys_device_do_config_level(int level)
|
|||
}
|
||||
}
|
||||
|
||||
/*!
|
||||
/**
|
||||
* @brief Retrieve the device structure for a driver by name
|
||||
*
|
||||
* @details Driver config object are created via the
|
||||
|
|
|
@ -1,4 +1,4 @@
|
|||
/*! @file
|
||||
/** @file
|
||||
@brief timeout queue for fibers on nanokernel objects
|
||||
|
||||
This file is meant to be included by nanokernel/include/wait_q.h only
|
||||
|
|
|
@ -240,7 +240,7 @@ FUNC_NORETURN void fiber_abort(void)
|
|||
|
||||
#include <wait_q.h>
|
||||
|
||||
/*!
|
||||
/**
|
||||
* @brief put the current fiber to sleep
|
||||
*
|
||||
* Put the currently running fiber to sleep for an amount of system ticks
|
||||
|
@ -265,7 +265,7 @@ void fiber_sleep(int32_t timeout_in_ticks)
|
|||
_Swap(key);
|
||||
}
|
||||
|
||||
/*!
|
||||
/**
|
||||
* @brief start a fiber, but delay its execution
|
||||
*
|
||||
* @param stack pointer to the stack space
|
||||
|
@ -303,7 +303,7 @@ void *fiber_delayed_start(char *stack, unsigned int stack_size_in_bytes,
|
|||
return ccs;
|
||||
}
|
||||
|
||||
/*!
|
||||
/**
|
||||
* @brief cancel a delayed fiber start
|
||||
*
|
||||
* @param handle a handle returned when asking to start the fiber
|
||||
|
|
|
@ -381,7 +381,7 @@ void *nano_fifo_get_wait(struct nano_fifo *fifo)
|
|||
|
||||
|
||||
#ifdef CONFIG_NANO_TIMEOUTS
|
||||
/*!
|
||||
/**
|
||||
* @brief get the head element of a fifo, pend with a timeout if empty
|
||||
*
|
||||
* Remove the head element from the specified nanokernel fifo; it can only be
|
||||
|
@ -429,7 +429,7 @@ void *nano_fiber_fifo_get_wait_timeout(struct nano_fifo *fifo,
|
|||
return data;
|
||||
}
|
||||
|
||||
/*!
|
||||
/**
|
||||
* @brief get the head element of a fifo, poll with a timeout if empty
|
||||
*
|
||||
* Remove the head element from the specified nanokernel fifo; it can only be
|
||||
|
|
|
@ -313,7 +313,7 @@ void *_nano_fiber_lifo_get_panic(struct nano_lifo *lifo)
|
|||
}
|
||||
|
||||
#ifdef CONFIG_NANO_TIMEOUTS
|
||||
/*!
|
||||
/**
|
||||
* @brief get the first element from a LIFO, wait with a timeout if empty
|
||||
*
|
||||
* Remove the first element from the specified system-level linked list lifo;
|
||||
|
@ -357,7 +357,7 @@ void *nano_fiber_lifo_get_wait_timeout(struct nano_lifo *lifo,
|
|||
return data;
|
||||
}
|
||||
|
||||
/*!
|
||||
/**
|
||||
* @brief get the first element from a lifo, poll if empty
|
||||
*
|
||||
* Remove the first element from the specified nanokernel linked list lifo; it
|
||||
|
|
|
@ -305,7 +305,7 @@ void nano_sem_take_wait(struct nano_sem *sem)
|
|||
}
|
||||
|
||||
#ifdef CONFIG_NANO_TIMEOUTS
|
||||
/*!
|
||||
/**
|
||||
* @brief test a nanokernel semaphore, wait with a timeout if unavailable
|
||||
*
|
||||
* Take a nanokernel sempahore; it can only be called from a fiber context.
|
||||
|
@ -346,7 +346,7 @@ int nano_fiber_sem_take_wait_timeout(struct nano_sem *sem,
|
|||
return 1;
|
||||
}
|
||||
|
||||
/*!
|
||||
/**
|
||||
* @brief test a nanokernel semaphore, poll with a timeout if unavailable
|
||||
*
|
||||
* Take a nanokernel sempahore; it can only be called from a task context.
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue