taler/exchange
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

fixing misc doxygen issues

Browse Source
This commit is contained in:
Christian Grothoff 2017-06-04 11:30:43 +02:00
parent c7c7ac60cf
commit 1e30d60a25
No known key found for this signature in database
GPG Key ID: 939E6BE1E29FC3CC
13 changed files with 121 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
Doxyfile
View File

@ -207,7 +207,8 @@ SKIP_FUNCTION_MACROS = YES
#---------------------------------------------------------------------------
# Configuration::additions related to external references
#---------------------------------------------------------------------------
TAGFILES =
TAGFILES = contrib/gnunet.tag \
contrib/microhttpd.tag
GENERATE_TAGFILE = contrib/taler-exchange.tag
ALLEXTERNALS = NO
EXTERNAL_GROUPS = YES
@ -233,7 +234,7 @@ DIRECTORY_GRAPH = YES
DOT_IMAGE_FORMAT = png
DOT_PATH =
DOTFILE_DIRS =
DOT_GRAPH_MAX_NODES = 25
DOT_GRAPH_MAX_NODES = 100
MAX_DOT_GRAPH_DEPTH = 2
DOT_TRANSPARENT = YES
DOT_MULTI_TARGETS = NO

55
contrib/gnunet.tag Normal file
View File

@ -0,0 +1,55 @@
<?xml version='1.0' encoding='UTF-8' standalone='yes' ?>
<tagfile>
<compound kind="file">
<name>gnunet_util_lib.h</name>
<path></path>
<filename>gnunet_util_lib.h</filename>
<member kind="define">
<type>#define</type>
<name>GNUNET_YES</name>
<anchorfile>gnunet_util_lib.h</anchorfile>
<arglist></arglist>
</member>
<member kind="define">
<type>#define</type>
<name>GNUNET_OK</name>
<anchorfile>gnunet_util_lib.h</anchorfile>
<arglist></arglist>
</member>
<member kind="define">
<type>#define</type>
<name>GNUNET_NO</name>
<anchorfile>gnunet_util_lib.h</anchorfile>
<arglist></arglist>
</member>
<member kind="define">
<type>#define</type>
<name>GNUNET_SYSERR</name>
<anchorfile>gnunet_util_lib.h</anchorfile>
<arglist></arglist>
</member>
<member kind="define">
<type>#define</type>
<name>GNUNET_TIME_UNIT_FOREVER_ABS</name>
<anchorfile>gnunet_util_lib.h</anchorfile>
<arglist></arglist>
</member>
</compound>
<compound kind="file">
<name>gnunet_pq_lib.h</name>
<path></path>
<filename>gnunet_pq_lib.h</filename>
<member kind="define">
<type>#define</type>
<name>GNUNET_PQ_query_param_end</name>
<anchorfile>gnunet_pq_lib.h</anchorfile>
<arglist></arglist>
</member>
<member kind="typedef">
<type>int</type>
<name>GNUNET_PQ_ResultConverter</name>
<anchorfile>gnunet_pq_lib.h</anchorfile>
<arglist>)(void *cls, PGresult *result, int row, const char *fname, size_t *dst_size, void *dst)</arglist>
</member>
</compound>
</tagfile>

44
contrib/microhttpd.tag Normal file
View File

@ -0,0 +1,44 @@
<?xml version='1.0' encoding='UTF-8' standalone='yes' ?>
<tagfile>
<compound kind="file">
<name>microhttpd_lib.h</name>
<path></path>
<filename>microhttpd.h</filename>
<member kind="define">
<type>#define</type>
<name>MHD_YES</name>
<anchorfile>microhttpd.h</anchorfile>
<arglist></arglist>
</member>
<member kind="define">
<type>#define</type>
<name>MHD_NO</name>
<anchorfile>microhttpd.h</anchorfile>
<arglist></arglist>
</member>
<member kind="define">
<type>#define</type>
<name>MHD_HTTP_OK</name>
<anchorfile>microhttpd.h</anchorfile>
<arglist></arglist>
</member>
<member kind="define">
<type>#define</type>
<name>MHD_HTTP_NO_CONTENT</name>
<anchorfile>microhttpd.h</anchorfile>
<arglist></arglist>
</member>
<member kind="define">
<type>#define</type>
<name>MHD_OPTION_NOTIFY_COMPLETED</name>
<anchorfile>microhttpd.h</anchorfile>
<arglist></arglist>
</member>
<member kind="typedef">
<type>int</type>
<name>MHD_AccessHandlerCallback</name>
<anchorfile>microhttpd.h</anchorfile>
<arglist>)(void *cls, struct MHD_Connection *connection, const char *url, const char *method, const char *version, const char *upload_data, size_t *upload_data_size, void **con_cls)</arglist>
</member>
</compound>
</tagfile>

1
src/bank-lib/fakebank.c
View File

@ -393,6 +393,7 @@ handle_admin_add_incoming (struct TALER_FAKEBANK_Handle *h,
*
* @param h the fakebank handle
* @param connection the connection
* @param con_cls place to store state, not used
* @return MHD result code
*/
static int

2
src/exchange-lib/exchange_api_refresh.c
View File

@ -690,7 +690,7 @@ deserialize_melt_data (const char *buf,
* if the inputs are invalid (i.e. denomination key not with this exchange).
* Otherwise, pointer to a buffer of @a res_size to store persistently
* before proceeding to #TALER_EXCHANGE_refresh_melt().
* Non-null results should be freed using #GNUNET_free().
* Non-null results should be freed using GNUNET_free().
*/
char *
TALER_EXCHANGE_refresh_prepare (const struct TALER_CoinSpendPrivateKeyP *melt_priv,

4
src/exchange/taler-exchange-httpd_parsing.c
View File

@ -174,7 +174,7 @@ TEH_PARSE_mhd_request_arg_data (struct MHD_Connection *connection,
* @return
* #GNUNET_YES if navigation was successful (caller is responsible
* for freeing allocated variable-size data using
* #GNUNET_JSON_parse_free() when done)
* GNUNET_JSON_parse_free() when done)
* #GNUNET_NO if json is malformed, error response was generated
* #GNUNET_SYSERR on internal error
*/
@ -221,7 +221,7 @@ TEH_PARSE_json_data (struct MHD_Connection *connection,
* @return
* #GNUNET_YES if navigation was successful (caller is responsible
* for freeing allocated variable-size data using
* #GNUNET_JSON_parse_free() when done)
* GNUNET_JSON_parse_free() when done)
* #GNUNET_NO if json is malformed, error response was generated
* #GNUNET_SYSERR on internal error
*/

4
src/exchange/taler-exchange-httpd_parsing.h
View File

@ -82,7 +82,7 @@ TEH_PARSE_post_cleanup_callback (void *con_cls);
* @return
* #GNUNET_YES if navigation was successful (caller is responsible
* for freeing allocated variable-size data using
* #GNUNET_JSON_parse_free() when done)
* GNUNET_JSON_parse_free() when done)
* #GNUNET_NO if json is malformed, error response was generated
* #GNUNET_SYSERR on internal error
*/
@ -103,7 +103,7 @@ TEH_PARSE_json_data (struct MHD_Connection *connection,
* @return
* #GNUNET_YES if navigation was successful (caller is responsible
* for freeing allocated variable-size data using
* #GNUNET_JSON_parse_free() when done)
* GNUNET_JSON_parse_free() when done)
* #GNUNET_NO if json is malformed, error response was generated
* #GNUNET_SYSERR on internal error
*/

2
src/exchange/taler-exchange-httpd_responses.c
View File

@ -84,7 +84,7 @@ TEH_RESPONSE_can_compress (struct MHD_Connection *connection)
*
* @param[in,out] buf pointer to body to compress
* @param[in,out] buf_size pointer to initial size of @a buf
* @return #MHD_TES if @a buf was compressed
* @return #MHD_YES if @a buf was compressed
*/
int
TEH_RESPONSE_body_compress (void **buf,

4
src/exchange/taler-exchange-httpd_responses.h
View File

@ -50,14 +50,14 @@ TEH_RESPONSE_add_global_headers (struct MHD_Response *response);
*
* @param[in,out] buf pointer to body to compress
* @param[in,out] buf_size pointer to initial size of @a buf
* @return #MHD_TES if @a buf was compressed
* @return #MHD_YES if @a buf was compressed
*/
int
TEH_RESPONSE_body_compress (void **buf,
size_t *buf_size);
/**
/**
* Is HTTP body deflate compression supported by the client?
*
* @param connection connection to check

4
src/include/taler_crypto_lib.h
View File

@ -390,7 +390,7 @@ struct TALER_TrackTransferDetails
* @param coin_public_info the coin public info to check for validity
* @return #GNUNET_YES if the coin is valid,
* #GNUNET_NO if it is invalid
* #GNUNET_SYSERROR if an internal error occured
* #GNUNET_SYSERR if an internal error occured
*/
int
TALER_test_coin_valid (const struct TALER_CoinPublicInfo *coin_public_info);
@ -409,7 +409,7 @@ struct TALER_TransferSecretP
/**
* Secret used to derive private inputs for refreshed coins.
* Must be (currently) a hash as this is what
* #GNUNET_CRYPTO_ecc_ecdh() returns to us.
* GNUNET_CRYPTO_ecc_ecdh() returns to us.
*/
struct GNUNET_HashCode key;
};

2
src/include/taler_exchange_service.h
View File

@ -970,7 +970,7 @@ TALER_EXCHANGE_reserve_withdraw_cancel (struct TALER_EXCHANGE_ReserveWithdrawHan
* if the inputs are invalid (i.e. denomination key not with this exchange).
* Otherwise, pointer to a buffer of @a res_size to store persistently
* before proceeding to #TALER_EXCHANGE_refresh_melt().
* Non-null results should be freed using #GNUNET_free().
* Non-null results should be freed using GNUNET_free().
*/
char *
TALER_EXCHANGE_refresh_prepare (const struct TALER_CoinSpendPrivateKeyP *melt_priv,

8
src/pq/pq_query_helper.c
View File

@ -36,7 +36,7 @@
* @param[out] param_lengths SQL length data to set
* @param[out] param_formats SQL format data to set
* @param param_length number of entries available in the @a param_values, @a param_lengths and @a param_formats arrays
* @param[out] scratch buffer for dynamic allocations (to be done via #GNUNET_malloc()
* @param[out] scratch buffer for dynamic allocations (to be done via GNUNET_malloc()
* @param scratch_length number of entries left in @a scratch
* @return -1 on error, number of offsets used in @a scratch otherwise
*/
@ -98,7 +98,7 @@ TALER_PQ_query_param_amount_nbo (const struct TALER_AmountNBO *x)
* @param[out] param_lengths SQL length data to set
* @param[out] param_formats SQL format data to set
* @param param_length number of entries available in the @a param_values, @a param_lengths and @a param_formats arrays
* @param[out] scratch buffer for dynamic allocations (to be done via #GNUNET_malloc()
* @param[out] scratch buffer for dynamic allocations (to be done via GNUNET_malloc()
* @param scratch_length number of entries left in @a scratch
* @return -1 on error, number of offsets used in @a scratch otherwise
*/
@ -161,7 +161,7 @@ TALER_PQ_query_param_amount (const struct TALER_Amount *x)
* @param[out] param_lengths SQL length data to set
* @param[out] param_formats SQL format data to set
* @param param_length number of entries available in the @a param_values, @a param_lengths and @a param_formats arrays
* @param[out] scratch buffer for dynamic allocations (to be done via #GNUNET_malloc()
* @param[out] scratch buffer for dynamic allocations (to be done via GNUNET_malloc()
* @param scratch_length number of entries left in @a scratch
* @return -1 on error, number of offsets used in @a scratch otherwise
*/
@ -178,7 +178,7 @@ qconv_json (void *cls,
{
const json_t *json = data;
char *str;
str = json_dumps (json, JSON_COMPACT);
if (NULL == str)
return -1;

6
src/util/crypto.c
View File

@ -79,7 +79,7 @@ TALER_gcrypt_init ()
* @param coin_public_info the coin public info to check for validity
* @return #GNUNET_YES if the coin is valid,
* #GNUNET_NO if it is invalid
* #GNUNET_SYSERROR if an internal error occured
* #GNUNET_SYSERR if an internal error occured
*/
int
TALER_test_coin_valid (const struct TALER_CoinPublicInfo *coin_public_info)
@ -205,10 +205,10 @@ TALER_setup_fresh_coin (const struct TALER_TransferSecretP *secret_seed,
p[31] &= 0xf8; /* Clear bits 2..0 so that d mod 8 == 0 */
/* FIXME: Run GNUNET_CRYPTO_ecdhe_key_create several times and inspect
* the output to verify that the same bits are set and cleared.
* the output to verify that the same bits are set and cleared.
* Is it worth also adding a test case that runs gcry_pk_testkey on
* this key after first parsing it into libgcrypt's s-expression mess
* ala decode_private_eddsa_key from gnunet/src/util/crypto_ecc.c?
* ala decode_private_eddsa_key from gnunet/src/util/crypto_ecc.c?
* It'd run check_secret_key but not test_keys from libgcrypt/cipher/ecc.c */
}