Add documentation to frontend_context.c

This commit is contained in:
twinaphex 2015-01-09 18:11:33 +01:00
parent 0121e240d7
commit 2909039e57
2 changed files with 30 additions and 2 deletions

View File

@ -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;

View File

@ -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);