summaryrefslogtreecommitdiff
path: root/src/reducer/anastasis_api_redux.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/reducer/anastasis_api_redux.h')
-rw-r--r--src/reducer/anastasis_api_redux.h44
1 files changed, 22 insertions, 22 deletions
diff --git a/src/reducer/anastasis_api_redux.h b/src/reducer/anastasis_api_redux.h
index b388fd3..ef0962b 100644
--- a/src/reducer/anastasis_api_redux.h
+++ b/src/reducer/anastasis_api_redux.h
@@ -100,6 +100,8 @@ ANASTASIS_redux_done (void);
/**
* Produce an initial state with an initialized list of
* continents.
+ *
+ * @return list of continents
*/
json_t *
ANASTASIS_REDUX_load_continents_ (void);
@@ -108,8 +110,8 @@ ANASTASIS_REDUX_load_continents_ (void);
/**
* Returns the enum value to a string value of a state.
*
- * @param state_string
- * @return #ANASTASIS_GENERIC_STATE_ERROR on error
+ * @param state_string string to convert
+ * @return ANASTASIS_GENERIC_STATE_ERROR on error
*/
enum ANASTASIS_GenericState
ANASTASIS_generic_state_from_string_ (const char *state_string);
@@ -118,7 +120,7 @@ ANASTASIS_generic_state_from_string_ (const char *state_string);
/**
* Returns the string value of a state.
*
- * @param state_string
+ * @param gs state value to convert
* @return NULL on error
*/
const char *
@@ -128,8 +130,8 @@ ANASTASIS_generic_state_to_string_ (enum ANASTASIS_GenericState gs);
/**
* Returns the enum value to a string value of a state.
*
- * @param state_string
- * @return #ANASTASIS_BACKUP_STATE_ERROR on error
+ * @param state_string string to convert
+ * @return ANASTASIS_BACKUP_STATE_ERROR on error
*/
enum ANASTASIS_BackupState
ANASTASIS_backup_state_from_string_ (const char *state_string);
@@ -138,7 +140,7 @@ ANASTASIS_backup_state_from_string_ (const char *state_string);
/**
* Returns the string value of a state.
*
- * @param state_string
+ * @param bs state to convert to a string
* @return NULL on error
*/
const char *
@@ -148,8 +150,8 @@ ANASTASIS_backup_state_to_string_ (enum ANASTASIS_BackupState bs);
/**
* Returns the enum value to a string value of a state.
*
- * @param state_string
- * @return XXX on error
+ * @param state_string value to convert
+ * @return ANASTASIS_RECOVERY_STATE_ERROR on error
*/
enum ANASTASIS_RecoveryState
ANASTASIS_recovery_state_from_string_ (const char *state_string);
@@ -158,7 +160,7 @@ ANASTASIS_recovery_state_from_string_ (const char *state_string);
/**
* Returns the string value of a state.
*
- * @param state_string
+ * @param rs value to convert
* @return NULL on error
*/
const char *
@@ -205,7 +207,7 @@ ANASTASIS_add_provider_ (json_t *state,
* imports it into @a state. If not, queries the provider,
* generating a success or failure outcome asynchronously.
*
- * @param cr the config request
+ * @param url the provider's base URL to add
* @param[in,out] state the json state to operate on
* @param cb callback to call during/after operation
* @param cb_cls callback closure
@@ -223,10 +225,10 @@ ANASTASIS_REDUX_add_provider_to_state_ (const char *url,
* A generic DispatchHandler/Callback function which is called for a
* "back" action.
*
- * @param state state to operate on
+ * @param[in,out] state state to operate on
* @param arguments arguments to use for operation on state
* @param cb callback to call during/after operation
- * @param cb_cls callback closure
+ * @param cb_cls callback closure for @a cb
* @return NULL (no asynchronous action)
*/
struct ANASTASIS_ReduxAction *
@@ -240,19 +242,17 @@ ANASTASIS_back_generic_decrement_ (json_t *state,
* Function to load json containing all countries.
* Returns the countries.
*
- * @return json_t *
+ * @return list of countries
*/
const json_t *
ANASTASIS_redux_countries_init_ (void);
/**
- * Operates on a recovery state depending on given #ANASTASIS_RecoveryState
- * and #ANASTASIS_RecoveryAction. The new #ANASTASIS_RecoveryState is returned
+ * Operates on a recovery state. The new state is returned
* by a callback function.
* This function can do network access to talk to anastasis service providers.
*
- * @param ctx the CURL context used to connect to the backend
* @param[in,out] state input/output state (to be modified)
* @param action what action to perform
* @param arguments data for the @a action
@@ -276,8 +276,9 @@ ANASTASIS_recovery_action_ (json_t *state,
* Returns an #ANASTASIS_ReduxAction.
*
* @param state state to operate on
+ * @param arguments data for the operation
* @param cb callback to call during/after operation
- * @param cb_cls callback closure
+ * @param cb_cls callback closure for @a cb
* @return NULL
*/
struct ANASTASIS_ReduxAction *
@@ -293,9 +294,10 @@ ANASTASIS_REDUX_recovery_challenge_begin_ (json_t *state,
* arguments provided were OK and the state transition was
* initiated. Begins the actual backup logic.
*
- * Returns an #ANASTASIS_ReduxAction.
+ * Returns a `struct ANASTASIS_ReduxAction`.
*
* @param state state to operate on
+ * @param arguments data for the operation
* @param cb callback to call during/after operation
* @param cb_cls callback closure
*/
@@ -307,12 +309,10 @@ ANASTASIS_REDUX_backup_begin_ (json_t *state,
/**
- * Operates on a backup state depending on given #ANASTASIS_BackupState
- * and #ANASTASIS_BackupAction. The new #ANASTASIS_BackupState is returned
- * by a callback function.
+ * Operates on a backup state and returns the new state via a
+ * callback function.
* This function can do network access to talk to anastasis service providers.
*
- * @param ctx the CURL context used to connect to the backend
* @param[in,out] state input/output state (to be modified)
* @param action what action to perform
* @param arguments data for the @a action