!236 fix: modify event API description

Merge pull request !236 from MGY917/event

kernel/base/ipc/los_event.c

@@ -296,7 +296,7 @@ LITE_OS_SEC_TEXT_INIT UINT32 LOS_EventDestroy(PEVENT_CB_S eventCB)
     return LOS_OK;
 }
 
-LITE_OS_SEC_TEXT_MINOR UINT32 LOS_EventClear(PEVENT_CB_S eventCB, UINT32 events)
+LITE_OS_SEC_TEXT_MINOR UINT32 LOS_EventClear(PEVENT_CB_S eventCB, UINT32 eventMask)
 {
     UINT32 intSave;
 
@@ -304,7 +304,7 @@ LITE_OS_SEC_TEXT_MINOR UINT32 LOS_EventClear(PEVENT_CB_S eventCB, UINT32 events)
         return LOS_ERRNO_EVENT_PTR_NULL;
     }
     SCHEDULER_LOCK(intSave);
-    eventCB->uwEventID &= events;
+    eventCB->uwEventID &= eventMask;
     SCHEDULER_UNLOCK(intSave);
 
     return LOS_OK;

kernel/include/los_event.h

@@ -287,7 +287,7 @@ extern UINT32 LOS_EventWrite(PEVENT_CB_S eventCB, UINT32 events);
 
 /**
  * @ingroup los_event
- * @brief Clear the event occurring in a specified task.
+ * @brief Clear the event of the eventCB by a specified eventMask.
  *
  * @par Description:
  * <ul>
@@ -300,7 +300,7 @@ extern UINT32 LOS_EventWrite(PEVENT_CB_S eventCB, UINT32 events);
  * </ul>
  *
  * @param eventCB     [IN/OUT] Pointer to the event control block to be cleared.
- * @param events      [IN] Mask of the event to be cleared.
+ * @param eventMask   [IN] Mask of the event to be cleared.
  *
  * @retval #LOS_ERRNO_EVENT_PTR_NULL  Null pointer.
  * @retval #LOS_OK                    The event is successfully cleared.
@@ -308,7 +308,7 @@ extern UINT32 LOS_EventWrite(PEVENT_CB_S eventCB, UINT32 events);
  * <ul><li>los_event.h: the header file that contains the API declaration.</li></ul>
  * @see LOS_EventPoll | LOS_EventRead | LOS_EventWrite
  */
-extern UINT32 LOS_EventClear(PEVENT_CB_S eventCB, UINT32 events);
+extern UINT32 LOS_EventClear(PEVENT_CB_S eventCB, UINT32 eventMask);
 
 /**
  * @ingroup los_event