Update comment of headers.

This commit is contained in:
Dave Davenport
2014-11-25 08:27:08 +01:00
parent be9bc59c34
commit 471c0c5df7
3 changed files with 153 additions and 39 deletions

View File

@@ -6,22 +6,36 @@
*/
typedef struct
{
// Prompt to display.
/** Prompt to display. */
char *name;
// The script
/** The script */
char *script_path;
} ScriptOptions;
/**
* @param input Pointer to the user-input string.
* @param data Custom data pointer for callback.
*
* Run the script dialog
*
* @returns SwitcherMode selected by user.
*/
SwitcherMode script_switcher_dialog ( char **input, void *data );
/**
* @param str The input string to parse
*
* Parse an argument string into the right ScriptOptions data object.
* This is off format: <Name>:<Script>
* Return NULL when it fails.
*
* @returns NULL when it fails, a newly allocated ScriptOptions when successful.
*/
ScriptOptions *script_switcher_parse_setup ( const char *str );
/**
* @param sw Handle to the ScriptOption
*
* Free the ScriptOptions block.
*/
void script_switcher_free_options ( ScriptOptions *sw );