objects in source documentation renamed from xy-object to xy object
This commit is contained in:
+15
-15
@@ -1,8 +1,8 @@
|
||||
/**
|
||||
* @file job_queue.h
|
||||
*
|
||||
*
|
||||
* @brief Job-Queue based on linked_list_t
|
||||
*
|
||||
*
|
||||
*/
|
||||
|
||||
/*
|
||||
@@ -29,16 +29,16 @@
|
||||
/**
|
||||
* @brief Job-Queue
|
||||
*
|
||||
* Although the job-queue is based on a linked_list_t
|
||||
* Although the job-queue is based on a linked_list_t
|
||||
* all access functions are thread-save implemented
|
||||
*/
|
||||
typedef struct job_queue_s job_queue_t;
|
||||
|
||||
struct job_queue_s {
|
||||
|
||||
|
||||
/**
|
||||
* @brief returns number of jobs in queue
|
||||
*
|
||||
*
|
||||
* @param job_queue_t calling object
|
||||
* @returns number of items in queue
|
||||
*/
|
||||
@@ -46,24 +46,24 @@ struct job_queue_s {
|
||||
|
||||
/**
|
||||
* @brief get the next job from the queue
|
||||
*
|
||||
*
|
||||
* If the queue is empty, this function blocks until a job can be returned.
|
||||
*
|
||||
*
|
||||
* After using, the returned job has to get destroyed by the caller.
|
||||
*
|
||||
*
|
||||
* @param job_queue_t calling object
|
||||
* @param[out] job pointer to a job pointer where to job is returned to
|
||||
* @returns SUCCESS if succeeded, FAILED otherwise
|
||||
*/
|
||||
status_t (*get) (job_queue_t *job_queue, job_t **job);
|
||||
|
||||
|
||||
/**
|
||||
* @brief adds a job to the queue
|
||||
*
|
||||
*
|
||||
* This function is non blocking and adds a job_t to the list.
|
||||
* The specific job-object has to get destroyed by the thread which
|
||||
* The specific job object has to get destroyed by the thread which
|
||||
* removes the job.
|
||||
*
|
||||
*
|
||||
* @param job_queue_t calling object
|
||||
* @param[in] job job to add to the queue (job is not copied)
|
||||
* @returns SUCCESS if succeeded, FAILED otherwise
|
||||
@@ -72,11 +72,11 @@ struct job_queue_s {
|
||||
|
||||
/**
|
||||
* @brief destroys a job_queue object
|
||||
*
|
||||
*
|
||||
* @warning The caller of this function has to make sure
|
||||
* that no thread is going to add or get a job from the job_queue
|
||||
* after calling this function.
|
||||
*
|
||||
*
|
||||
* @param job_queue_t calling object
|
||||
* @returns SUCCESS if succeeded, FAILED otherwise
|
||||
*/
|
||||
@@ -85,7 +85,7 @@ struct job_queue_s {
|
||||
|
||||
/**
|
||||
* @brief Creates an empty job_queue
|
||||
*
|
||||
*
|
||||
* @return job_queue_t empty job_queue
|
||||
*/
|
||||
job_queue_t *job_queue_create();
|
||||
|
||||
Reference in New Issue
Block a user