[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[GNUnet-SVN] [taler-exchange] 02/03: fixing misc doxygen issues
|
From: |
gnunet |
|
Subject: |
[GNUnet-SVN] [taler-exchange] 02/03: fixing misc doxygen issues |
|
Date: |
Sun, 04 Jun 2017 11:33:55 +0200 |
This is an automated email from the git hooks/post-receive script.
grothoff pushed a commit to branch master
in repository exchange.
commit 1e30d60a25da52550c10f9c6606024f028f943d2
Author: Christian Grothoff <address@hidden>
AuthorDate: Sun Jun 4 11:30:43 2017 +0200
fixing misc doxygen issues
---
Doxyfile | 5 ++-
contrib/gnunet.tag | 55 +++++++++++++++++++++++++++
contrib/microhttpd.tag | 44 +++++++++++++++++++++
src/bank-lib/fakebank.c | 1 +
src/exchange-lib/exchange_api_refresh.c | 2 +-
src/exchange/taler-exchange-httpd_parsing.c | 4 +-
src/exchange/taler-exchange-httpd_parsing.h | 4 +-
src/exchange/taler-exchange-httpd_responses.c | 2 +-
src/exchange/taler-exchange-httpd_responses.h | 4 +-
src/include/taler_crypto_lib.h | 4 +-
src/include/taler_exchange_service.h | 2 +-
src/pq/pq_query_helper.c | 8 ++--
src/util/crypto.c | 6 +--
13 files changed, 121 insertions(+), 20 deletions(-)
diff --git a/Doxyfile b/Doxyfile
index 0fef809..359c720 100644
--- a/Doxyfile
+++ b/Doxyfile
@@ -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
diff --git a/contrib/gnunet.tag b/contrib/gnunet.tag
new file mode 100644
index 0000000..1cf4f0d
--- /dev/null
+++ b/contrib/gnunet.tag
@@ -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>
diff --git a/contrib/microhttpd.tag b/contrib/microhttpd.tag
new file mode 100644
index 0000000..de7018a
--- /dev/null
+++ b/contrib/microhttpd.tag
@@ -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>
diff --git a/src/bank-lib/fakebank.c b/src/bank-lib/fakebank.c
index 813d5b2..924e065 100644
--- a/src/bank-lib/fakebank.c
+++ b/src/bank-lib/fakebank.c
@@ -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
diff --git a/src/exchange-lib/exchange_api_refresh.c
b/src/exchange-lib/exchange_api_refresh.c
index 84fb3b7..79381f3 100644
--- a/src/exchange-lib/exchange_api_refresh.c
+++ b/src/exchange-lib/exchange_api_refresh.c
@@ -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,
diff --git a/src/exchange/taler-exchange-httpd_parsing.c
b/src/exchange/taler-exchange-httpd_parsing.c
index e9c38eb..4d7b5ab 100644
--- a/src/exchange/taler-exchange-httpd_parsing.c
+++ b/src/exchange/taler-exchange-httpd_parsing.c
@@ -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
*/
diff --git a/src/exchange/taler-exchange-httpd_parsing.h
b/src/exchange/taler-exchange-httpd_parsing.h
index bd705d5..9c53817 100644
--- a/src/exchange/taler-exchange-httpd_parsing.h
+++ b/src/exchange/taler-exchange-httpd_parsing.h
@@ -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
*/
diff --git a/src/exchange/taler-exchange-httpd_responses.c
b/src/exchange/taler-exchange-httpd_responses.c
index 0eebda6..346f620 100644
--- a/src/exchange/taler-exchange-httpd_responses.c
+++ b/src/exchange/taler-exchange-httpd_responses.c
@@ -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,
diff --git a/src/exchange/taler-exchange-httpd_responses.h
b/src/exchange/taler-exchange-httpd_responses.h
index ccd1188..6a33b65 100644
--- a/src/exchange/taler-exchange-httpd_responses.h
+++ b/src/exchange/taler-exchange-httpd_responses.h
@@ -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
diff --git a/src/include/taler_crypto_lib.h b/src/include/taler_crypto_lib.h
index 9c854ab..9e9352f 100644
--- a/src/include/taler_crypto_lib.h
+++ b/src/include/taler_crypto_lib.h
@@ -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;
};
diff --git a/src/include/taler_exchange_service.h
b/src/include/taler_exchange_service.h
index b60b97e..7114aa6 100644
--- a/src/include/taler_exchange_service.h
+++ b/src/include/taler_exchange_service.h
@@ -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,
diff --git a/src/pq/pq_query_helper.c b/src/pq/pq_query_helper.c
index bbfa0ee..d6418a1 100644
--- a/src/pq/pq_query_helper.c
+++ b/src/pq/pq_query_helper.c
@@ -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;
diff --git a/src/util/crypto.c b/src/util/crypto.c
index d20c9a9..ce5bfac 100644
--- a/src/util/crypto.c
+++ b/src/util/crypto.c
@@ -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 */
}
--
To stop receiving notification emails like this one, please contact
address@hidden