Skip to content

Commit 6d8b907

Browse files
authored
Merge pull request #1579 from skliper/fix1390-event_filter_doc
Fix #1390, Improve event filter documentation
2 parents 41d6eaa + 18e4d06 commit 6d8b907

File tree

2 files changed

+6
-3
lines changed

2 files changed

+6
-3
lines changed

modules/core_api/fsw/inc/cfe_evs.h

+3-2
Original file line numberDiff line numberDiff line change
@@ -286,8 +286,9 @@ CFE_Status_t CFE_EVS_SendTimedEvent(CFE_TIME_SysTime_t Time, uint16 EventID, uin
286286
** \brief Resets the calling application's event filter for a single event ID.
287287
**
288288
** \par Description
289-
** The effect of resetting an event filter depends on the filter scheme.
290-
** The #CFE_EVS_EventFilter_BINARY scheme resets the filter counter for the specified Event ID.
289+
** Resets the filter such that the next event is treated like the first.
290+
** For example, if the filter was set to only send the first event, the
291+
** next event following the reset would be sent.
291292
**
292293
** \par Assumptions, External Events, and Notes:
293294
** None

modules/core_api/fsw/inc/cfe_evs_api_typedefs.h

+3-1
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,9 @@
3939
#include "common_types.h" /* Basic data types */
4040
#include "cfe_evs_extern_typedefs.h"
4141

42-
/** \name Common Event Filter Mask Values */
42+
/** \name Common Event Filter Mask Values
43+
* Message is sent if (previous event count) & MASK == 0
44+
*/
4345
/** \{ */
4446
#define CFE_EVS_NO_FILTER 0x0000 /**< \brief Stops any filtering. All messages are sent. */
4547
#define CFE_EVS_FIRST_ONE_STOP 0xFFFF /**< \brief Sends the first event. All remaining messages are filtered. */

0 commit comments

Comments
 (0)