[PATCH] score: Document thread queue operations

[Chris Johns]

On 2/9/21 5:09 pm, Sebastian Huber wrote:
> Hello Chris,
> 
> thanks for the review, I will send a v2 of the patch.
> 
> On 02/09/2021 08:38, Chris Johns wrote:
>>>      */
>>>     Thread_queue_Enqueue_operation enqueue;
>>>       /**
>>> -   * @brief Thread queue extract operation.
>>> +   * @brief This operation is used to extract the thread from the thread queue.
>>>      *
>>> -   * Called by object routines to extract a thread from a thread queue.
>>> +   * The extract operation is intended for timeouts, thread restarts, and
>>> +   * thread cancellation.  The surrender operation should be used to dequeue a
>>> +   * thread from the thread queue.
>>  From the start, end, or where it is in the queue?
>>
> 
> I think this is clear:
> 
> "This operation is used to extract the thread from the thread queue."
> 
> A thread is extracted. It doesn't matter at which position it is.

It may if you know the signature. I do not know the signature nor does it say.
As a result I question it being "clear".

Chris