kernel: Update k_timer documentation (4f4d2272) · Commits · Wenxi XU / zephyr

include/zephyr/kernel.h

+14 −2

Original line number	Diff line number	Diff line
		@@ -1613,11 +1613,17 @@ const char k_thread_state_str(k_tid_t thread_id, char buf, size_t buf_size);
		* @}
		*/

		/**
		* @brief Kernel timer structure
		*
		* This structure is used to represent a kernel timer.
		* All the members are internal and should not be accessed directly.
		*/
		struct k_timer {
		/**
		* @cond INTERNAL_HIDDEN
		*/

		struct k_timer {
		/*
		* _timeout structure must be first here if we want to use
		* dynamic timer allocation. timeout.node is used in the double-linked
		@@ -1648,8 +1654,14 @@ struct k_timer {
		#ifdef CONFIG_OBJ_CORE_TIMER
		struct k_obj_core obj_core;
		#endif
		/**
		* INTERNAL_HIDDEN @endcond
		*/
		};

		/**
		* @cond INTERNAL_HIDDEN
		*/
		#define Z_TIMER_INITIALIZER(obj, expiry, stop) \
		{ \
		.timeout = { \