summaryrefslogtreecommitdiff
path: root/src/include
diff options
context:
space:
mode:
authorChristian Grothoff <christian@grothoff.org>2015-03-28 15:53:53 +0100
committerChristian Grothoff <christian@grothoff.org>2015-03-28 15:53:53 +0100
commit708b463580dd8ca29cda085e11e8731bd83f8130 (patch)
tree7eb5e1d44f9079057d0498a217993734b09a9937 /src/include
parente4cbe66780bd354fac79db155a12c33a9c68fbbc (diff)
downloadexchange-708b463580dd8ca29cda085e11e8731bd83f8130.tar.gz
exchange-708b463580dd8ca29cda085e11e8731bd83f8130.tar.bz2
exchange-708b463580dd8ca29cda085e11e8731bd83f8130.zip
more doxygen fixes
Diffstat (limited to 'src/include')
-rw-r--r--src/include/taler_amount_lib.h10
-rw-r--r--src/include/taler_crypto_lib.h52
-rw-r--r--src/include/taler_mintdb_lib.h8
-rw-r--r--src/include/taler_mintdb_plugin.h32
-rw-r--r--src/include/taler_signatures.h16
5 files changed, 59 insertions, 59 deletions
diff --git a/src/include/taler_amount_lib.h b/src/include/taler_amount_lib.h
index 069da1d6c..60405a2e4 100644
--- a/src/include/taler_amount_lib.h
+++ b/src/include/taler_amount_lib.h
@@ -23,7 +23,7 @@
/**
- * Number of characters (plus 1 for 0-termination) we use to
+ * @brief Number of characters (plus 1 for 0-termination) we use to
* represent currency names (i.e. EUR, USD, etc.). We use
* 4 for alignment as 3 characters are typical and we need a
* 0-terminator. So do not change this.
@@ -31,7 +31,7 @@
#define TALER_CURRENCY_LEN 4
/**
- * The "fraction" value in a `struct TALER_Amount` represents which
+ * @brief The "fraction" value in a `struct TALER_Amount` represents which
* fraction of the "main" value?
*
* Note that we need sub-cent precision here as transaction fees might
@@ -40,7 +40,7 @@
#define TALER_AMOUNT_FRAC_BASE 1000000
/**
- * How many digits behind the comma are required to represent the
+ * @brief How many digits behind the comma are required to represent the
* fractional value in human readable decimal format? Must match
* lg(#TALER_AMOUNT_FRAC_BASE).
*/
@@ -51,7 +51,7 @@ GNUNET_NETWORK_STRUCT_BEGIN
/**
- * Amount, encoded for network transmission.
+ * @brief Amount, encoded for network transmission.
*/
struct TALER_AmountNBO
{
@@ -75,7 +75,7 @@ GNUNET_NETWORK_STRUCT_END
/**
- * Representation of monetary value in a given currency.
+ * @brief Representation of monetary value in a given currency.
*/
struct TALER_Amount
{
diff --git a/src/include/taler_crypto_lib.h b/src/include/taler_crypto_lib.h
index 321c2b982..d2fd2598b 100644
--- a/src/include/taler_crypto_lib.h
+++ b/src/include/taler_crypto_lib.h
@@ -30,7 +30,7 @@
GNUNET_NETWORK_STRUCT_BEGIN
/**
- * Type of public keys for Taler reserves.
+ * @brief Type of public keys for Taler reserves.
*/
struct TALER_ReservePublicKeyP
{
@@ -42,7 +42,7 @@ struct TALER_ReservePublicKeyP
/**
- * Type of private keys for Taler reserves.
+ * @brief Type of private keys for Taler reserves.
*/
struct TALER_ReservePrivateKeyP
{
@@ -54,7 +54,7 @@ struct TALER_ReservePrivateKeyP
/**
- * Type of signatures used with Taler reserves.
+ * @brief Type of signatures used with Taler reserves.
*/
struct TALER_ReserveSignatureP
{
@@ -66,7 +66,7 @@ struct TALER_ReserveSignatureP
/**
- * Type of public keys to for merchant authorizations.
+ * @brief Type of public keys to for merchant authorizations.
* Merchants can issue refunds using the corresponding
* private key.
*/
@@ -80,7 +80,7 @@ struct TALER_MerchantPublicKeyP
/**
- * Type of private keys for merchant authorizations.
+ * @brief Type of private keys for merchant authorizations.
* Merchants can issue refunds using the corresponding
* private key.
*/
@@ -94,7 +94,7 @@ struct TALER_MerchantPrivateKeyP
/**
- * Type of transfer public keys used during refresh
+ * @brief Type of transfer public keys used during refresh
* operations.
*/
struct TALER_TransferPublicKeyP
@@ -108,7 +108,7 @@ struct TALER_TransferPublicKeyP
/**
- * Type of transfer public keys used during refresh
+ * @brief Type of transfer public keys used during refresh
* operations.
*/
struct TALER_TransferPrivateKeyP
@@ -122,7 +122,7 @@ struct TALER_TransferPrivateKeyP
/**
- * Type of online public keys used by the mint to sign
+ * @brief Type of online public keys used by the mint to sign
* messages.
*/
struct TALER_MintPublicKeyP
@@ -135,7 +135,7 @@ struct TALER_MintPublicKeyP
/**
- * Type of online public keys used by the mint to
+ * @brief Type of online public keys used by the mint to
* sign messages.
*/
struct TALER_MintPrivateKeyP
@@ -148,7 +148,7 @@ struct TALER_MintPrivateKeyP
/**
- * Type of signatures used by the mint to sign messages online.
+ * @brief Type of signatures used by the mint to sign messages online.
*/
struct TALER_MintSignatureP
{
@@ -160,7 +160,7 @@ struct TALER_MintSignatureP
/**
- * Type of the offline master public key used by the mint.
+ * @brief Type of the offline master public key used by the mint.
*/
struct TALER_MasterPublicKeyP
{
@@ -172,7 +172,7 @@ struct TALER_MasterPublicKeyP
/**
- * Type of the offline master public keys used by the mint.
+ * @brief Type of the offline master public keys used by the mint.
*/
struct TALER_MasterPrivateKeyP
{
@@ -184,7 +184,7 @@ struct TALER_MasterPrivateKeyP
/**
- * Type of signatures by the offline master public key used by the mint.
+ * @brief Type of signatures by the offline master public key used by the mint.
*/
struct TALER_MasterSignatureP
{
@@ -197,7 +197,7 @@ struct TALER_MasterSignatureP
/**
- * Type of public keys for Taler coins. The same key material is used
+ * @brief Type of public keys for Taler coins. The same key material is used
* for ECDSA and ECDHE operations.
*/
union TALER_CoinSpendPublicKeyP
@@ -215,7 +215,7 @@ union TALER_CoinSpendPublicKeyP
/**
- * Type of private keys for Taler coins. The same key material is used
+ * @brief Type of private keys for Taler coins. The same key material is used
* for ECDSA and ECDHE operations.
*/
union TALER_CoinSpendPrivateKeyP
@@ -233,7 +233,7 @@ union TALER_CoinSpendPrivateKeyP
/**
- * Type of signatures made with Taler coins.
+ * @brief Type of signatures made with Taler coins.
*/
struct TALER_CoinSpendSignatureP
{
@@ -249,7 +249,7 @@ GNUNET_NETWORK_STRUCT_END
/**
- * Type of blinding keys for Taler.
+ * @brief Type of blinding keys for Taler.
*/
struct TALER_DenominationBlindingKey
{
@@ -261,7 +261,7 @@ struct TALER_DenominationBlindingKey
/**
- * Type of (unblinded) coin signatures for Taler.
+ * @brief Type of (unblinded) coin signatures for Taler.
*/
struct TALER_DenominationSignature
{
@@ -273,7 +273,7 @@ struct TALER_DenominationSignature
/**
- * Type of public signing keys for verifying blindly signed coins.
+ * @brief Type of public signing keys for verifying blindly signed coins.
*/
struct TALER_DenominationPublicKey
{
@@ -285,7 +285,7 @@ struct TALER_DenominationPublicKey
/**
- * Type of private signing keys for blind signing of coins.
+ * @brief Type of private signing keys for blind signing of coins.
*/
struct TALER_DenominationPrivateKey
{
@@ -297,7 +297,7 @@ struct TALER_DenominationPrivateKey
/**
- * Public information about a coin (including the public key
+ * @brief Public information about a coin (including the public key
* of the coin, the denomination key and the signature with
* the denomination key).
*/
@@ -341,7 +341,7 @@ TALER_test_coin_valid (const struct TALER_CoinPublicInfo *coin_public_info);
GNUNET_NETWORK_STRUCT_BEGIN
/**
- * Secret used to decrypt the key to decrypt link secrets.
+ * @brief Secret used to decrypt the key to decrypt link secrets.
*/
struct TALER_TransferSecretP
{
@@ -355,7 +355,7 @@ struct TALER_TransferSecretP
/**
- * Secret used to decrypt refresh links.
+ * @brief Secret used to decrypt refresh links.
*/
struct TALER_LinkSecretP
{
@@ -367,7 +367,7 @@ struct TALER_LinkSecretP
/**
- * Encrypted secret used to decrypt refresh links.
+ * @brief Encrypted secret used to decrypt refresh links.
*/
struct TALER_EncryptedLinkSecretP
{
@@ -379,7 +379,7 @@ struct TALER_EncryptedLinkSecretP
/**
- * Representation of an refresh link in cleartext.
+ * @brief Representation of an refresh link in cleartext.
*/
struct TALER_RefreshLinkDecryptedP
{
@@ -401,7 +401,7 @@ GNUNET_NETWORK_STRUCT_END
/**
- * Representation of an encrypted refresh link.
+ * @brief Representation of an encrypted refresh link.
*/
struct TALER_RefreshLinkEncrypted
{
diff --git a/src/include/taler_mintdb_lib.h b/src/include/taler_mintdb_lib.h
index 76baa5202..646693dee 100644
--- a/src/include/taler_mintdb_lib.h
+++ b/src/include/taler_mintdb_lib.h
@@ -42,7 +42,7 @@
GNUNET_NETWORK_STRUCT_BEGIN
/**
- * On disk format used for a mint signing key. Signing keys are used
+ * @brief On disk format used for a mint signing key. Signing keys are used
* by the mint to affirm its messages, but not to create coins.
* Includes the private key followed by the public information about
* the signing key.
@@ -65,7 +65,7 @@ GNUNET_NETWORK_STRUCT_END
/**
- * All information about a denomination key (which is used to
+ * @brief All information about a denomination key (which is used to
* sign coins into existence).
*/
struct TALER_MINTDB_DenominationKeyIssueInformation
@@ -91,7 +91,7 @@ struct TALER_MINTDB_DenominationKeyIssueInformation
/**
- * Iterator over signing keys.
+ * @brief Iterator over signing keys.
*
* @param cls closure
* @param filename name of the file the key came from
@@ -107,7 +107,7 @@ typedef int
/**
- * Iterator over denomination keys.
+ * @brief Iterator over denomination keys.
*
* @param cls closure
* @param dki the denomination key
diff --git a/src/include/taler_mintdb_plugin.h b/src/include/taler_mintdb_plugin.h
index 868fb4388..18f3499f3 100644
--- a/src/include/taler_mintdb_plugin.h
+++ b/src/include/taler_mintdb_plugin.h
@@ -27,7 +27,7 @@
/**
- * Information we keep on bank transfer(s) that established a reserve.
+ * @brief Information we keep on bank transfer(s) that established a reserve.
*/
struct TALER_MINTDB_BankTransfer
{
@@ -51,7 +51,7 @@ struct TALER_MINTDB_BankTransfer
/**
- * A summary of a Reserve
+ * @brief A summary of a Reserve
*/
struct TALER_MINTDB_Reserve
{
@@ -73,7 +73,7 @@ struct TALER_MINTDB_Reserve
/**
- * Information we keep for a withdrawn coin to reproduce
+ * @brief Information we keep for a withdrawn coin to reproduce
* the /withdraw operation if needed, and to have proof
* that a reserve was drained by this amount.
*/
@@ -114,7 +114,7 @@ struct TALER_MINTDB_CollectableBlindcoin
/**
- * Types of operations on a reserved.
+ * @brief Types of operations on a reserved.
*/
enum TALER_MINTDB_ReserveOperation
{
@@ -131,7 +131,7 @@ enum TALER_MINTDB_ReserveOperation
/**
- * Reserve history as a linked list. Lists all of the transactions
+ * @brief Reserve history as a linked list. Lists all of the transactions
* associated with this reserve (such as the bank transfers that
* established the reserve and all /withdraw operations we have done
* since).
@@ -171,7 +171,7 @@ struct TALER_MINTDB_ReserveHistory
/**
- * Specification for a /deposit operation.
+ * @brief Specification for a /deposit operation.
*/
struct TALER_MINTDB_Deposit
{
@@ -234,7 +234,7 @@ struct TALER_MINTDB_Deposit
/**
- * Global information for a refreshing session. Includes
+ * @brief Global information for a refreshing session. Includes
* dimensions of the operation, security parameters and
* client signatures from "/refresh/melt" and "/refresh/commit".
*/
@@ -261,7 +261,7 @@ struct TALER_MINTDB_RefreshSession
/**
- * Specification for coin in a /refresh/melt operation.
+ * @brief Specification for coin in a /refresh/melt operation.
*/
struct TALER_MINTDB_RefreshMelt
{
@@ -294,7 +294,7 @@ struct TALER_MINTDB_RefreshMelt
/**
- * We have as many `struct TALER_MINTDB_RefreshCommitCoin` as there are new
+ * @brief We have as many `struct TALER_MINTDB_RefreshCommitCoin` as there are new
* coins being created by the refresh (for each of the #TALER_CNC_KAPPA
* sets). These are the coins we ask the mint to sign if the
* respective set is selected.
@@ -324,7 +324,7 @@ struct TALER_MINTDB_RefreshCommitCoin
GNUNET_NETWORK_STRUCT_BEGIN
/**
- * For each (old) coin being melted, we have a `struct
+ * @brief For each (old) coin being melted, we have a `struct
* RefreshCommitLink` that allows the user to find the shared secret
* to decrypt the respective refresh links for the new coins in the
* `struct TALER_MINTDB_RefreshCommitCoin`.
@@ -349,7 +349,7 @@ GNUNET_NETWORK_STRUCT_END
/**
- * Linked list of refresh information linked to a coin.
+ * @brief Linked list of refresh information linked to a coin.
*/
struct TALER_MINTDB_LinkDataList
{
@@ -377,7 +377,7 @@ struct TALER_MINTDB_LinkDataList
/**
- * Specification for a /lock operation.
+ * @brief Specification for a /lock operation.
*/
struct TALER_MINTDB_LockOperation
{
@@ -401,7 +401,7 @@ struct TALER_MINTDB_LockOperation
/**
- * Enumeration to classify the different types of transactions
+ * @brief Enumeration to classify the different types of transactions
* that can be done with a coin.
*/
enum TALER_MINTDB_TransactionType
@@ -424,7 +424,7 @@ enum TALER_MINTDB_TransactionType
/**
- * List of transactions we performed for a particular coin.
+ * @brief List of transactions we performed for a particular coin.
*/
struct TALER_MINTDB_TransactionList
{
@@ -466,13 +466,13 @@ struct TALER_MINTDB_TransactionList
/**
- * Handle for a database session (per-thread, for transactions).
+ * @brief Handle for a database session (per-thread, for transactions).
*/
struct TALER_MINTDB_Session;
/**
- * The plugin API, returned from the plugin's "init" function.
+ * @brief The plugin API, returned from the plugin's "init" function.
* The argument given to "init" is simply a configuration handle.
*/
struct TALER_MINTDB_Plugin
diff --git a/src/include/taler_signatures.h b/src/include/taler_signatures.h
index 54c2c506c..1c57ba058 100644
--- a/src/include/taler_signatures.h
+++ b/src/include/taler_signatures.h
@@ -122,7 +122,7 @@
GNUNET_NETWORK_STRUCT_BEGIN
/**
- * Format used for to generate the signature on a request to withdraw
+ * @brief Format used for to generate the signature on a request to withdraw
* coins from a reserve.
*/
struct TALER_WithdrawRequestPS
@@ -175,7 +175,7 @@ struct TALER_WithdrawRequestPS
/**
- * Format used to generate the signature on a request to deposit
+ * @brief Format used to generate the signature on a request to deposit
* a coin into the account of a merchant.
*/
struct TALER_DepositRequestPS
@@ -266,7 +266,7 @@ struct TALER_DepositRequestPS
/**
- * Format used to generate the signature on a confirmation
+ * @brief Format used to generate the signature on a confirmation
* from the mint that a deposit request succeeded.
*/
struct TALER_DepositConfirmationPS
@@ -331,7 +331,7 @@ struct TALER_DepositConfirmationPS
/**
- * Message signed by a coin to indicate that the coin should be
+ * @brief Message signed by a coin to indicate that the coin should be
* melted.
*/
struct TALER_RefreshMeltCoinAffirmationPS
@@ -378,7 +378,7 @@ struct TALER_RefreshMeltCoinAffirmationPS
/**
- * Format of the block signed by the Mint in response to a successful
+ * @brief Format of the block signed by the Mint in response to a successful
* "/refresh/melt" request. Hereby the mint affirms that all of the
* coins were successfully melted. This also commits the mint to a
* particular index to not be revealed during the refresh.
@@ -405,7 +405,7 @@ struct TALER_RefreshMeltConfirmationPS
/**
- * Information about a signing key of the mint. Signing keys are used
+ * @brief Information about a signing key of the mint. Signing keys are used
* to sign mint messages other than coins, i.e. to confirm that a
* deposit was successful or that a refresh was accepted.
*/
@@ -460,7 +460,7 @@ struct TALER_MintSigningKeyValidityPS
/**
- * Signature made by the mint over the full set of keys, used
+ * @brief Signature made by the mint over the full set of keys, used
* to detect cheating mints that give out different sets to
* different users.
*/
@@ -490,7 +490,7 @@ struct TALER_MintKeySetPS
/**
- * Information about a denomination key. Denomination keys
+ * @brief Information about a denomination key. Denomination keys
* are used to sign coins of a certain value into existence.
*/
struct TALER_DenominationKeyValidityPS