[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index] [RFC PATCH 06/11] docs/doxygen: Add doxygen tags to sched.h
Add doxygen tags to sched.h to: 1) Create Guest scheduler operations section 2) Include variable in the generated documentation Signed-off-by: Luca Fancellu <luca.fancellu@xxxxxxx> --- xen/include/public/sched.h | 18 ++++++++++++++++-- 1 file changed, 16 insertions(+), 2 deletions(-) diff --git a/xen/include/public/sched.h b/xen/include/public/sched.h index 811bd87c82..d4e1452f36 100644 --- a/xen/include/public/sched.h +++ b/xen/include/public/sched.h @@ -24,6 +24,11 @@ * Copyright (c) 2005, Keir Fraser <keir@xxxxxxxxxxxxx> */ +/** + * @file + * @brief Scheduler state interactions. + */ + #ifndef __XEN_PUBLIC_SCHED_H__ #define __XEN_PUBLIC_SCHED_H__ @@ -31,10 +36,15 @@ /* * `incontents 150 sched Guest Scheduler Operations - * - * The SCHEDOP interface provides mechanisms for a guest to interact + */ + +/** + * @brief The SCHEDOP interface provides mechanisms for a guest to interact * with the scheduler, including yield, blocking and shutting itself * down. + * + * @addtogroup guest_scheduler_operations Guest Scheduler Operations + * @{ */ /* @@ -189,6 +199,10 @@ DEFINE_XEN_GUEST_HANDLE(sched_pin_override_t); #define SHUTDOWN_MAX 5 /* Maximum valid shutdown reason. */ /* ` } */ +/** + * @} +*/ + #endif /* __XEN_PUBLIC_SCHED_H__ */ /* -- 2.17.1
|
Lists.xenproject.org is hosted with RackSpace, monitoring our |