From 2909039e5733c59fddcd23da7be652c5fdab1377 Mon Sep 17 00:00:00 2001 From: twinaphex Date: Fri, 9 Jan 2015 18:11:33 +0100 Subject: [PATCH] Add documentation to frontend_context.c --- frontend/frontend_context.c | 15 +++++++++++++++ frontend/frontend_context.h | 17 +++++++++++++++-- 2 files changed, 30 insertions(+), 2 deletions(-) diff --git a/frontend/frontend_context.c b/frontend/frontend_context.c index 9ab83038e3..a36e2c80b2 100644 --- a/frontend/frontend_context.c +++ b/frontend/frontend_context.c @@ -47,6 +47,14 @@ static const frontend_ctx_driver_t *frontend_ctx_drivers[] = { NULL }; +/** + * frontend_ctx_find_driver: + * @ident : Identifier name of driver to find. + * + * Finds driver with @ident. Does not initialize. + * + * Returns: pointer to driver if successful, otherwise NULL. + **/ const frontend_ctx_driver_t *frontend_ctx_find_driver(const char *ident) { unsigned i; @@ -59,6 +67,13 @@ const frontend_ctx_driver_t *frontend_ctx_find_driver(const char *ident) return NULL; } +/** + * frontend_ctx_init_first: + * + * Finds first suitable driver and initialize. + * + * Returns: pointer to first suitable driver, otherwise NULL. + **/ const frontend_ctx_driver_t *frontend_ctx_init_first(void) { unsigned i; diff --git a/frontend/frontend_context.h b/frontend/frontend_context.h index ca0274fe7a..9520902d4a 100644 --- a/frontend/frontend_context.h +++ b/frontend/frontend_context.h @@ -80,10 +80,23 @@ extern const frontend_ctx_driver_t frontend_ctx_android; extern const frontend_ctx_driver_t frontend_ctx_psp; extern const frontend_ctx_driver_t frontend_ctx_null; -/* Finds driver with ident. Does not initialize. */ +/** + * frontend_ctx_find_driver: + * @ident : Identifier name of driver to find. + * + * Finds driver with @ident. Does not initialize. + * + * Returns: pointer to driver if successful, otherwise NULL. + **/ const frontend_ctx_driver_t *frontend_ctx_find_driver(const char *ident); -/* Finds first suitable driver and initialize. */ +/** + * frontend_ctx_init_first: + * + * Finds first suitable driver and initialize. + * + * Returns: pointer to first suitable driver, otherwise NULL. + **/ const frontend_ctx_driver_t *frontend_ctx_init_first(void); int main_entry_decide(signature(), args_type() args);