summaryrefslogtreecommitdiff
path: root/src/include/anastasis_testing_lib.h
diff options
context:
space:
mode:
authorChristian Grothoff <christian@grothoff.org>2021-08-02 11:27:16 +0200
committerChristian Grothoff <christian@grothoff.org>2021-08-02 11:27:43 +0200
commit3e8be4c4f824a09df14734ac4ccb9bcc5b2535d2 (patch)
tree44e598cf0c7f40be1d9d28a00a51225bc9223198 /src/include/anastasis_testing_lib.h
parent180bd952704ec7661cb7c6a8e3233d86d5e72598 (diff)
downloadanastasis-3e8be4c4f824a09df14734ac4ccb9bcc5b2535d2.tar.gz
anastasis-3e8be4c4f824a09df14734ac4ccb9bcc5b2535d2.tar.bz2
anastasis-3e8be4c4f824a09df14734ac4ccb9bcc5b2535d2.zip
-doxygen fixes
Diffstat (limited to 'src/include/anastasis_testing_lib.h')
-rw-r--r--src/include/anastasis_testing_lib.h46
1 files changed, 25 insertions, 21 deletions
diff --git a/src/include/anastasis_testing_lib.h b/src/include/anastasis_testing_lib.h
index a54e3ae..80018d9 100644
--- a/src/include/anastasis_testing_lib.h
+++ b/src/include/anastasis_testing_lib.h
@@ -62,7 +62,7 @@ ANASTASIS_TESTING_get_trait_hash (const struct TALER_TESTING_Command *cmd,
*
* @param index the number's index number.
* @param h the hash to offer.
- * @return #GNUNET_OK on success.
+ * @return trait on success.
*/
struct TALER_TESTING_Trait
ANASTASIS_TESTING_make_trait_hash (unsigned int index,
@@ -89,7 +89,7 @@ ANASTASIS_TESTING_get_trait_truth_key (
*
* @param index usually zero
* @param h the account_pub to offer.
- * @return #GNUNET_OK on success.
+ * @return trait on success.
*/
struct TALER_TESTING_Trait
ANASTASIS_TESTING_make_trait_truth_key (
@@ -118,7 +118,7 @@ ANASTASIS_TESTING_get_trait_account_pub (
*
* @param index usually zero
* @param h the account_pub to offer.
- * @return #GNUNET_OK on success.
+ * @return trait on success
*/
struct TALER_TESTING_Trait
ANASTASIS_TESTING_make_trait_account_pub (
@@ -147,7 +147,7 @@ ANASTASIS_TESTING_get_trait_account_priv (
*
* @param index usually zero
* @param priv the account_priv to offer.
- * @return #GNUNET_OK on success.
+ * @return trait on success
*/
struct TALER_TESTING_Trait
ANASTASIS_TESTING_make_trait_account_priv (
@@ -175,7 +175,7 @@ ANASTASIS_TESTING_get_trait_payment_secret (
*
* @param index usually zero
* @param h the payment secret to offer.
- * @return #GNUNET_OK on success.
+ * @return trait on success
*/
struct TALER_TESTING_Trait
ANASTASIS_TESTING_make_trait_payment_secret (
@@ -188,27 +188,27 @@ ANASTASIS_TESTING_make_trait_payment_secret (
*
* @param cmd command to extract the number from.
* @param index the number's index number.
- * @param[out] uuid set to the number coming from @a cmd.
+ * @param[out] tpk set to the number coming from @a cmd.
* @return #GNUNET_OK on success.
*/
int
ANASTASIS_TESTING_get_trait_truth_uuid (
const struct TALER_TESTING_Command *cmd,
unsigned int index,
- const struct ANASTASIS_CRYPTO_TruthUUIDP **uuid);
+ const struct ANASTASIS_CRYPTO_TruthUUIDP **tpk);
/**
* Offer a truth UUID.
*
* @param index the number's index number.
- * @param uuid the UUID to offer.
- * @return #GNUNET_OK on success.
+ * @param tpk the UUID to offer.
+ * @return trait on success
*/
struct TALER_TESTING_Trait
ANASTASIS_TESTING_make_trait_truth_uuid (
unsigned int index,
- const struct ANASTASIS_CRYPTO_TruthUUIDP *uuid);
+ const struct ANASTASIS_CRYPTO_TruthUUIDP *tpk);
/**
@@ -231,7 +231,7 @@ ANASTASIS_TESTING_get_trait_eks (
*
* @param index the number's index number.
* @param eks the encrypted key share to offer.
- * @return #GNUNET_OK on success.
+ * @return trait on success
*/
struct TALER_TESTING_Trait
ANASTASIS_TESTING_make_trait_eks (
@@ -259,7 +259,7 @@ ANASTASIS_TESTING_get_trait_code (
*
* @param index the number's index number.
* @param tpk the public key to offer.
- * @return #GNUNET_OK on success.
+ * @return trait on success
*/
struct TALER_TESTING_Trait
ANASTASIS_TESTING_make_trait_code (unsigned int index,
@@ -515,8 +515,8 @@ ANASTASIS_TESTING_get_trait_salt (
* Offer an salt.
*
* @param index the salt's index number.
- * @param u the salt to offer.
- * @return #GNUNET_OK on success.
+ * @param s the salt to offer.
+ * @return trait on success
*/
struct TALER_TESTING_Trait
ANASTASIS_TESTING_make_trait_salt (
@@ -559,7 +559,7 @@ ANASTASIS_TESTING_get_trait_truth (const struct TALER_TESTING_Command *cmd,
*
* @param index the truth's index number.
* @param t the truth to offer.
- * @return #GNUNET_OK on success.
+ * @return trait on success
*/
struct TALER_TESTING_Trait
ANASTASIS_TESTING_make_trait_truth (unsigned int index,
@@ -617,7 +617,7 @@ ANASTASIS_TESTING_cmd_truth_upload (
* @param answer the answer to the security question
* @param http_status expected HTTP status
* @param tso truth upload options
- * @param upload_ref reference to the previous upload
+ * @param salt_ref reference to command downloading provider salt
* @return the command
*/
struct TALER_TESTING_Command
@@ -652,8 +652,8 @@ ANASTASIS_TESTING_get_trait_policy (const struct TALER_TESTING_Command *cmd,
* Offer a policy.
*
* @param index the policy's index number.
- * @param t the policy to offer.
- * @return #GNUNET_OK on success.
+ * @param p the policy to offer.
+ * @return trait on success
*/
struct TALER_TESTING_Trait
ANASTASIS_TESTING_make_trait_policy (unsigned int index,
@@ -694,7 +694,7 @@ ANASTASIS_TESTING_get_trait_core_secret (const struct
*
* @param index the core secret's index number (usually 0).
* @param s the core secret to offer.
- * @return #GNUNET_OK on success.
+ * @return trait on success
*/
struct TALER_TESTING_Trait
ANASTASIS_TESTING_make_trait_core_secret (unsigned int index,
@@ -785,6 +785,8 @@ enum ANASTASIS_TESTING_RecoverSecretOption
* @param version of the recovery document to download
* @param rso recover secret options
* @param download_ref salt download reference
+ * @param core_secret_ref reference to core secret
+ * we expect to recover
* @return the command
*/
struct TALER_TESTING_Command
@@ -831,8 +833,8 @@ ANASTASIS_TESTING_get_trait_challenge (const struct TALER_TESTING_Command *cmd,
* Offer a challenge.
*
* @param index the challenge index number.
- * @param c the challenge to offer.
- * @return #GNUNET_OK on success.
+ * @param r the challenge to offer.
+ * @return trait on success
*/
struct TALER_TESTING_Trait
ANASTASIS_TESTING_make_trait_challenge (unsigned int index,
@@ -867,6 +869,8 @@ ANASTASIS_TESTING_cmd_challenge_start (
* @param challenge_ref reference to the recovery process
* @param challenge_index defines the index of the trait to solve
* @param answer to the challenge
+ * @param mode 0 for no plugin needed (security question)
+ * 1 for plugin needed to authenticate
* @param expected_cs expected reply type
* @return the command
*/