include/nuttx/signal.h: Fix nxsig_notification comment

This commit is contained in:
Xiang Xiao 2018-11-09 09:15:00 -06:00 committed by Gregory Nutt
parent 28abd336da
commit 74c4d4f3d7

View File

@ -434,17 +434,17 @@ unsigned int nxsig_sleep(unsigned int seconds);
int nxsig_usleep(useconds_t usec);
/****************************************************************************
* Name: nxsig_evthread
* Name: nxsig_notification
*
* Description:
* Notify a client a signal event via a function call. This function is
* an internal OS interface that implements the common logic for signal
* event notification for the case of SIGEV_THREAD.
* Notify a client an event via either a signal or a function call
* base on the sigev_notify field.
*
* Input Parameters:
* pid - The task/thread ID a the client thread to be signaled.
* event - The instance of struct sigevent that describes how to signal
* the client.
* code - Source: SI_USER, SI_QUEUE, SI_TIMER, SI_ASYNCIO, or SI_MESGQ
*
* Returned Value:
* This is an internal OS interface and should not be used by applications.