From eca4f1a8fe52d463b6b87d19c245e7aa02197476 Mon Sep 17 00:00:00 2001 From: Christian Grothoff Date: Sat, 28 Mar 2015 15:42:07 +0100 Subject: -doxygen fixes --- configure.ac | 1 + doc/Makefile.am | 2 + doc/doxygen/Makefile.am | 18 +++ doc/doxygen/taler-mint.doxy | 246 ++++++++++++++++++++++++++++++++++ src/include/taler_amount_lib.h | 2 +- src/include/taler_crypto_lib.h | 2 +- src/include/taler_json_lib.h | 8 +- src/include/taler_mint_service.h | 6 +- src/include/taler_mintdb_lib.h | 14 +- src/include/taler_mintdb_plugin.h | 16 +-- src/include/taler_pq_lib.h | 2 +- src/include/taler_util.h | 2 +- src/mint-lib/mint_api.c | 9 +- src/mint-tools/taler-mint-dbinit.c | 2 +- src/mint-tools/taler-mint-keyup.c | 10 +- src/mint/taler-mint-httpd.c | 3 +- src/mint/taler-mint-httpd.h | 4 +- src/mint/taler-mint-httpd_db.c | 28 ++-- src/mint/taler-mint-httpd_db.h | 12 +- src/mint/taler-mint-httpd_deposit.c | 12 +- src/mint/taler-mint-httpd_deposit.h | 4 +- src/mint/taler-mint-httpd_keystate.c | 20 +-- src/mint/taler-mint-httpd_keystate.h | 8 +- src/mint/taler-mint-httpd_mhd.c | 12 +- src/mint/taler-mint-httpd_mhd.h | 14 +- src/mint/taler-mint-httpd_parsing.c | 23 ++-- src/mint/taler-mint-httpd_parsing.h | 6 +- src/mint/taler-mint-httpd_refresh.c | 37 +++-- src/mint/taler-mint-httpd_refresh.h | 14 +- src/mint/taler-mint-httpd_responses.c | 2 +- src/mint/taler-mint-httpd_withdraw.c | 8 +- src/mint/taler-mint-httpd_withdraw.h | 8 +- src/mintdb/mintdb_keyio.c | 2 +- src/mintdb/plugin_mintdb_common.c | 4 +- src/mintdb/plugin_mintdb_postgres.c | 21 +-- src/util/amount.c | 2 +- src/util/crypto.c | 2 +- src/util/json.c | 9 +- src/util/os_installation.c | 2 +- src/util/util.c | 3 +- 40 files changed, 435 insertions(+), 165 deletions(-) create mode 100644 doc/doxygen/Makefile.am create mode 100644 doc/doxygen/taler-mint.doxy diff --git a/configure.ac b/configure.ac index abc23c1f2..9e1fd9905 100644 --- a/configure.ac +++ b/configure.ac @@ -170,6 +170,7 @@ AC_CHECK_FUNCS([strdup]) AC_CONFIG_FILES([Makefile doc/Makefile + doc/doxygen/Makefile src/Makefile src/include/Makefile src/util/Makefile diff --git a/doc/Makefile.am b/doc/Makefile.am index 19df36746..c93c251d0 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -1,4 +1,6 @@ # This Makefile.am is in the public domain +SUBDIRS = . doxygen + EXTRA_DIST = \ coding-style.txt diff --git a/doc/doxygen/Makefile.am b/doc/doxygen/Makefile.am new file mode 100644 index 000000000..6b6f1ed72 --- /dev/null +++ b/doc/doxygen/Makefile.am @@ -0,0 +1,18 @@ +# This Makefile.am is in the public domain +all: + @echo -e \ +"Generate documentation:\n" \ +"\tmake full - full documentation with dependency graphs (slow)\n" \ +"\tmake fast - fast mode without dependency graphs" + +full: taler-mint.doxy + doxygen $< + +fast: taler-mint.doxy + sed 's/\(HAVE_DOT.*=\).*/\1 NO/' $< | doxygen - + +clean: + rm -rf html + + +EXTRA_DIST = taler-mint.doxy diff --git a/doc/doxygen/taler-mint.doxy b/doc/doxygen/taler-mint.doxy new file mode 100644 index 000000000..d4bd0ef9f --- /dev/null +++ b/doc/doxygen/taler-mint.doxy @@ -0,0 +1,246 @@ +# Doxyfile 1.5.5 + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- +DOXYFILE_ENCODING = UTF-8 +PROJECT_NAME = "GNU Taler: Mint" +PROJECT_NUMBER = 0.0 +OUTPUT_DIRECTORY = . +CREATE_SUBDIRS = YES +OUTPUT_LANGUAGE = English +BRIEF_MEMBER_DESC = YES +REPEAT_BRIEF = YES +ABBREVIATE_BRIEF = "The $name class" \ + "The $name widget" \ + "The $name file" \ + is \ + provides \ + specifies \ + contains \ + represents \ + a \ + an \ + the +ALWAYS_DETAILED_SEC = NO +INLINE_INHERITED_MEMB = NO +FULL_PATH_NAMES = YES +STRIP_FROM_PATH = ../.. +STRIP_FROM_INC_PATH = ../../src/include \ + src/include +SHORT_NAMES = NO +JAVADOC_AUTOBRIEF = NO +QT_AUTOBRIEF = NO +MULTILINE_CPP_IS_BRIEF = NO +INHERIT_DOCS = NO +SEPARATE_MEMBER_PAGES = NO +TAB_SIZE = 8 +ALIASES = +OPTIMIZE_OUTPUT_FOR_C = YES +OPTIMIZE_OUTPUT_JAVA = NO +OPTIMIZE_FOR_FORTRAN = NO +OPTIMIZE_OUTPUT_VHDL = NO +BUILTIN_STL_SUPPORT = NO +CPP_CLI_SUPPORT = NO +SIP_SUPPORT = NO +DISTRIBUTE_GROUP_DOC = NO +SUBGROUPING = YES +TYPEDEF_HIDES_STRUCT = NO +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- +EXTRACT_ALL = YES +EXTRACT_PRIVATE = NO +EXTRACT_STATIC = YES +EXTRACT_LOCAL_CLASSES = NO +EXTRACT_LOCAL_METHODS = YES +EXTRACT_ANON_NSPACES = NO +HIDE_UNDOC_MEMBERS = NO +HIDE_UNDOC_CLASSES = NO +HIDE_FRIEND_COMPOUNDS = NO +HIDE_IN_BODY_DOCS = NO +INTERNAL_DOCS = NO +CASE_SENSE_NAMES = YES +HIDE_SCOPE_NAMES = NO +SHOW_INCLUDE_FILES = YES +INLINE_INFO = YES +SORT_MEMBER_DOCS = YES +SORT_BRIEF_DOCS = NO +SORT_GROUP_NAMES = NO +SORT_BY_SCOPE_NAME = NO +GENERATE_TODOLIST = NO +GENERATE_TESTLIST = NO +GENERATE_BUGLIST = NO +GENERATE_DEPRECATEDLIST= NO +ENABLED_SECTIONS = +MAX_INITIALIZER_LINES = 30 +SHOW_USED_FILES = YES +FILE_VERSION_FILTER = +#--------------------------------------------------------------------------- +# configuration options related to warning and progress messages +#--------------------------------------------------------------------------- +QUIET = NO +WARNINGS = YES +WARN_IF_UNDOCUMENTED = YES +WARN_IF_DOC_ERROR = YES +WARN_NO_PARAMDOC = NO +WARN_FORMAT = "$file:$line: $text" +WARN_LOGFILE = +#--------------------------------------------------------------------------- +# configuration options related to the input files +#--------------------------------------------------------------------------- +INPUT = ../.. +INPUT_ENCODING = UTF-8 +FILE_PATTERNS = *.c \ + *.h +RECURSIVE = YES +EXCLUDE = +EXCLUDE_SYMLINKS = NO +EXCLUDE_PATTERNS = */test_* */.svn/* */perf_* */tls_test_* */examples/* TALER_config.h +EXCLUDE_SYMBOLS = GNUNET_* JSON_* +EXAMPLE_PATH = +EXAMPLE_PATTERNS = * +EXAMPLE_RECURSIVE = NO +IMAGE_PATH = +INPUT_FILTER = +FILTER_PATTERNS = +FILTER_SOURCE_FILES = NO +#--------------------------------------------------------------------------- +# configuration options related to source browsing +#--------------------------------------------------------------------------- +SOURCE_BROWSER = YES +INLINE_SOURCES = NO +STRIP_CODE_COMMENTS = YES +REFERENCED_BY_RELATION = YES +REFERENCES_RELATION = YES +REFERENCES_LINK_SOURCE = YES +USE_HTAGS = NO +VERBATIM_HEADERS = NO +#--------------------------------------------------------------------------- +# configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- +ALPHABETICAL_INDEX = YES +COLS_IN_ALPHA_INDEX = 5 +IGNORE_PREFIX = +#--------------------------------------------------------------------------- +# configuration options related to the HTML output +#--------------------------------------------------------------------------- +GENERATE_HTML = YES +HTML_OUTPUT = html +HTML_FILE_EXTENSION = .html +HTML_HEADER = +HTML_FOOTER = +HTML_STYLESHEET = +GENERATE_HTMLHELP = NO +GENERATE_DOCSET = NO +DOCSET_FEEDNAME = "Doxygen generated docs" +DOCSET_BUNDLE_ID = org.doxygen.Project +HTML_DYNAMIC_SECTIONS = NO +CHM_FILE = +HHC_LOCATION = +GENERATE_CHI = NO +BINARY_TOC = NO +TOC_EXPAND = NO +DISABLE_INDEX = NO +ENUM_VALUES_PER_LINE = 4 +GENERATE_TREEVIEW = YES +TREEVIEW_WIDTH = 250 +#--------------------------------------------------------------------------- +# configuration options related to the LaTeX output +#--------------------------------------------------------------------------- +GENERATE_LATEX = NO +LATEX_OUTPUT = latex +LATEX_CMD_NAME = latex +MAKEINDEX_CMD_NAME = makeindex +COMPACT_LATEX = NO +PAPER_TYPE = a4wide +EXTRA_PACKAGES = +LATEX_HEADER = +PDF_HYPERLINKS = YES +USE_PDFLATEX = YES +LATEX_BATCHMODE = NO +LATEX_HIDE_INDICES = NO +#--------------------------------------------------------------------------- +# configuration options related to the RTF output +#--------------------------------------------------------------------------- +GENERATE_RTF = NO +RTF_OUTPUT = rtf +COMPACT_RTF = NO +RTF_HYPERLINKS = NO +RTF_STYLESHEET_FILE = +RTF_EXTENSIONS_FILE = +#--------------------------------------------------------------------------- +# configuration options related to the man page output +#--------------------------------------------------------------------------- +GENERATE_MAN = NO +MAN_OUTPUT = man +MAN_EXTENSION = .3 +MAN_LINKS = NO +#--------------------------------------------------------------------------- +# configuration options related to the XML output +#--------------------------------------------------------------------------- +GENERATE_XML = NO +XML_OUTPUT = xml +XML_PROGRAMLISTING = YES +#--------------------------------------------------------------------------- +# configuration options for the AutoGen Definitions output +#--------------------------------------------------------------------------- +GENERATE_AUTOGEN_DEF = NO +#--------------------------------------------------------------------------- +# configuration options related to the Perl module output +#--------------------------------------------------------------------------- +GENERATE_PERLMOD = NO +PERLMOD_LATEX = NO +PERLMOD_PRETTY = YES +PERLMOD_MAKEVAR_PREFIX = +#--------------------------------------------------------------------------- +# Configuration options related to the preprocessor +#--------------------------------------------------------------------------- +ENABLE_PREPROCESSING = YES +MACRO_EXPANSION = NO +EXPAND_ONLY_PREDEF = NO +SEARCH_INCLUDES = YES +INCLUDE_PATH = +INCLUDE_FILE_PATTERNS = +PREDEFINED = +EXPAND_AS_DEFINED = +SKIP_FUNCTION_MACROS = YES +#--------------------------------------------------------------------------- +# Configuration::additions related to external references +#--------------------------------------------------------------------------- +TAGFILES = +GENERATE_TAGFILE = +ALLEXTERNALS = NO +EXTERNAL_GROUPS = YES +PERL_PATH = /usr/bin/perl +#--------------------------------------------------------------------------- +# Configuration options related to the dot tool +#--------------------------------------------------------------------------- +CLASS_DIAGRAMS = YES +MSCGEN_PATH = +HIDE_UNDOC_RELATIONS = YES +HAVE_DOT = YES +CLASS_GRAPH = NO +COLLABORATION_GRAPH = NO +GROUP_GRAPHS = NO +UML_LOOK = NO +TEMPLATE_RELATIONS = NO +INCLUDE_GRAPH = YES +INCLUDED_BY_GRAPH = YES +CALL_GRAPH = YES +CALLER_GRAPH = YES +GRAPHICAL_HIERARCHY = NO +DIRECTORY_GRAPH = YES +DOT_IMAGE_FORMAT = png +DOT_PATH = +DOTFILE_DIRS = +DOT_GRAPH_MAX_NODES = 25 +MAX_DOT_GRAPH_DEPTH = 2 +DOT_TRANSPARENT = YES +DOT_MULTI_TARGETS = NO +GENERATE_LEGEND = YES +DOT_CLEANUP = YES +#--------------------------------------------------------------------------- +# Configuration::additions related to the search engine +#--------------------------------------------------------------------------- +SEARCHENGINE = YES diff --git a/src/include/taler_amount_lib.h b/src/include/taler_amount_lib.h index e64ff4d92..069da1d6c 100644 --- a/src/include/taler_amount_lib.h +++ b/src/include/taler_amount_lib.h @@ -138,7 +138,7 @@ TALER_amount_hton (struct TALER_AmountNBO *res, * Convert amount from network to host representation. * * @param res where to store amount in host representation - * @param d amount in network representation + * @param dn amount in network representation */ void TALER_amount_ntoh (struct TALER_Amount *res, diff --git a/src/include/taler_crypto_lib.h b/src/include/taler_crypto_lib.h index 5b45661b7..321c2b982 100644 --- a/src/include/taler_crypto_lib.h +++ b/src/include/taler_crypto_lib.h @@ -446,7 +446,7 @@ TALER_transfer_decrypt (const struct TALER_EncryptedLinkSecretP *secret_enc, * * @param secret shared secret for refresh link decryption * @param trans_sec transfer secret - * @param secret_enc[out] encrypted secret + * @param[out] secret_enc encrypted secret * @return #GNUNET_OK on success */ int diff --git a/src/include/taler_json_lib.h b/src/include/taler_json_lib.h index dbf2293d0..9410d5088 100644 --- a/src/include/taler_json_lib.h +++ b/src/include/taler_json_lib.h @@ -45,7 +45,7 @@ TALER_json_from_amount (const struct TALER_Amount *amount); /** * Convert absolute timestamp to a json string. * - * @param the time stamp + * @param stamp the time stamp * @return a json string with the timestamp in @a stamp */ json_t * @@ -123,7 +123,7 @@ TALER_json_from_hash (const struct GNUNET_HashCode *hc); * Parse given JSON object to Amount * * @param json the json object representing Amount - * @param r_amount where the amount has to be written + * @param[out] r_amount where the amount has to be written * @return #GNUNET_OK upon successful parsing; #GNUNET_SYSERR upon error */ int @@ -134,12 +134,12 @@ TALER_json_to_amount (json_t *json, * Parse given JSON object to absolute time. * * @param json the json object representing absolute time in seconds - * @param r_abs where the time has to be written + * @param[out] abs where the time has to be written * @return #GNUNET_OK upon successful parsing; #GNUNET_SYSERR upon error */ int TALER_json_to_abs (json_t *json, - struct GNUNET_TIME_Absolute *r_abs); + struct GNUNET_TIME_Absolute *abs); /** * Parse given JSON object to data diff --git a/src/include/taler_mint_service.h b/src/include/taler_mint_service.h index 774f40f54..cc1bbd4cc 100644 --- a/src/include/taler_mint_service.h +++ b/src/include/taler_mint_service.h @@ -243,7 +243,7 @@ typedef void * * @param mint the mint handle * @param cb the callback to call when a reply for this request is available - * @param cls closure for the above callback + * @param cb_cls closure for the above callback * @param deposit_obj the deposit permission received from the customer along * with the wireformat JSON object * @return a handle for this request; NULL if the JSON object could not be @@ -253,7 +253,7 @@ typedef void struct TALER_MINT_DepositHandle * TALER_MINT_deposit_submit_json (struct TALER_MINT_Handle *mint, TALER_MINT_DepositResultCallback cb, - void *cls, + void *cb_cls, json_t *deposit_obj); @@ -299,7 +299,7 @@ TALER_MINT_deposit_submit_json_ (struct TALER_MINT_Handle *mint, * Cancel a deposit permission request. This function cannot be used on a * request handle if a response is already served for it. * - * @param the deposit permission request handle + * @param deposit the deposit permission request handle */ void TALER_MINT_deposit_submit_cancel (struct TALER_MINT_DepositHandle *deposit); diff --git a/src/include/taler_mintdb_lib.h b/src/include/taler_mintdb_lib.h index a5d3d8d9e..76baa5202 100644 --- a/src/include/taler_mintdb_lib.h +++ b/src/include/taler_mintdb_lib.h @@ -137,8 +137,8 @@ typedef int */ int TALER_MINTDB_signing_keys_iterate (const char *mint_base_dir, - TALER_MINTDB_SigningKeyIterator it, - void *it_cls); + TALER_MINTDB_SigningKeyIterator it, + void *it_cls); /** @@ -156,8 +156,8 @@ TALER_MINTDB_signing_keys_iterate (const char *mint_base_dir, */ int TALER_MINTDB_denomination_keys_iterate (const char *mint_base_dir, - TALER_MINTDB_DenominationKeyIterator it, - void *it_cls); + TALER_MINTDB_DenominationKeyIterator it, + void *it_cls); /** @@ -169,19 +169,19 @@ TALER_MINTDB_denomination_keys_iterate (const char *mint_base_dir, */ int TALER_MINTDB_denomination_key_write (const char *filename, - const struct TALER_MINTDB_DenominationKeyIssueInformation *dki); + const struct TALER_MINTDB_DenominationKeyIssueInformation *dki); /** * Import a denomination key from the given file. * * @param filename the file to import the key from - * @param[OUT] dki set to the imported denomination key + * @param[out] dki set to the imported denomination key * @return #GNUNET_OK upon success; #GNUNET_SYSERR upon failure */ int TALER_MINTDB_denomination_key_read (const char *filename, - struct TALER_MINTDB_DenominationKeyIssueInformation *dki); + struct TALER_MINTDB_DenominationKeyIssueInformation *dki); /** diff --git a/src/include/taler_mintdb_plugin.h b/src/include/taler_mintdb_plugin.h index 956487b2f..868fb4388 100644 --- a/src/include/taler_mintdb_plugin.h +++ b/src/include/taler_mintdb_plugin.h @@ -14,7 +14,7 @@ TALER; see the file COPYING. If not, If not, see */ /** - * @file mint/taler_mintdb_plugin.h + * @file include/taler_mintdb_plugin.h * @brief Low-level (statement-level) database access for the mint * @author Florian Dold * @author Christian Grothoff @@ -707,7 +707,7 @@ struct TALER_MINTDB_Plugin * @param cls the @e cls of this struct with the plugin-specific state * @param sesssion database handle to use * @param session_hash hash over the melt to use for the lookup - * @param refresh_session[OUT] where to store the result + * @param[out] refresh_session where to store the result * @return #GNUNET_YES on success, * #GNUNET_NO if not found, * #GNUNET_SYSERR on DB failure @@ -801,7 +801,7 @@ struct TALER_MINTDB_Plugin * @param sesssion database connection * @param session_hash hash to identify refresh session * @param num_newcoins size of the @a denom_pubs array - * @param denom_pubs[OUT] where to write @a num_newcoins denomination keys + * @param[out] denom_pubs where to write @a num_newcoins denomination keys * @return #GNUNET_OK on success * #GNUNET_SYSERR on internal error */ @@ -844,7 +844,7 @@ struct TALER_MINTDB_Plugin * @param session_hash hash to identify refresh session * @param i set index (1st dimension) * @param num_coins size of the @a commit_coins array - * @param commit_coin[OUT] array of coin commitments to return + * @param[out] commit_coin array of coin commitments to return * @return #GNUNET_OK on success * #GNUNET_NO if not found * #GNUNET_SYSERR on error @@ -886,8 +886,8 @@ struct TALER_MINTDB_Plugin * @param sesssion database connection to use * @param session_hash hash to identify refresh session * @param i set index (1st dimension) - * @param num_links size of the @links array to return - * @param links[OUT] array link information to return + * @param num_links size of the @a links array to return + * @param[out] links array link information to return * @return #GNUNET_SYSERR on internal error, * #GNUNET_NO if commitment was not found * #GNUNET_OK on success @@ -958,8 +958,8 @@ struct TALER_MINTDB_Plugin * @param cls the @e cls of this struct with the plugin-specific state * @param sesssion database connection * @param coin_pub public key of the coin - * @param transfer_pub[OUT] public transfer key - * @param shared_secret_enc[OUT] set to shared secret + * @param[out] transfer_pub public transfer key + * @param[out] shared_secret_enc set to shared secret * @return #GNUNET_OK on success, * #GNUNET_NO on failure (not found) * #GNUNET_SYSERR on internal failure (database issue) diff --git a/src/include/taler_pq_lib.h b/src/include/taler_pq_lib.h index 3cfd27f91..73d2b13bb 100644 --- a/src/include/taler_pq_lib.h +++ b/src/include/taler_pq_lib.h @@ -14,7 +14,7 @@ TALER; see the file COPYING. If not, If not, see */ /** - * @file pq/taler_pq_lib.h + * @file include/taler_pq_lib.h * @brief helper functions for DB interactions * @author Sree Harsha Totakura * @author Florian Dold diff --git a/src/include/taler_util.h b/src/include/taler_util.h index b92f22170..7bba573d1 100644 --- a/src/include/taler_util.h +++ b/src/include/taler_util.h @@ -89,7 +89,7 @@ TALER_config_load (const char *base_dir); * * @param section section of the configuration to access * @param option option of the configuration to access - * @param denom[OUT] set to the amount found in configuration + * @param[out] denom set to the amount found in configuration * @return #GNUNET_OK on success, #GNUNET_SYSERR on error */ int diff --git a/src/mint-lib/mint_api.c b/src/mint-lib/mint_api.c index 24d617f56..b3ee34d15 100644 --- a/src/mint-lib/mint_api.c +++ b/src/mint-lib/mint_api.c @@ -16,7 +16,7 @@ */ /** - * @file mint/mint_api.c + * @file mint-lib/mint_api.c * @brief Implementation of the client interface to mint's HTTP API * @author Sree Harsha Totakura */ @@ -908,7 +908,7 @@ download (char *bufptr, size_t size, size_t nitems, void *cls) * @param ctx the context * @param hostname the hostname of the mint * @param port the point where the mint's HTTP service is running. - * @param mint_key the offline master public key of the mint. + * @param master_key the offline master public key of the mint. * This is used to verify the responses of the mint. * @return the mint handle; NULL upon error */ @@ -916,7 +916,7 @@ struct TALER_MINT_Handle * TALER_MINT_connect (struct TALER_MINT_Context *ctx, const char *hostname, uint16_t port, - const struct TALER_MasterPublicKeyP *mint_key) + const struct TALER_MasterPublicKeyP *master_key) { struct TALER_MINT_Handle *mint; @@ -937,6 +937,7 @@ TALER_MINT_connect (struct TALER_MINT_Context *ctx, return mint; } + /** * Disconnect from the mint * @@ -1064,7 +1065,7 @@ TALER_MINT_deposit_submit_json (struct TALER_MINT_Handle *mint, * Cancel a deposit permission request. This function cannot be used on a * request handle if a response is already served for it. * - * @param the deposit permission request handle + * @param deposit the deposit permission request handle */ void TALER_MINT_deposit_submit_cancel (struct TALER_MINT_DepositHandle *deposit) diff --git a/src/mint-tools/taler-mint-dbinit.c b/src/mint-tools/taler-mint-dbinit.c index 612cb4c3f..f49916a6d 100644 --- a/src/mint-tools/taler-mint-dbinit.c +++ b/src/mint-tools/taler-mint-dbinit.c @@ -14,7 +14,7 @@ TALER; see the file COPYING. If not, If not, see */ /** - * @file mint/taler-mint-dbinit.c + * @file mint-tools/taler-mint-dbinit.c * @brief Create tables for the mint database. * @author Florian Dold */ diff --git a/src/mint-tools/taler-mint-keyup.c b/src/mint-tools/taler-mint-keyup.c index c459dc549..cbeae646b 100644 --- a/src/mint-tools/taler-mint-keyup.c +++ b/src/mint-tools/taler-mint-keyup.c @@ -40,7 +40,7 @@ * Macro to round microseconds to seconds in GNUNET_TIME_* structs. * * @param name value to round - * @param field rel_value_us or abs_value_us + * @param us_field rel_value_us or abs_value_us */ #define ROUND_TO_SECS(name,us_field) name.us_field -= name.us_field % (1000 * 1000); @@ -220,7 +220,7 @@ get_signkey_file (struct GNUNET_TIME_Absolute start) * anchor, overlap). * * @param p coin parameters to convert to a hash - * @param hash[OUT] set to the hash matching @a p + * @param[out] hash set to the hash matching @a p */ static void hash_coin_type (const struct CoinTypeParams *p, @@ -429,7 +429,7 @@ get_anchor (const char *dir, * * @param start start time of the validity period for the key * @param duration how long should the key be valid - * @param pi[OUT] set to the signing key information + * @param[out] pi set to the signing key information */ static void create_signkey_issue_priv (struct GNUNET_TIME_Absolute start, @@ -542,7 +542,7 @@ mint_keys_update_signkeys () * our anchor by looking at the existing coins of the same type. * * @param ct section in the configuration file giving the coin type parameters - * @param params[OUT] set to the coin parameters from the configuration + * @param[out] params set to the coin parameters from the configuration * @return #GNUNET_OK on success, #GNUNET_SYSERR if the configuration is invalid */ static int @@ -672,7 +672,7 @@ get_cointype_params (const char *ct, * signing key. * * @param params parameters used to initialize the @a dki - * @param dki[OUT] initialized according to @a params + * @param[out] dki initialized according to @a params */ static void create_denomkey_issue (const struct CoinTypeParams *params, diff --git a/src/mint/taler-mint-httpd.c b/src/mint/taler-mint-httpd.c index 5e7557b99..e9bfac730 100644 --- a/src/mint/taler-mint-httpd.c +++ b/src/mint/taler-mint-httpd.c @@ -113,6 +113,7 @@ handle_mhd_completion_callback (void *cls, * @param connection the connection * @param url the requested url * @param method the method (POST, GET, ...) + * @param version HTTP version (ignored) * @param upload_data request data * @param upload_data_size size of @a upload_data in bytes * @param con_cls closure for request (a `struct Buffer *`) @@ -224,7 +225,7 @@ handle_mhd_request (void *cls, * Load configuration parameters for the mint * server into the corresponding global variables. * - * @param param mint_directory the mint's directory + * @param mint_directory the mint's directory * @return #GNUNET_OK on success */ static int diff --git a/src/mint/taler-mint-httpd.h b/src/mint/taler-mint-httpd.h index 11f2f3658..8c4261dcb 100644 --- a/src/mint/taler-mint-httpd.h +++ b/src/mint/taler-mint-httpd.h @@ -102,9 +102,9 @@ struct TMH_RequestHandler * @param rh this struct * @param mime_type the @e mime_type for the reply (hint, can be NULL) * @param connection the MHD connection to handle - * @param[IN|OUT] connection_cls the connection's closure (can be updated) + * @param[in,out] connection_cls the connection's closure (can be updated) * @param upload_data upload data - * @param[IN|OUT] upload_data_size number of bytes (left) in @a upload_data + * @param[in,out] upload_data_size number of bytes (left) in @a upload_data * @return MHD result code */ int (*handler)(struct TMH_RequestHandler *rh, diff --git a/src/mint/taler-mint-httpd_db.c b/src/mint/taler-mint-httpd_db.c index 6a06d1fe7..651cedfd1 100644 --- a/src/mint/taler-mint-httpd_db.c +++ b/src/mint/taler-mint-httpd_db.c @@ -34,7 +34,7 @@ * Stores @a off plus the cost of all transactions in @a tl * in @a ret. * - * @param pos transaction list to process + * @param tl transaction list to process * @param off offset to use as the starting value * @param ret where the resulting total is to be stored * @return #GNUNET_OK on success, #GNUNET_SYSERR on errors @@ -591,9 +591,9 @@ refresh_accept_melts (struct MHD_Connection *connection, * * @param connection the MHD connection to handle * @param session_hash hash code of the session the coins are melted into - * @param num_new_denoms number of entries in @a denom_pubs, size of y-dimension of @commit_coin array - * @param denum_pubs public keys of the coins we want to withdraw in the end - * @param coin_count number of entries in @a coin_public_infos and @a coin_melt_details, size of y-dimension of @commit_link array + * @param num_new_denoms number of entries in @a denom_pubs, size of y-dimension of @a commit_coin array + * @param denom_pubs public keys of the coins we want to withdraw in the end + * @param coin_count number of entries in @a coin_public_infos and @a coin_melt_details, size of y-dimension of @a commit_link array * @param coin_public_infos information about the coins to melt * @param coin_melt_details signatures and (residual) value of the respective coin should be melted * @param commit_coin 2d array of coin commitments (what the mint is to sign @@ -607,14 +607,14 @@ refresh_accept_melts (struct MHD_Connection *connection, */ int TMH_DB_execute_refresh_melt (struct MHD_Connection *connection, - const struct GNUNET_HashCode *session_hash, - unsigned int num_new_denoms, - const struct TALER_DenominationPublicKey *denom_pubs, - unsigned int coin_count, - const struct TALER_CoinPublicInfo *coin_public_infos, - const struct TMH_DB_MeltDetails *coin_melt_details, - struct TALER_MINTDB_RefreshCommitCoin *const* commit_coin, - struct TALER_MINTDB_RefreshCommitLinkP *const* commit_link) + const struct GNUNET_HashCode *session_hash, + unsigned int num_new_denoms, + const struct TALER_DenominationPublicKey *denom_pubs, + unsigned int coin_count, + const struct TALER_CoinPublicInfo *coin_public_infos, + const struct TMH_DB_MeltDetails *coin_melt_details, + struct TALER_MINTDB_RefreshCommitCoin *const* commit_coin, + struct TALER_MINTDB_RefreshCommitLinkP *const* commit_link) { struct TMH_KS_StateHandle *key_state; struct TALER_MINTDB_RefreshSession refresh_session; @@ -1036,8 +1036,8 @@ refresh_mint_coin (struct MHD_Connection *connection, * * @param connection the MHD connection to handle * @param session_hash hash identifying the refresh session - * @param num_oldcoins size of y-dimension of @transfer_privs array - * @param transfer_pubs array with the revealed transfer keys, + * @param num_oldcoins size of y-dimension of @a transfer_privs array + * @param transfer_privs array with the revealed transfer keys, * x-dimension must be #TALER_CNC_KAPPA - 1 * @return MHD result code */ diff --git a/src/mint/taler-mint-httpd_db.h b/src/mint/taler-mint-httpd_db.h index f92a999f0..eb2a9ea2e 100644 --- a/src/mint/taler-mint-httpd_db.h +++ b/src/mint/taler-mint-httpd_db.h @@ -14,7 +14,7 @@ TALER; see the file COPYING. If not, If not, see */ /** - * @file mint/taler-mint_httpd_db.h + * @file mint/taler-mint-httpd_db.h * @brief High-level (transactional-layer) database operations for the mint * @author Chrisitan Grothoff */ @@ -107,9 +107,9 @@ struct TMH_DB_MeltDetails * * @param connection the MHD connection to handle * @param session_hash hash code of the session the coins are melted into - * @param num_new_denoms number of entries in @a denom_pubs, size of y-dimension of @commit_coin array - * @param denum_pubs array of public denomination keys for the refresh (?) - * @param coin_count number of entries in @a coin_public_infos and @ a coin_melt_details, size of y-dimension of @commit_link array + * @param num_new_denoms number of entries in @a denom_pubs, size of y-dimension of @a commit_coin array + * @param denom_pubs array of public denomination keys for the refresh (?) + * @param coin_count number of entries in @a coin_public_infos and @ a coin_melt_details, size of y-dimension of @a commit_link array * @param coin_public_infos information about the coins to melt * @param coin_melt_details signatures and (residual) value of the respective coin should be melted * @param commit_coin 2d array of coin commitments (what the mint is to sign @@ -140,8 +140,8 @@ TMH_DB_execute_refresh_melt (struct MHD_Connection *connection, * * @param connection the MHD connection to handle * @param session_hash hash over the refresh session - * @param num_oldcoins size of y-dimension of @transfer_privs array - * @param transfer_pubs array with the revealed transfer keys, #TALER_CNC_KAPPA is 1st-dimension + * @param num_oldcoins size of y-dimension of @a transfer_privs array + * @param transfer_privs array with the revealed transfer keys, #TALER_CNC_KAPPA is 1st-dimension * @return MHD result code */ int diff --git a/src/mint/taler-mint-httpd_deposit.c b/src/mint/taler-mint-httpd_deposit.c index cdf6d6a98..18f83240a 100644 --- a/src/mint/taler-mint-httpd_deposit.c +++ b/src/mint/taler-mint-httpd_deposit.c @@ -197,17 +197,17 @@ parse_and_handle_deposit_request (struct MHD_Connection *connection, * * @param rh context of the handler * @param connection the MHD connection to handle - * @param[IN|OUT] connection_cls the connection's closure (can be updated) + * @param[in,out] connection_cls the connection's closure (can be updated) * @param upload_data upload data - * @param[IN|OUT] upload_data_size number of bytes (left) in @a upload_data + * @param[in,out] upload_data_size number of bytes (left) in @a upload_data * @return MHD result code */ int TMH_DEPOSIT_handler_deposit (struct TMH_RequestHandler *rh, - struct MHD_Connection *connection, - void **connection_cls, - const char *upload_data, - size_t *upload_data_size) + struct MHD_Connection *connection, + void **connection_cls, + const char *upload_data, + size_t *upload_data_size) { json_t *json; json_t *wire; diff --git a/src/mint/taler-mint-httpd_deposit.h b/src/mint/taler-mint-httpd_deposit.h index bf1a32321..c2d3fe13c 100644 --- a/src/mint/taler-mint-httpd_deposit.h +++ b/src/mint/taler-mint-httpd_deposit.h @@ -39,9 +39,9 @@ * * @param rh context of the handler * @param connection the MHD connection to handle - * @param[IN|OUT] connection_cls the connection's closure (can be updated) + * @param[in,out] connection_cls the connection's closure (can be updated) * @param upload_data upload data - * @param[IN|OUT] upload_data_size number of bytes (left) in @a upload_data + * @param[in,out] upload_data_size number of bytes (left) in @a upload_data * @return MHD result code */ int diff --git a/src/mint/taler-mint-httpd_keystate.c b/src/mint/taler-mint-httpd_keystate.c index 16b23aae3..1745775bb 100644 --- a/src/mint/taler-mint-httpd_keystate.c +++ b/src/mint/taler-mint-httpd_keystate.c @@ -322,7 +322,7 @@ reload_keys_sign_iter (void *cls, * * @param cls closure with the `struct TMH_KS_StateHandle` * @param key key for the denomination key - * @param alias coin alias + * @param value coin details * @return #GNUNET_OK to continue to iterate, * #GNUNET_NO to stop iteration with no error, * #GNUNET_SYSERR to abort iteration with error! @@ -447,14 +447,14 @@ TMH_KS_acquire (void) /** * Look up the issue for a denom public key. * - * @param key state to look in + * @param key_state state to look in * @param denom_pub denomination public key * @return the denomination key issue, * or NULL if denom_pub could not be found */ struct TALER_MINTDB_DenominationKeyIssueInformation * TMH_KS_denomination_key_lookup (const struct TMH_KS_StateHandle *key_state, - const struct TALER_DenominationPublicKey *denom_pub) + const struct TALER_DenominationPublicKey *denom_pub) { struct GNUNET_HashCode hc; @@ -579,7 +579,7 @@ read_again: * Sign the message in @a purpose with the mint's signing key. * * @param purpose the message to sign - * @param[OUT] sig signature over purpose using current signing key + * @param[out] sig signature over purpose using current signing key */ void TMH_KS_sign (const struct GNUNET_CRYPTO_EccSignaturePurpose *purpose, @@ -603,17 +603,17 @@ TMH_KS_sign (const struct GNUNET_CRYPTO_EccSignaturePurpose *purpose, * * @param rh context of the handler * @param connection the MHD connection to handle - * @param[IN|OUT] connection_cls the connection's closure (can be updated) + * @param[in,out] connection_cls the connection's closure (can be updated) * @param upload_data upload data - * @param[IN|OUT] upload_data_size number of bytes (left) in @a upload_data + * @param[in,out] upload_data_size number of bytes (left) in @a upload_data * @return MHD result code */ int TMH_KS_handler_keys (struct TMH_RequestHandler *rh, - struct MHD_Connection *connection, - void **connection_cls, - const char *upload_data, - size_t *upload_data_size) + struct MHD_Connection *connection, + void **connection_cls, + const char *upload_data, + size_t *upload_data_size) { struct TMH_KS_StateHandle *key_state; struct MHD_Response *response; diff --git a/src/mint/taler-mint-httpd_keystate.h b/src/mint/taler-mint-httpd_keystate.h index ec0d24aa3..118a86e78 100644 --- a/src/mint/taler-mint-httpd_keystate.h +++ b/src/mint/taler-mint-httpd_keystate.h @@ -60,7 +60,7 @@ TMH_KS_release (struct TMH_KS_StateHandle *key_state); * Look up the issue for a denom public key. Note that the result * is only valid while the @a key_state is not released! * - * @param key state to look in + * @param key_state state to look in * @param denom_pub denomination public key * @return the denomination key issue, * or NULL if denom_pub could not be found @@ -86,7 +86,7 @@ TMH_KS_loop (void); * key. * * @param purpose the message to sign - * @param[OUT] sig signature over purpose using current signing key + * @param[out] sig signature over purpose using current signing key */ void TMH_KS_sign (const struct GNUNET_CRYPTO_EccSignaturePurpose *purpose, @@ -98,9 +98,9 @@ TMH_KS_sign (const struct GNUNET_CRYPTO_EccSignaturePurpose *purpose, * * @param rh context of the handler * @param connection the MHD connection to handle - * @param[IN|OUT] connection_cls the connection's closure (can be updated) + * @param[in,out] connection_cls the connection's closure (can be updated) * @param upload_data upload data - * @param[IN|OUT] upload_data_size number of bytes (left) in @a upload_data + * @param[in,out] upload_data_size number of bytes (left) in @a upload_data * @return MHD result code */ int diff --git a/src/mint/taler-mint-httpd_mhd.c b/src/mint/taler-mint-httpd_mhd.c index a12158731..b4e3c1f60 100644 --- a/src/mint/taler-mint-httpd_mhd.c +++ b/src/mint/taler-mint-httpd_mhd.c @@ -40,9 +40,9 @@ * * @param rh context of the handler * @param connection the MHD connection to handle - * @param[IN|OUT] connection_cls the connection's closure (can be updated) + * @param[in,out] connection_cls the connection's closure (can be updated) * @param upload_data upload data - * @param[IN|OUT] upload_data_size number of bytes (left) in @a upload_data + * @param[in,out] upload_data_size number of bytes (left) in @a upload_data * @return MHD result code */ int @@ -83,9 +83,9 @@ TMH_MHD_handler_static_response (struct TMH_RequestHandler *rh, * * @param rh context of the handler * @param connection the MHD connection to handle - * @param[IN|OUT] connection_cls the connection's closure (can be updated) + * @param[in,out] connection_cls the connection's closure (can be updated) * @param upload_data upload data - * @param[IN|OUT] upload_data_size number of bytes (left) in @a upload_data + * @param[in,out] upload_data_size number of bytes (left) in @a upload_data * @return MHD result code */ int @@ -129,9 +129,9 @@ TMH_MHD_handler_agpl_redirect (struct TMH_RequestHandler *rh, * * @param rh context of the handler * @param connection the MHD connection to handle - * @param[IN|OUT] connection_cls the connection's closure (can be updated) + * @param[in,out] connection_cls the connection's closure (can be updated) * @param upload_data upload data - * @param[IN|OUT] upload_data_size number of bytes (left) in @a upload_data + * @param[in,out] upload_data_size number of bytes (left) in @a upload_data * @return MHD result code */ int diff --git a/src/mint/taler-mint-httpd_mhd.h b/src/mint/taler-mint-httpd_mhd.h index 4ab8e803c..a9f575df0 100644 --- a/src/mint/taler-mint-httpd_mhd.h +++ b/src/mint/taler-mint-httpd_mhd.h @@ -34,9 +34,9 @@ * * @param rh context of the handler * @param connection the MHD connection to handle - * @param[IN|OUT] connection_cls the connection's closure (can be updated) + * @param[in,out] connection_cls the connection's closure (can be updated) * @param upload_data upload data - * @param[IN|OUT] upload_data_size number of bytes (left) in @a upload_data + * @param[in,out] upload_data_size number of bytes (left) in @a upload_data * @return MHD result code */ int @@ -53,9 +53,9 @@ TMH_MHD_handler_static_response (struct TMH_RequestHandler *rh, * * @param rh context of the handler * @param connection the MHD connection to handle - * @param[IN|OUT] connection_cls the connection's closure (can be updated) + * @param[in,out] connection_cls the connection's closure (can be updated) * @param upload_data upload data - * @param[IN|OUT] upload_data_size number of bytes (left) in @a upload_data + * @param[in,out] upload_data_size number of bytes (left) in @a upload_data * @return MHD result code */ int @@ -72,7 +72,7 @@ TMH_MHD_handler_agpl_redirect (struct TMH_RequestHandler *rh, * * @param rh context of the handler * @param connection the MHD connection to handle - * @param[IN|OUT] connection_cls the connection's closure (can be updated) + * @param[in,out] connection_cls the connection's closure (can be updated) * @param response_code HTTP response code to use * @param do_cache can the response be cached? (0: no, 1: yes) * @param fmt format string for pack @@ -95,9 +95,9 @@ TMH_MHD_helper_send_json_pack (struct TMH_RequestHandler *rh, * * @param rh context of the handler * @param connection the MHD connection to handle - * @param[IN|OUT] connection_cls the connection's closure (can be updated) + * @param[in,out] connection_cls the connection's closure (can be updated) * @param upload_data upload data - * @param[IN|OUT] upload_data_size number of bytes (left) in @a upload_data + * @param[in,out] upload_data_size number of bytes (left) in @a upload_data * @return MHD result code */ int diff --git a/src/mint/taler-mint-httpd_parsing.c b/src/mint/taler-mint-httpd_parsing.c index 99b060fec..5182e15fe 100644 --- a/src/mint/taler-mint-httpd_parsing.c +++ b/src/mint/taler-mint-httpd_parsing.c @@ -108,7 +108,7 @@ buffer_deinit (struct Buffer *buf) * * @param buf the buffer to append to * @param data the data to append - * @param size the size of @a data + * @param data_size the size of @a data * @param max_size maximum size that the buffer can grow to * @return #GNUNET_OK on success, * #GNUNET_NO if the buffer can't accomodate for the new data @@ -141,15 +141,14 @@ buffer_append (struct Buffer *buf, /** - * Process a POST request containing a JSON object. This - * function realizes an MHD POST processor that will - * (incrementally) process JSON data uploaded to the HTTP - * server. It will store the required state in the - * "connection_cls", which must be cleaned up using + * Process a POST request containing a JSON object. This function + * realizes an MHD POST processor that will (incrementally) process + * JSON data uploaded to the HTTP server. It will store the required + * state in the @a con_cls, which must be cleaned up using * #TMH_PARSE_post_cleanup_callback(). * * @param connection the MHD connection - * @param con_cs the closure (points to a `struct Buffer *`) + * @param con_cls the closure (points to a `struct Buffer *`) * @param upload_data the POST data * @param upload_data_size number of bytes in @a upload_data * @param json the JSON object for a completed request @@ -166,10 +165,10 @@ buffer_append (struct Buffer *buf, */ int TMH_PARSE_post_json (struct MHD_Connection *connection, - void **con_cls, - const char *upload_data, - size_t *upload_data_size, - json_t **json) + void **con_cls, + const char *upload_data, + size_t *upload_data_size, + json_t **json) { struct Buffer *r = *con_cls; @@ -881,7 +880,7 @@ TMH_PARSE_release_data (struct TMH_PARSE_FieldSpecification *spec) * * @param connection the MHD connection (to report errors) * @param f json specification of the amount - * @param amount[OUT] set to the amount specified in @a f + * @param[out] amount set to the amount specified in @a f * @return * #GNUNET_YES if parsing was successful * #GNUNET_NO if json is malformed, error response was generated diff --git a/src/mint/taler-mint-httpd_parsing.h b/src/mint/taler-mint-httpd_parsing.h index 99376cac4..5a0a7e601 100644 --- a/src/mint/taler-mint-httpd_parsing.h +++ b/src/mint/taler-mint-httpd_parsing.h @@ -37,7 +37,7 @@ * #TMH_PARSE_post_cleanup_callback(). * * @param connection the MHD connection - * @param con_cs the closure (points to a `struct Buffer *`) + * @param con_cls the closure (points to a `struct Buffer *`) * @param upload_data the POST data * @param upload_data_size number of bytes in @a upload_data * @param json the JSON object for a completed request @@ -264,7 +264,7 @@ TMH_PARSE_release_data (struct TMH_PARSE_FieldSpecification *spec); * Generate line in parser specification for RSA public key. * * @param field name of the field - * @param ptraddr address of `struct GNUNET_CRYPTO_rsa_PublicKey *` initialize + * @param ptrpk address of `struct GNUNET_CRYPTO_rsa_PublicKey *` initialize */ #define TMH_PARSE_MEMBER_RSA_PUBLIC_KEY(field,ptrpk) { field, ptrpk, 0, 0, TMH_PARSE_JNC_RET_RSA_PUBLIC_KEY, 0 } @@ -295,7 +295,7 @@ TMH_PARSE_release_data (struct TMH_PARSE_FieldSpecification *spec); * * @param connection the MHD connection (to report errors) * @param f json specification of the amount - * @param amount[OUT] set to the amount specified in @a f + * @param[out] amount set to the amount specified in @a f * @return * #GNUNET_YES if parsing was successful * #GNUNET_NO if json is malformed, error response was generated diff --git a/src/mint/taler-mint-httpd_refresh.c b/src/mint/taler-mint-httpd_refresh.c index dd625a6af..6994ec6b0 100644 --- a/src/mint/taler-mint-httpd_refresh.c +++ b/src/mint/taler-mint-httpd_refresh.c @@ -40,13 +40,12 @@ * and then hand things of to execute the melt operation. * * @param connection the MHD connection to handle - * @param num_new_denoms number of coins to be created, size of y-dimension of @commit_link array + * @param num_new_denoms number of coins to be created, size of y-dimension of @a commit_link array * @param denom_pubs array of @a num_new_denoms keys - * @param coin_count number of coins to be melted, size of y-dimension of @commit_coin array + * @param coin_count number of coins to be melted, size of y-dimension of @a commit_coin array * @param coin_public_infos array with @a coin_count entries about the coins * @param coin_melt_details array with @a coin_count entries with melting details * @param session_hash hash over the data that the client commits to - * @param commit_client_sig signature of the client over this commitment * @param commit_coin 2d array of coin commitments (what the mint is to sign * once the "/refres/reveal" of cut and choose is done) * @param commit_link 2d array of coin link commitments (what the mint is @@ -163,8 +162,8 @@ handle_refresh_melt_binary (struct MHD_Connection *connection, * * @param connection the connection to send error responses to * @param coin_info the JSON object to extract the coin info from - * @param r_public_info[OUT] set to the coin's public information - * @param r_melt_detail[OUT] set to details about the coin's melting permission (if valid) + * @param[out] r_public_info set to the coin's public information + * @param[out] r_melt_detail set to details about the coin's melting permission (if valid) * @return #GNUNET_YES if coin public info in JSON was valid * #GNUNET_NO JSON was invalid, response was generated * #GNUNET_SYSERR on internal error @@ -324,7 +323,7 @@ free_commit_coins (struct TALER_MINTDB_RefreshCommitCoin **commit_coin, /** * Release memory from the @a commit_link array. * - * @param commit_coin array to release + * @param commit_link array to release * @param kappa size of 1st dimension * @param num_old_coins size of 2nd dimension */ @@ -360,7 +359,7 @@ free_commit_links (struct TALER_MINTDB_RefreshCommitLinkP **commit_link, * @param transfer_pubs #TALER_CNC_KAPPA-dimensional array of @a num_oldcoins transfer keys * @param secret_encs #TALER_CNC_KAPPA-dimensional array of @a num_oldcoins secrets * @param num_newcoins number of coins that the refresh will generate - * @param coin_envs #TALER_CNC_KAPPA-dimensional array of @a num_newcoins envelopes to sign + * @param coin_evs #TALER_CNC_KAPPA-dimensional array of @a num_newcoins envelopes to sign * @param link_encs #TALER_CNC_KAPPA-dimensional array of @a num_newcoins encrypted links * @return MHD result code */ @@ -500,12 +499,12 @@ handle_refresh_melt_json (struct MHD_Connection *connection, struct TALER_MINTDB_RefreshCommitCoin *rcc = &commit_coin[i][j]; res = TMH_PARSE_navigate_json (connection, - coin_evs, - TMH_PARSE_JNC_INDEX, (int) i, - TMH_PARSE_JNC_INDEX, (int) j, - TMH_PARSE_JNC_RET_DATA_VAR, - &rcc->coin_ev, - &rcc->coin_ev_size); + coin_evs, + TMH_PARSE_JNC_INDEX, (int) i, + TMH_PARSE_JNC_INDEX, (int) j, + TMH_PARSE_JNC_RET_DATA_VAR, + &rcc->coin_ev, + &rcc->coin_ev_size); if (GNUNET_OK != res) { @@ -653,9 +652,9 @@ handle_refresh_melt_json (struct MHD_Connection *connection, * * @param rh context of the handler * @param connection the MHD connection to handle - * @param[IN|OUT] connection_cls the connection's closure (can be updated) + * @param[in,out] connection_cls the connection's closure (can be updated) * @param upload_data upload data - * @param[IN|OUT] upload_data_size number of bytes (left) in @a upload_data + * @param[in,out] upload_data_size number of bytes (left) in @a upload_data * @return MHD result code */ int @@ -830,9 +829,9 @@ handle_refresh_reveal_json (struct MHD_Connection *connection, * * @param rh context of the handler * @param connection the MHD connection to handle - * @param[IN|OUT] connection_cls the connection's closure (can be updated) + * @param[in,out] connection_cls the connection's closure (can be updated) * @param upload_data upload data - * @param[IN|OUT] upload_data_size number of bytes (left) in @a upload_data + * @param[in,out] upload_data_size number of bytes (left) in @a upload_data * @return MHD result code */ int @@ -905,9 +904,9 @@ TMH_REFRESH_handler_refresh_reveal (struct TMH_RequestHandler *rh, * * @param rh context of the handler * @param connection the MHD connection to handle - * @param[IN|OUT] connection_cls the connection's closure (can be updated) + * @param[in,out] connection_cls the connection's closure (can be updated) * @param upload_data upload data - * @param[IN|OUT] upload_data_size number of bytes (left) in @a upload_data + * @param[in,out] upload_data_size number of bytes (left) in @a upload_data * @return MHD result code */ int diff --git a/src/mint/taler-mint-httpd_refresh.h b/src/mint/taler-mint-httpd_refresh.h index 934874f10..2842032b8 100644 --- a/src/mint/taler-mint-httpd_refresh.h +++ b/src/mint/taler-mint-httpd_refresh.h @@ -36,11 +36,11 @@ * * @param rh context of the handler * @param connection the MHD connection to handle - * @param[IN|OUT] connection_cls the connection's closure (can be updated) + * @param[in,out] connection_cls the connection's closure (can be updated) * @param upload_data upload data - * @param[IN|OUT] upload_data_size number of bytes (left) in @a upload_data + * @param[in,out] upload_data_size number of bytes (left) in @a upload_data * @return MHD result code - */ + */ int TMH_REFRESH_handler_refresh_melt (struct TMH_RequestHandler *rh, struct MHD_Connection *connection, @@ -60,9 +60,9 @@ TMH_REFRESH_handler_refresh_melt (struct TMH_RequestHandler *rh, * * @param rh context of the handler * @param connection the MHD connection to handle - * @param[IN|OUT] connection_cls the connection's closure (can be updated) + * @param[in,out] connection_cls the connection's closure (can be updated) * @param upload_data upload data - * @param[IN|OUT] upload_data_size number of bytes (left) in @a upload_data + * @param[in,out] upload_data_size number of bytes (left) in @a upload_data * @return MHD result code */ int @@ -78,9 +78,9 @@ TMH_REFRESH_handler_refresh_reveal (struct TMH_RequestHandler *rh, * * @param rh context of the handler * @param connection the MHD connection to handle - * @param[IN|OUT] connection_cls the connection's closure (can be updated) + * @param[in,out] connection_cls the connection's closure (can be updated) * @param upload_data upload data - * @param[IN|OUT] upload_data_size number of bytes (left) in @a upload_data + * @param[in,out] upload_data_size number of bytes (left) in @a upload_data * @return MHD result code */ int diff --git a/src/mint/taler-mint-httpd_responses.c b/src/mint/taler-mint-httpd_responses.c index 700090dba..3ba9fdb67 100644 --- a/src/mint/taler-mint-httpd_responses.c +++ b/src/mint/taler-mint-httpd_responses.c @@ -423,7 +423,7 @@ TMH_RESPONSE_reply_deposit_insufficient_funds (struct MHD_Connection *connection * and calculate the total balance. * * @param rh reserve history to JSON-ify - * @param balance[OUT] set to current reserve balance + * @param[out] balance set to current reserve balance * @return json representation of the @a rh, NULL on error */ static json_t * diff --git a/src/mint/taler-mint-httpd_withdraw.c b/src/mint/taler-mint-httpd_withdraw.c index e7a122213..786ef8203 100644 --- a/src/mint/taler-mint-httpd_withdraw.c +++ b/src/mint/taler-mint-httpd_withdraw.c @@ -37,9 +37,9 @@ * * @param rh context of the handler * @param connection the MHD connection to handle - * @param[IN|OUT] connection_cls the connection's closure (can be updated) + * @param[in,out] connection_cls the connection's closure (can be updated) * @param upload_data upload data - * @param[IN|OUT] upload_data_size number of bytes (left) in @a upload_data + * @param[in,out] upload_data_size number of bytes (left) in @a upload_data * @return MHD result code */ int @@ -76,9 +76,9 @@ TMH_WITHDRAW_handler_withdraw_status (struct TMH_RequestHandler *rh, * * @param rh context of the handler * @param connection the MHD connection to handle - * @param[IN|OUT] connection_cls the connection's closure (can be updated) + * @param[in,out] connection_cls the connection's closure (can be updated) * @param upload_data upload data - * @param[IN|OUT] upload_data_size number of bytes (left) in @a upload_data + * @param[in,out] upload_data_size number of bytes (left) in @a upload_data * @return MHD result code */ int diff --git a/src/mint/taler-mint-httpd_withdraw.h b/src/mint/taler-mint-httpd_withdraw.h index abf97a1d4..668178b16 100644 --- a/src/mint/taler-mint-httpd_withdraw.h +++ b/src/mint/taler-mint-httpd_withdraw.h @@ -34,9 +34,9 @@ * * @param rh context of the handler * @param connection the MHD connection to handle - * @param[IN|OUT] connection_cls the connection's closure (can be updated) + * @param[in,out] connection_cls the connection's closure (can be updated) * @param upload_data upload data - * @param[IN|OUT] upload_data_size number of bytes (left) in @a upload_data + * @param[in,out] upload_data_size number of bytes (left) in @a upload_data * @return MHD result code */ int @@ -58,9 +58,9 @@ TMH_WITHDRAW_handler_withdraw_status (struct TMH_RequestHandler *rh, * * @param rh context of the handler * @param connection the MHD connection to handle - * @param[IN|OUT] connection_cls the connection's closure (can be updated) + * @param[in,out] connection_cls the connection's closure (can be updated) * @param upload_data upload data - * @param[IN|OUT] upload_data_size number of bytes (left) in @a upload_data + * @param[in,out] upload_data_size number of bytes (left) in @a upload_data * @return MHD result code */ int diff --git a/src/mintdb/mintdb_keyio.c b/src/mintdb/mintdb_keyio.c index 9add57974..44baee856 100644 --- a/src/mintdb/mintdb_keyio.c +++ b/src/mintdb/mintdb_keyio.c @@ -116,7 +116,7 @@ TALER_MINTDB_signing_keys_iterate (const char *mint_base_dir, * Import a denomination key from the given file. * * @param filename the file to import the key from - * @param[OUT] dki set to the imported denomination key + * @param[out] dki set to the imported denomination key * @return #GNUNET_OK upon success; * #GNUNET_SYSERR upon failure */ diff --git a/src/mintdb/plugin_mintdb_common.c b/src/mintdb/plugin_mintdb_common.c index b8f86da0f..2bd789472 100644 --- a/src/mintdb/plugin_mintdb_common.c +++ b/src/mintdb/plugin_mintdb_common.c @@ -14,9 +14,9 @@ TALER; see the file COPYING. If not, If not, see */ /** - * @file mint/plugin_mintdb_common.c + * @file mintdb/plugin_mintdb_common.c * @brief Functions shared across plugins, this file is meant to be - * #include-d in each plugin. + * included in each plugin. * @author Christian Grothoff */ diff --git a/src/mintdb/plugin_mintdb_postgres.c b/src/mintdb/plugin_mintdb_postgres.c index 0cf8e51e9..053c699f2 100644 --- a/src/mintdb/plugin_mintdb_postgres.c +++ b/src/mintdb/plugin_mintdb_postgres.c @@ -129,6 +129,7 @@ set_temporary_schema (PGconn *db) * Drop the temporary taler schema. This is only useful for testcases * * @param cls the `struct PostgresClosure` with the plugin-specific state + * @param session database session to use * @return #GNUNET_OK upon success; #GNUNET_SYSERR upon failure */ static int @@ -595,7 +596,7 @@ postgres_prepare (PGconn *db_conn) /** * Close thread-local database connection when a thread is destroyed. * - * @param closure we get from pthreads (the db handle) + * @param cls closure we get from pthreads (the db handle) */ static void db_conn_destroy (void *cls) @@ -1439,7 +1440,7 @@ postgres_insert_deposit (void *cls, * @param cls the `struct PostgresClosure` with the plugin-specific state * @param session database handle to use * @param session_hash hash over the melt to use to locate the session - * @param refresh_session[OUT] where to store the result + * @param[out] refresh_session where to store the result * @return #GNUNET_YES on success, * #GNUNET_NO if not found, * #GNUNET_SYSERR on DB failure @@ -1605,7 +1606,7 @@ postgres_insert_refresh_melt (void *cls, * * @param cls the `struct PostgresClosure` with the plugin-specific state * @param session database connection - * @param refresh_session session key of the melt operation + * @param session_hash session hash of the melt operation * @param oldcoin_index index of the coin to retrieve * @param melt melt data to fill in * @return #GNUNET_OK on success @@ -1687,7 +1688,7 @@ postgres_insert_refresh_order (void *cls, * @param cls the `struct PostgresClosure` with the plugin-specific state * @param session database connection * @param session_hash hash to identify refresh session - * @param newcoin_index array of the @a denom_pubs array + * @param num_newcoins size of the array of the @a denom_pubs array * @param denom_pubs where to store the deomination keys * @return #GNUNET_OK on success * #GNUNET_SYSERR on internal error @@ -1811,9 +1812,9 @@ postgres_insert_refresh_commit_coins (void *cls, * @param cls the `struct PostgresClosure` with the plugin-specific state * @param session database connection to use * @param session_hash hash to identify refresh session - * @param i set index (1st dimension) - * @param j coin index (2nd dimension), corresponds to refreshed (new) coins - * @param commit_coin[OUT] coin commitment to return + * @param cnc_index set index (1st dimension) + * @param newcoin_index coin index (2nd dimension), corresponds to refreshed (new) coins + * @param[out] cc coin commitment to return * @return #GNUNET_OK on success * #GNUNET_NO if not found * #GNUNET_SYSERR on error @@ -1947,7 +1948,7 @@ postgres_insert_refresh_commit_links (void *cls, * @param session_hash hash to identify refresh session * @param i set index (1st dimension) * @param num_links size of the @a commit_link array - * @param links[OUT] array of link information to return + * @param[out] links array of link information to return * @return #GNUNET_SYSERR on internal error, * #GNUNET_NO if commitment was not found * #GNUNET_OK on success @@ -2183,8 +2184,8 @@ postgres_get_link_data_list (void *cls, * @param cls the `struct PostgresClosure` with the plugin-specific state * @param session database connection * @param coin_pub public key of the coin - * @param transfer_pub[OUT] public transfer key - * @param shared_secret_enc[OUT] set to shared secret + * @param[out] transfer_pub public transfer key + * @param[out] shared_secret_enc set to shared secret * @return #GNUNET_OK on success, * #GNUNET_NO on failure (not found) * #GNUNET_SYSERR on internal failure (database issue) diff --git a/src/util/amount.c b/src/util/amount.c index c13c9101e..fcf12692f 100644 --- a/src/util/amount.c +++ b/src/util/amount.c @@ -173,7 +173,7 @@ TALER_amount_hton (struct TALER_AmountNBO *res, * Convert amount from network to host representation. * * @param res where to store amount in host representation - * @param d amount in network representation + * @param dn amount in network representation */ void TALER_amount_ntoh (struct TALER_Amount *res, diff --git a/src/util/crypto.c b/src/util/crypto.c index eca4e407a..e2c298da5 100644 --- a/src/util/crypto.c +++ b/src/util/crypto.c @@ -154,7 +154,7 @@ TALER_transfer_decrypt (const struct TALER_EncryptedLinkSecretP *secret_enc, * * @param secret shared secret for refresh link decryption * @param trans_sec transfer secret - * @param secret_enc[out] encrypted secret + * @param[out] secret_enc encrypted secret * @return #GNUNET_OK on success */ int diff --git a/src/util/json.c b/src/util/json.c index d3496c42c..c462597a1 100644 --- a/src/util/json.c +++ b/src/util/json.c @@ -75,7 +75,7 @@ TALER_json_from_amount (const struct TALER_Amount *amount) /** * Convert absolute timestamp to a json string. * - * @param the time stamp + * @param stamp the time stamp * @return a json string with the timestamp in @a stamp */ json_t * @@ -214,7 +214,8 @@ TALER_json_from_rsa_signature (struct GNUNET_CRYPTO_rsa_Signature *sig) * @return json string that encodes @a data */ json_t * -TALER_json_from_data (const void *data, size_t size) +TALER_json_from_data (const void *data, + size_t size) { char *buf; json_t *json; @@ -244,7 +245,7 @@ TALER_json_from_hash (const struct GNUNET_HashCode *hc) * Parse given JSON object to Amount * * @param json the json object representing Amount - * @param r_amount where the amount has to be written + * @param[out] r_amount where the amount has to be written * @return #GNUNET_OK upon successful parsing; #GNUNET_SYSERR upon error */ int @@ -275,7 +276,7 @@ TALER_json_to_amount (json_t *json, * Parse given JSON object to Amount * * @param json the json object representing Amount - * @param r_amount where the amount has to be written + * @param[out] abs where the amount has to be written * @return #GNUNET_OK upon successful parsing; #GNUNET_SYSERR upon error */ int diff --git a/src/util/os_installation.c b/src/util/os_installation.c index 5abd64493..ad89f4e58 100644 --- a/src/util/os_installation.c +++ b/src/util/os_installation.c @@ -449,7 +449,7 @@ os_get_exec_path () /** * @brief get the path to a specific Taler installation directory or, - * with #TALER_OS_IPK_SELF_PREFIX, the current running apps installation directory + * with #GNUNET_OS_IPK_SELF_PREFIX, the current running apps installation directory * @author Milan * @return a pointer to the dir path (to be freed by the caller) */ diff --git a/src/util/util.c b/src/util/util.c index 5c1e5eb9a..972386357 100644 --- a/src/util/util.c +++ b/src/util/util.c @@ -32,9 +32,10 @@ /** * Obtain denomination amount from configuration file. * + * @param cfg configuration to use * @param section section of the configuration to access * @param option option of the configuration to access - * @param denom[OUT] set to the amount found in configuration + * @param[out] denom set to the amount found in configuration * @return #GNUNET_OK on success, #GNUNET_SYSERR on error */ int -- cgit v1.2.3