kernel: Update k_event documentation (5905fa86) · Commits · Wenxi XU / zephyr

include/zephyr/kernel.h

+20 −0

Original line number	Diff line number	Diff line
		@@ -2411,7 +2411,17 @@ __syscall int k_futex_wake(struct k_futex *futex, bool wake_all);
		* @ingroup event_apis
		*/

		/**
		* @brief Kernel Event structure
		*
		* This structure is used to represent kernel events. All the members
		* are internal and should not be accessed directly.
		*/

		struct k_event {
		/**
		* @cond INTERNAL_HIDDEN
		*/
		_wait_q_t wait_q;
		uint32_t events;
		struct k_spinlock lock;
		@@ -2421,15 +2431,25 @@ struct k_event {
		#ifdef CONFIG_OBJ_CORE_EVENT
		struct k_obj_core obj_core;
		#endif
		/**
		* INTERNAL_HIDDEN @endcond
		*/

		};

		/**
		* @cond INTERNAL_HIDDEN
		*/

		#define Z_EVENT_INITIALIZER(obj) \
		{ \
		.wait_q = Z_WAIT_Q_INIT(&obj.wait_q), \
		.events = 0, \
		.lock = {}, \
		}
		/**
		* INTERNAL_HIDDEN @endcond
		*/

		/**
		* @brief Initialize an event object