summaryrefslogtreecommitdiff
path: root/src/reducer
diff options
context:
space:
mode:
Diffstat (limited to 'src/reducer')
-rw-r--r--src/reducer/anastasis_api_backup_redux.c19
-rw-r--r--src/reducer/anastasis_api_recovery_redux.c20
-rw-r--r--src/reducer/anastasis_api_redux.c2
-rw-r--r--src/reducer/anastasis_api_redux.h44
-rw-r--r--src/reducer/validation_CH_AHV.c2
-rw-r--r--src/reducer/validation_DE_SVN.c2
-rw-r--r--src/reducer/validation_IN_AADHAR.c2
7 files changed, 33 insertions, 58 deletions
diff --git a/src/reducer/anastasis_api_backup_redux.c b/src/reducer/anastasis_api_backup_redux.c
index 2f44688..cfe9f31 100644
--- a/src/reducer/anastasis_api_backup_redux.c
+++ b/src/reducer/anastasis_api_backup_redux.c
@@ -1388,7 +1388,7 @@ find_best_map (struct PolicyBuilder *pb,
* Select cheapest policy combinations and add them to the JSON ``policies``
* array in @a pb
*
- * @param[in,out] policy builder with our state
+ * @param[in,out] pb policy builder with our state
*/
static void
select_policies (struct PolicyBuilder *pb)
@@ -3383,7 +3383,7 @@ truth_upload_cb (void *cls,
* @a truth for policy reference @a pmr. If such a truth object
* already exists, append @a pmr to its list of reasons.
*
- * @param[in,out] our upload context
+ * @param[in,out] uc our upload context
* @param pmr policy method combination that requires the truth
* @param provider_url the URL of the Anastasis provider to upload
* the truth to, used to check for existing entries
@@ -3556,7 +3556,7 @@ add_truth_object (struct UploadContext *uc,
* policy reference @a pmr. If the upload is already queued,
* append @a pmr to its list of reasons.
*
- * @param[in,out] our upload context
+ * @param[in,out] uc our upload context
* @param pmr policy method combination that requires the truth
* @param provider_url the URL of the Anastasis provider to upload
* the truth to, used to check for existing entries
@@ -3755,7 +3755,6 @@ check_truth_upload (struct UploadContext *uc,
* and change providers/policies), or payment, or finished.
*
* @param state state to operate on
- * @param truth_indices indices of truths to upload explicitly
* @param cb callback (#ANASTASIS_ActionCallback) to call after upload
* @param cb_cls callback closure
*/
@@ -4482,18 +4481,6 @@ typedef struct ANASTASIS_ReduxAction *
void *cb_cls);
-/**
- * Operates on a backup state depending on given #ANASTASIS_BackupState
- * and #ANASTASIS_BackupAction. The new #ANASTASIS_BackupState is returned
- * by a callback function.
- * This function can do network access to talk to anastasis service providers.
- *
- * @param[in,out] state input/output state (to be modified)
- * @param action what action to perform
- * @param arguments data for the @a action
- * @param cb function to call with the result
- * @param cb_cls closure for @a cb
- */
struct ANASTASIS_ReduxAction *
ANASTASIS_backup_action_ (json_t *state,
const char *action,
diff --git a/src/reducer/anastasis_api_recovery_redux.c b/src/reducer/anastasis_api_recovery_redux.c
index 0d395bc..84db8fe 100644
--- a/src/reducer/anastasis_api_recovery_redux.c
+++ b/src/reducer/anastasis_api_recovery_redux.c
@@ -261,7 +261,7 @@ update_state_by_error (json_t *state,
* On success, the secret is returned in @a secret.
*
* @param cls handle for the callback
- * @param ec error code
+ * @param rc error code
* @param secret contains the core secret which is passed to the user
* @param secret_size defines the size of the core secret
*/
@@ -1655,18 +1655,6 @@ typedef struct ANASTASIS_ReduxAction *
void *cb_cls);
-/**
- * Operates on a recovery state depending on given #ANASTASIS_RecoveryState
- * and #ANASTASIS_RecoveryAction. The new #ANASTASIS_RecoveryState is returned
- * by a callback function.
- * This function can do network access to talk to anastasis service providers.
- *
- * @param[in,out] state input/output state (to be modified)
- * @param action what action to perform
- * @param arguments data for the @a action
- * @param cb function to call with the result
- * @param cb_cls closure for @a cb
- */
struct ANASTASIS_ReduxAction *
ANASTASIS_recovery_action_ (json_t *state,
const char *action,
@@ -1919,9 +1907,9 @@ struct RecoverSecretState
/**
- * Function to free a #RecoverSecretState.
+ * Function to free a `struct RecoverSecretState`
*
- * @param cls closure for a #RecoverSecretState.
+ * @param cls must be a `struct RecoverSecretState`
*/
static void
free_rss (void *cls)
@@ -1967,7 +1955,7 @@ free_rss (void *cls)
* we are called, it is because of some fatal error.
*
* @param cls a `struct PolicyDownloadEntry`
- * @param ec error code
+ * @param rc error code
* @param secret contains the core secret which is passed to the user
* @param secret_size defines the size of the core secret
*/
diff --git a/src/reducer/anastasis_api_redux.c b/src/reducer/anastasis_api_redux.c
index 41b3fd7..c41d801 100644
--- a/src/reducer/anastasis_api_redux.c
+++ b/src/reducer/anastasis_api_redux.c
@@ -332,7 +332,7 @@ ANASTASIS_redux_init (struct GNUNET_CURL_Context *ctx)
/**
- * Function to free a #ConfigRequest, an async operation.
+ * Function to free a `struct ConfigRequest`, an async operation.
*
* @param cr state for a "get config" operation
*/
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
diff --git a/src/reducer/validation_CH_AHV.c b/src/reducer/validation_CH_AHV.c
index 5bf6fb3..5f852ad 100644
--- a/src/reducer/validation_CH_AHV.c
+++ b/src/reducer/validation_CH_AHV.c
@@ -26,7 +26,7 @@
/**
* Function to validate a Swiss AHV number.
*
- * @param avh_number ahv number to validate (input)
+ * @param ahv_number ahv number to validate (input)
* @return true if validation passed, else false
*/
bool
diff --git a/src/reducer/validation_DE_SVN.c b/src/reducer/validation_DE_SVN.c
index 0bfe02e..81faf43 100644
--- a/src/reducer/validation_DE_SVN.c
+++ b/src/reducer/validation_DE_SVN.c
@@ -47,7 +47,7 @@ q (unsigned int v)
* and https://de.wikipedia.org/wiki/Versicherungsnummer
* for the structure!
*
- * @param avh_number ahv number to validate (input)
+ * @param ssn_number social security number to validate (input)
* @return true if validation passed, else false
*/
bool
diff --git a/src/reducer/validation_IN_AADHAR.c b/src/reducer/validation_IN_AADHAR.c
index ee38f3f..8ce2bc2 100644
--- a/src/reducer/validation_IN_AADHAR.c
+++ b/src/reducer/validation_IN_AADHAR.c
@@ -58,7 +58,7 @@ static int p[10][10] = {
* Converts a string to a reversed integer array.
*
* @param input The numeric string data converted to reversed int array.
- * @param[out] Integer array containing the digits in the numeric string
+ * @param[out] output array containing the digits in the numeric string
* in reverse order
*/
static bool
generated by cgit v1.2.3 (git 2.39.1) at 2024-04-27 23:54:38 +0000