Skip to content

Commit

Permalink
Merge pull request #1579 from skliper/fix1390-event_filter_doc
Browse files Browse the repository at this point in the history
Fix #1390, Improve event filter documentation
  • Loading branch information
astrogeco authored May 27, 2021
2 parents 41d6eaa + 18e4d06 commit 6d8b907
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 3 deletions.
5 changes: 3 additions & 2 deletions modules/core_api/fsw/inc/cfe_evs.h
Original file line number Diff line number Diff line change
Expand Up @@ -286,8 +286,9 @@ CFE_Status_t CFE_EVS_SendTimedEvent(CFE_TIME_SysTime_t Time, uint16 EventID, uin
** \brief Resets the calling application's event filter for a single event ID.
**
** \par Description
** The effect of resetting an event filter depends on the filter scheme.
** The #CFE_EVS_EventFilter_BINARY scheme resets the filter counter for the specified Event ID.
** Resets the filter such that the next event is treated like the first.
** For example, if the filter was set to only send the first event, the
** next event following the reset would be sent.
**
** \par Assumptions, External Events, and Notes:
** None
Expand Down
4 changes: 3 additions & 1 deletion modules/core_api/fsw/inc/cfe_evs_api_typedefs.h
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,9 @@
#include "common_types.h" /* Basic data types */
#include "cfe_evs_extern_typedefs.h"

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

0 comments on commit 6d8b907

Please sign in to comment.