[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[gnunet] branch master updated (4ca81ff1a -> baea2e9c4)
|
From: |
gnunet |
|
Subject: |
[gnunet] branch master updated (4ca81ff1a -> baea2e9c4) |
|
Date: |
Tue, 18 Oct 2022 03:05:59 +0200 |
This is an automated email from the git hooks/post-receive script.
martin-schanzenbach pushed a change to branch master
in repository gnunet.
from 4ca81ff1a PACKAGES: Update fedora configurations and scripts
new 9173da4f8 -more package specific files
new 26a2f2569 -DOC: Another comment-stripping pass through FS subsystem
new 1e13d39e7 -DOC: Pass through GNSRECORD library
new fff241df3 -DOC: Pass through PEERINFO subsystem
new 7227761ee -DOC: Pass through PEERSTORE subsystem
new fc4006ab9 -DOC: Pass through IDENTITY subsystem
new 7b4d69a64 -DOC: Pass through HELLO library
new 4d68c9fed -DOC: Pass through UTIL libraries (HELPER, MST, NETWORK, OS,
PEER)
new aa3216d58 -DOC: Pass through NAT library
new 8367a2ac2 -DOC: Pass through NT subsystem
new 308d54a98 -DOC: Pass through RECLAIM subsystem
new 71d3949f6 -DOC: Comment stripping pass in TESTBED subsystem
new 34520f8f9 -DOC: Comment stripping pass in old SET subsystem
new 22eb1d1f0 -DOC: Comment stripping pass in SETU subsystem
new b7d0705de -DOC: Comment stripping pass in SETI subsystem
new d21ed4b27 -DOC: Comment stripping pass in TESTING libraries
new aeed121c0 -DOC: Comment stripping pass in TESTBED logger subsystem
new bd5a7c633 -DOC: Comment stripping pass in SQ library
new da4acd7fa -DOC: Comment stripping pass in STATISTICS service
new a70ef57f0 -DOC: Comment stripping pass in REGEX service
new e40fef022 -DOC: Comment stripping pass in UTIL scheduler library
new 0e290c5d8 -DOC: Comment stripping pass in REST service
new 9fea498a6 -DOC: Comment stripping pass in REVOCATION service
new 376446dfd -DOC: Comment stripping pass in SCALARPRODUCT service
new fcc8d05d7 -DOC: Comment stripping pass in SECRETSHARING service
new b54a42c37 -DOC: Cleaning up 'eof inside group' warnings, some of which
(along with 'eof inside comment' warnings) have no obvious source.
new e13e66d0d -DOC: Numerous small fixes to clean up short warning
categories
new d4f25caab -DOC: Minor fixes to doc comments (mostly correcting typos)
to resolve 'unknown command' warnings
new cb4c05179 -DOC: used \f$ commands to bracket formulae here, so the
inside is actually treated like LaTeX
new bd83912f4 DOC: Reconfigured Doxygen HTML output to improve navigability
new eee291e1a -DOC: Redirected doxygen warnings to doxygen_warnings.log
new f878edd42 -DOC: Major doc comment stripping pass through TRANSPORT
new 0d89c3b61 -DOC: Another comment stripping pass through TESTBED
new be98a6e57 -DOC: Another comment stripping pass through REGEX
new 752df719e -DOC: Another comment stripping pass through RECLAIM
new 824647f7c -DOC: Another comment stripping pass through old SET
subsystem
new 148b5a3e3 -DOC: Another comment stripping pass through SETU
new 4be37a584 -DOC: Comment stripping pass through MySQL library
new 09daf5df4 -DOC: Comment stripping pass through NAT service
new 64711ee52 -DOC: Comment stripping pass through PEERSTORE
new 5f00aea2b -DOC: Comment stripping pass through UTIL dnsstub, regex,
speedup, and TUN libraries
new 35775fc6b -DOC: Minor comment stripping pass through VPN
new 7162905b6 -Minor tweaks to warningfilter.py regexes
new 1d0bbddfe -DOC: Documentation cleanup pass through TRANSPORT ('missing
argument' warnings)
new dd797c2c6 -DOC: Documentation cleanup pass through MESSENGER subsystem
new 763b8f71b -DOC: Documentation cleanup pass through CADET subsystem
new 8a8644823 -DOC: Documentation cleanup pass through SCALARPRODUCT
subsystem
new 2803abe19 -DOC: Documentation cleanup pass through RECLAIM subsystem
new f246a9aa8 -DOC: Documentation cleanup pass through ABD subsystem
new ac453afa5 -DOC: Documentation cleanup pass through RPS subsystem
new 35c097009 -DOC: Documentation cleanup pass through NAMESTORE subsystem
new c77b7424f -DOC: Documentation cleanup pass through DHT subsystem
new 182a45fc9 -DOC: Documentation cleanup pass through FS subsystem
new faaa236b9 -DOC: Documentation cleanup pass through UTIL DNSSTUB library
new 42cda6099 -DOC: Documentation cleanup pass through TESTBED subsystem
new 8c2b85f0f -DOC: Documentation cleanup pass through TESTING libraries
new 7f8599304 -DOC: Documentation cleanup pass through GNS subsystem
new 95b52cc6f -DOC: Documentation cleanup pass through old SET subsystem
new b512a9883 -DOC: Documentation cleanup pass through SETU subsystem
new 77293658a -DOC: Documentation cleanup pass through DATASTORE subsystem
new 58888b24c -DOC: Documentation cleanup pass through DATACACHE subsystem
new f299d0592 -DOC: Documentation cleanup pass through ATS subsystem
new a35b07878 -DOC: Documentation cleanup pass through UTIL SERVICE library
new 4ef0c1716 -DOC: Moved warningfilter to scripts/doc
new 916e2b18a -DOC: Documentation cleanup pass through ARM service
new 2d2c37c43 -DOC: Documentation cleanup pass through BLOCK library
new 10bf46207 -DOC: Documentation cleanup pass through HELLO library
new 26cbf92d6 -DOC: Documentation cleanup pass through PQ library
(Postgres?)
new 98594a4d8 -DOC: Documentation cleanup pass through rest of UTIL
libraries
new 20bd667f1 -DOC: Documentation cleanup pass through CONSENSUS subsystem
new e75790fb7 -DOC: Documentation cleanup pass through CONVERSATION
subsystem
new 68c407cc8 -DOC: Documentation cleanup pass through CORE subsystem
new c2f6e093f -DOC: Documentation cleanup pass through DHT Underlay
subsystem
new 17824f684 -DOC: Documentation cleanup pass through DNS subsystem
new e4bf8b123 -DOC: Documentation cleanup pass through EXIT daemon
new c03ab4f0a -DOC: Documentation cleanup pass through HOSTLIST daemon
new c235f90c2 -DOC: Documentation cleanup pass through IDENTITY service
new c12efffd6 -DOC: Documentation cleanup pass through NAMECACHE service
new a4090f161 -DOC: Documentation cleanup pass through REGEX service
new 9bff860b8 -DOC: Documentation cleanup pass through REST subsystem
new 4d89255df -DOC: Documentation cleanup pass through SECRETSHARING
subsystem
new 0d9fb894a -DOC: Documentation cleanup pass through STATISTICS subsystem
new 19e5b9874 -DOC: Documentation cleanup pass through VPN subsystem
new e67ee030e -DOC: Documentation cleanup pass through NAT subsystem
new 43dc9b3eb -DOC: Documentation cleanup pass through assorted libraries
(curl integration, GNSRECORD, json)
new 5599d5db9 -DOC: Continued organisation of modules into nested groups
new d748b0c92 -DOC: Tweak to doxyfile: INTERACTIVE_SVG = NO -> YES
new c9562b8cf -fix conflict
new 43b55e25e -Removed references to explicit /tmp in test scripts and
configurations in DHT, GNS, STATISTICS, and TRANSPORT subsystems.
new baea2e9c4 Merge branch 'dev/willow/gnunet_temp_sh_py'
The 90 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
contrib/Makefile.am | 3 +
.../fedora}/gnunet-user.service | 0
.../systemd => packages/fedora}/gnunet.service | 0
contrib/{ => scripts/doc}/warningfilter.py | 8 +-
doc/doxygen/.gitignore | 1 +
doc/doxygen/gnunet.doxy | 8 +-
src/abd/delegate_misc.c | 1 +
src/abd/gnunet-abd.c | 4 +-
src/arm/gnunet-service-arm.c | 2 +-
src/ats/gnunet-service-ats_connectivity.c | 2 +-
src/ats/gnunet-service-ats_reservations.h | 2 -
src/block/bg_bf.c | 2 +-
src/block/plugin_block_template.c | 7 +-
src/block/plugin_block_test.c | 7 +-
src/cadet/cadet_api.c | 9 +-
src/cadet/cadet_api_drop_message.c | 2 +-
src/cadet/cadet_api_list_tunnels.c | 2 +-
src/cadet/gnunet-cadet-profiler.c | 2 -
src/cadet/gnunet-service-cadet.c | 3 +-
src/cadet/gnunet-service-cadet_channel.c | 4 +-
src/cadet/gnunet-service-cadet_connection.c | 6 +-
src/cadet/gnunet-service-cadet_connection.h | 2 +-
src/cadet/gnunet-service-cadet_core.c | 8 +-
src/cadet/gnunet-service-cadet_hello.c | 2 +-
src/cadet/gnunet-service-cadet_paths.h | 4 +-
src/cadet/gnunet-service-cadet_peer.c | 10 +-
src/cadet/gnunet-service-cadet_tunnels.c | 17 +-
src/cadet/gnunet-service-cadet_tunnels.h | 4 +-
src/consensus/plugin_block_consensus.c | 1 -
src/conversation/conversation_api.c | 2 +-
src/conversation/conversation_api_call.c | 4 +-
src/core/core_api.c | 1 -
src/core/gnunet-service-core_kx.c | 9 +-
src/datacache/plugin_datacache_postgres.c | 4 +-
src/datacache/plugin_datacache_sqlite.c | 2 +-
src/datastore/datastore_api.c | 2 +-
src/datastore/gnunet-service-datastore.c | 15 +-
src/datastore/plugin_datastore_postgres.c | 2 +-
src/dht/dhtu_testbed_connect.sh | 8 +-
src/dht/dhtu_testbed_deploy.conf | 2 +-
src/dht/dhtu_testbed_deploy.sh | 11 +-
src/dht/gnunet-service-dht.h | 1 -
src/dht/gnunet-service-dht_clients.c | 12 +-
src/dht/gnunet-service-dht_neighbours.c | 11 +-
src/dht/gnunet-service-dht_neighbours.h | 4 +-
src/dht/gnunet-service-dht_routing.c | 2 -
src/dht/test_dht_tools.sh | 5 +-
src/dhtu/plugin_dhtu_gnunet.c | 2 +-
src/dhtu/plugin_dhtu_ip.c | 1 -
src/dns/dns_api.c | 3 +-
src/dns/plugin_block_dns.c | 1 -
src/exit/gnunet-daemon-exit.c | 5 +-
src/fs/fs_dirmetascan.c | 8 -
src/fs/fs_download.c | 65 --
src/fs/fs_file_information.c | 69 --
src/fs/fs_list_indexed.c | 8 -
src/fs/fs_namespace.c | 15 -
src/fs/fs_search.c | 4 +-
src/fs/fs_test_lib.c | 1 -
src/fs/fs_uri.c | 17 -
src/fs/gnunet-service-fs.c | 6 +-
src/fs/gnunet-service-fs_cadet_server.c | 1 -
src/fs/gnunet-service-fs_cp.c | 2 -
src/fs/gnunet-service-fs_push.c | 2 +-
src/fs/plugin_block_fs.c | 3 +-
src/gns/gns_tld_api.c | 2 +-
src/gns/gnunet-gns-proxy.c | 1 -
src/gns/gnunet-service-gns.c | 3 +-
src/gns/nss/nss_gns.c | 4 +-
src/gns/plugin_block_gns.c | 1 -
src/gns/plugin_rest_gns.c | 2 +-
src/gns/test_dns2gns.conf | 2 +-
src/gns/test_gns_lookup.conf | 2 +-
src/gns/test_gns_lookup_peer1.conf | 2 +-
src/gns/test_gns_lookup_peer2.conf | 2 +-
src/gns/test_gns_proxy.conf | 2 +-
src/gns/test_proxy.sh | 17 +-
src/gnsrecord/gnsrecord.c | 16 -
src/gnsrecord/gnsrecord_crypto.c | 19 -
src/gnsrecord/gnsrecord_misc.c | 8 -
src/gnsrecord/gnsrecord_serialization.c | 17 -
src/hello/address.c | 18 -
src/hello/hello-ng.c | 4 +-
src/hello/hello.c | 22 -
src/hostlist/gnunet-daemon-hostlist_client.c | 2 -
src/identity/gnunet-service-identity.c | 15 +-
src/identity/identity_api.c | 10 -
src/identity/plugin_rest_identity.c | 4 +-
src/include/block_dns.h | 5 +
src/include/block_fs.h | 5 +
src/include/gnunet_abd_service.h | 9 +-
src/include/gnunet_applications.h | 5 +
src/include/gnunet_ats_service.h | 6 +-
src/include/gnunet_block_group_lib.h | 2 +-
src/include/gnunet_block_lib.h | 3 +-
src/include/gnunet_client_lib.h | 4 +-
src/include/gnunet_common.h | 4 +-
src/include/gnunet_configuration_lib.h | 2 +-
src/include/gnunet_container_lib.h | 18 +-
src/include/gnunet_crypto_lib.h | 14 +-
src/include/gnunet_curl_lib.h | 14 +-
src/include/gnunet_dhtu_plugin.h | 2 +-
src/include/gnunet_disk_lib.h | 2 +-
src/include/gnunet_dnsstub_lib.h | 2 +-
src/include/gnunet_friends_lib.h | 5 +
src/include/gnunet_fs_service.h | 4 +-
src/include/gnunet_getopt_lib.h | 1 -
src/include/gnunet_gns_service.h | 2 +
src/include/gnunet_gnsrecord_lib.h | 4 +-
src/include/gnunet_hello_lib.h | 8 +-
src/include/gnunet_json_lib.h | 4 +-
src/include/gnunet_load_lib.h | 5 +
src/include/gnunet_messenger_service.h | 20 +-
src/include/gnunet_mq_lib.h | 19 +-
src/include/gnunet_mst_lib.h | 4 +-
src/include/gnunet_my_lib.h | 19 +-
src/include/gnunet_nat_auto_service.h | 2 +-
src/include/gnunet_nc_lib.h | 2 +
src/include/gnunet_nt_lib.h | 5 +
src/include/gnunet_peerinfo_service.h | 1 -
src/include/gnunet_peerstore_service.h | 1 +
src/include/gnunet_pq_lib.h | 12 +-
src/include/gnunet_reclaim_lib.h | 14 +-
src/include/gnunet_reclaim_service.h | 8 +-
src/include/gnunet_resolver_service.h | 5 +
src/include/gnunet_scalarproduct_service.h | 2 +-
src/include/gnunet_service_lib.h | 8 +-
src/include/gnunet_set_service.h | 10 +-
src/include/gnunet_setu_service.h | 6 +-
src/include/gnunet_socks.h | 5 +
src/include/gnunet_sq_lib.h | 2 +-
src/include/gnunet_strings_lib.h | 4 +-
src/include/gnunet_testbed_service.h | 8 +-
src/include/gnunet_testing_lib.h | 6 +-
src/include/gnunet_testing_netjail_lib.h | 4 +-
src/include/gnunet_testing_ng_lib.h | 4 +-
src/include/gnunet_time_lib.h | 2 +-
src/include/gnunet_transport_application_service.h | 4 +-
.../gnunet_transport_communication_service.h | 5 +-
src/include/gnunet_transport_service.h | 5 +-
src/messenger/gnunet-messenger.c | 14 +-
src/messenger/gnunet-service-messenger_ego_store.h | 24 +-
src/messenger/gnunet-service-messenger_handle.h | 26 +-
.../gnunet-service-messenger_list_handles.h | 10 +-
.../gnunet-service-messenger_list_messages.h | 8 +-
src/messenger/gnunet-service-messenger_member.h | 20 +-
.../gnunet-service-messenger_member_session.h | 16 +-
.../gnunet-service-messenger_member_store.h | 12 +-
.../gnunet-service-messenger_message_handle.h | 32 +-
.../gnunet-service-messenger_message_kind.h | 2 +-
.../gnunet-service-messenger_message_recv.h | 12 +-
.../gnunet-service-messenger_message_send.h | 16 +-
.../gnunet-service-messenger_message_store.h | 12 +-
src/messenger/gnunet-service-messenger_operation.h | 8 +-
.../gnunet-service-messenger_operation_store.h | 8 +-
src/messenger/gnunet-service-messenger_room.h | 56 +-
src/messenger/gnunet-service-messenger_service.h | 32 +-
src/messenger/gnunet-service-messenger_tunnel.h | 26 +-
src/messenger/messenger_api_contact.h | 10 +-
src/messenger/messenger_api_contact_store.h | 14 +-
src/messenger/messenger_api_handle.h | 18 +-
src/messenger/messenger_api_list_tunnels.h | 16 +-
src/messenger/messenger_api_message.h | 10 +-
src/messenger/messenger_api_room.h | 12 +-
src/messenger/messenger_api_util.h | 2 +-
src/messenger/testing_messenger_barrier.h | 4 +-
src/my/my_query_helper.c | 14 +-
src/my/my_result_helper.c | 11 +-
src/mysql/mysql.c | 1 -
src/namecache/gnunet-service-namecache.c | 2 +-
src/namecache/namecache_api.c | 1 -
src/namestore/gnunet-namestore-fcfsd.c | 2 +-
src/namestore/gnunet-namestore.c | 4 +-
src/namestore/gnunet-service-namestore.c | 10 +-
src/namestore/gnunet-zoneimport.c | 2 +-
src/namestore/plugin_namestore_flat.c | 818 +++++++++++++++++++++
src/namestore/plugin_namestore_postgres.c | 4 +-
src/namestore/plugin_rest_namestore.c | 2 +-
src/nat-auto/gnunet-nat-server.c | 2 +-
src/nat-auto/nat_auto_api_test.c | 2 +-
src/nat/gnunet-nat.c | 2 +-
src/nat/gnunet-service-nat.c | 2 +-
src/nat/gnunet-service-nat_helper.c | 10 -
src/nat/gnunet-service-nat_mini.c | 8 -
src/nat/nat_api.c | 20 -
src/nat/nat_api_stun.c | 2 +-
src/nse/gnunet-service-nse.c | 2 +-
src/nt/nt.c | 6 -
src/peerinfo/peerinfo_api.c | 23 -
src/peerstore/peerstore_api.c | 11 -
src/peerstore/peerstore_common.c | 6 -
src/pq/pq_event.c | 2 +-
src/pq/pq_exec.c | 9 -
src/pq/pq_result_helper.c | 26 +-
src/reclaim/did.h | 4 +-
src/reclaim/gnunet-service-reclaim.c | 16 +-
src/reclaim/gnunet-service-reclaim_tickets.c | 21 +-
src/reclaim/oidc_helper.c | 11 -
src/reclaim/oidc_helper.h | 6 +-
src/reclaim/reclaim_api.c | 69 +-
src/reclaim/reclaim_attribute.c | 33 +-
src/reclaim/reclaim_credential.c | 72 +-
src/regex/gnunet-regex-profiler.c | 1 -
src/regex/gnunet-service-regex.c | 6 +-
src/regex/regex_api_announce.c | 5 -
src/regex/regex_api_search.c | 17 -
src/regex/regex_block_lib.c | 43 --
src/regex/regex_internal.c | 64 --
src/regex/regex_internal.h | 4 +-
src/regex/regex_internal_dht.c | 6 -
src/rest/gnunet-rest-server.c | 1 -
src/rest/plugin_rest_config.c | 1 -
src/rest/rest.c | 13 -
src/revocation/revocation_api.c | 14 -
src/rps/gnunet-rps-profiler.c | 2 +-
src/rps/gnunet-rps.c | 2 +-
src/rps/gnunet-service-rps.c | 12 +-
src/rps/gnunet-service-rps_sampler_elem.c | 2 +-
src/rps/rps-sampler_common.c | 22 -
src/rps/rps-sampler_common.h | 2 -
src/rps/rps_api.c | 2 +-
src/scalarproduct/gnunet-scalarproduct.c | 1 -
.../gnunet-service-scalarproduct-ecc_alice.c | 2 +-
.../gnunet-service-scalarproduct-ecc_bob.c | 4 +-
.../gnunet-service-scalarproduct_alice.c | 2 +-
.../gnunet-service-scalarproduct_bob.c | 2 +-
src/scalarproduct/scalarproduct_api.c | 25 +-
src/secretsharing/gnunet-service-secretsharing.c | 1 -
src/secretsharing/secretsharing_api.c | 26 -
src/secretsharing/secretsharing_protocol.h | 8 +-
src/set/gnunet-service-set.c | 4 +-
src/set/gnunet-service-set_intersection.c | 9 +-
src/set/gnunet-service-set_intersection.h | 2 +-
src/set/gnunet-service-set_union.c | 6 -
.../gnunet-service-set_union_strata_estimator.c | 6 -
src/set/set_api.c | 63 +-
src/seti/seti_api.c | 26 -
src/setu/ibf.c | 30 -
src/setu/setu_api.c | 26 -
src/sq/sq.c | 13 -
src/sq/sq_prepare.c | 8 -
src/sq/sq_query_helper.c | 2 +-
src/statistics/gnunet-service-statistics.c | 10 +-
src/statistics/statistics_api.c | 40 +-
src/statistics/test_gnunet_statistics.py.in | 13 +-
src/testbed-logger/testbed_logger_api.c | 7 -
src/testbed/gnunet-service-testbed.c | 9 +-
src/testbed/gnunet-service-testbed.h | 11 +-
src/testbed/gnunet-service-testbed_barriers.c | 4 +-
src/testbed/gnunet-service-testbed_peers.c | 18 -
src/testbed/testbed_api.c | 75 +-
src/testbed/testbed_api_barriers.c | 11 -
src/testbed/testbed_api_hosts.c | 19 -
src/testbed/testbed_api_operations.c | 8 -
src/testbed/testbed_api_operations.h | 4 +-
src/testbed/testbed_api_peers.c | 55 --
src/testbed/testbed_api_testbed.c | 5 -
src/testbed/testbed_api_topology.c | 63 --
src/testbed/testbed_api_topology.h | 6 +-
src/testing/testing.c | 60 --
src/testing/testing_api_cmd_local_test_prepared.c | 8 -
src/testing/testing_api_loop.c | 12 -
src/transport/gnunet-communicator-tcp.c | 16 +-
src/transport/gnunet-communicator-udp.c | 12 +-
src/transport/gnunet-service-tng.c | 32 +-
src/transport/gnunet-service-transport.c | 7 +-
src/transport/gnunet-service-transport_ats.c | 14 -
src/transport/gnunet-service-transport_ats.h | 3 +-
src/transport/gnunet-service-transport_hello.c | 10 -
.../gnunet-service-transport_manipulation.c | 4 +-
.../gnunet-service-transport_neighbours.c | 24 -
.../gnunet-service-transport_neighbours.h | 2 +-
src/transport/gnunet-service-transport_plugins.c | 19 -
src/transport/gnunet-service-transport_plugins.h | 4 -
src/transport/plugin_transport_http_client.c | 6 -
src/transport/plugin_transport_http_common.c | 45 --
src/transport/plugin_transport_http_common.h | 6 +-
src/transport/plugin_transport_http_server.c | 2 +-
src/transport/plugin_transport_tcp.c | 2 +-
src/transport/plugin_transport_udp.c | 2 +-
src/transport/tcp_server_legacy.c | 20 -
src/transport/test_transport_api2_tcp_node1.conf | 6 +-
src/transport/test_transport_api2_tcp_node2.conf | 4 +-
src/transport/test_transport_api2_tcp_peer1.conf | 4 +-
src/transport/test_transport_api2_tcp_peer2.conf | 4 +-
src/transport/transport-testing-cmds.h | 10 +-
src/transport/transport-testing-communicator.c | 15 +-
src/transport/transport-testing-filenames.c | 28 -
src/transport/transport-testing-main.c | 2 +-
src/transport/transport-testing-main2.c | 2 +-
src/transport/transport-testing2.c | 33 -
src/transport/transport-testing2.h | 2 +-
src/transport/transport_api2_communication.c | 80 --
src/transport/transport_api_address_to_string.c | 4 +-
.../transport_api_cmd_backchannel_check.c | 12 -
src/transport/transport_api_cmd_connecting_peers.c | 11 -
src/transport/transport_api_cmd_send_simple.c | 10 -
src/transport/transport_api_core.c | 2 +-
src/transport/transport_api_monitor_peers.c | 26 -
src/transport/transport_api_monitor_plugins.c | 4 +-
src/transport/transport_api_offer_hello.c | 5 -
src/util/child_management.c | 2 +-
src/util/common_logging.c | 38 +-
src/util/configuration.c | 4 +-
src/util/container_multihashmap32.c | 4 +-
src/util/crypto_rsa.c | 2 +-
src/util/dnsstub.c | 14 +-
src/util/gnunet-scrypt.c | 1 -
src/util/gnunet-service-resolver.c | 8 +-
src/util/helper.c | 46 --
src/util/mst.c | 14 -
src/util/network.c | 23 -
src/util/os_installation.c | 5 -
src/util/os_priority.c | 51 --
src/util/peer.c | 12 -
src/util/regex.c | 42 --
src/util/scheduler.c | 28 -
src/util/service.c | 2 +-
src/util/socks.c | 2 +-
src/util/speedup.c | 6 -
src/util/tun.c | 39 -
src/vpn/gnunet-service-vpn.c | 4 +-
src/vpn/vpn_api.c | 22 -
323 files changed, 1586 insertions(+), 2781 deletions(-)
copy contrib/{services/systemd => packages/fedora}/gnunet-user.service (100%)
copy contrib/{services/systemd => packages/fedora}/gnunet.service (100%)
rename contrib/{ => scripts/doc}/warningfilter.py (95%)
create mode 100644 src/namestore/plugin_namestore_flat.c
diff --git a/contrib/Makefile.am b/contrib/Makefile.am
index 66b7c51c3..fbbc919bd 100644
--- a/contrib/Makefile.am
+++ b/contrib/Makefile.am
@@ -45,6 +45,9 @@ INITD_FILES = \
PACKAGES_FILES = \
packages/fedora/10-dns2gns.sh \
+ packages/fedora/gnunet-system.conf \
+ packages/fedora/gnunet.service \
+ packages/fedora/gnunet-user.service \
packages/alpine/gnunet-gtk/APKBUILD \
packages/alpine/gnurl/APKBUILD \
packages/alpine/gnunet/gnunet-user-services.initd \
diff --git a/contrib/services/systemd/gnunet-user.service
b/contrib/packages/fedora/gnunet-user.service
similarity index 100%
copy from contrib/services/systemd/gnunet-user.service
copy to contrib/packages/fedora/gnunet-user.service
diff --git a/contrib/services/systemd/gnunet.service
b/contrib/packages/fedora/gnunet.service
similarity index 100%
copy from contrib/services/systemd/gnunet.service
copy to contrib/packages/fedora/gnunet.service
diff --git a/contrib/warningfilter.py b/contrib/scripts/doc/warningfilter.py
similarity index 95%
rename from contrib/warningfilter.py
rename to contrib/scripts/doc/warningfilter.py
index b8399bb38..31ac5865c 100755
--- a/contrib/warningfilter.py
+++ b/contrib/scripts/doc/warningfilter.py
@@ -61,18 +61,18 @@ matches = {
"undocumented param (name)": re.compile(r" parameter '([\w.]+)'"),
"explicit link not resolved": re.compile(rf"{main_match} explicit link
request to '(\w+(?:\(\))?)' could not be resolved"),
"unknown command": re.compile(rf"{main_match} Found unknown command
'(\\\w+)'"),
- "missing argument": re.compile(rf"{main_match} argument '(\w+)' of command
@param is not found in the argument list of
{func_name}(?:{func_params}|{macro_params})"),
+ "missing argument": re.compile(rf"{main_match} argument '(\w+)' of command
@param is not found in the argument list of
({func_name})(?:{func_params}|{macro_params})"),
"eof inside group": re.compile(rf"{main_match} end of file while inside a
group"),
- "eof inside comment": re.compile(rf"{main_match} Reached end of file while
still inside a \(nested\) comment. Nesting level \d+ \(probable line reference:
\d+\)"),
+ "eof inside comment": re.compile(rf"{main_match} Reached end of file while
still inside a \(nested\) comment. Nesting level \d+ \(probable line reference:
(\d+)\)"),
"eof inside code block": re.compile(rf"{main_match} reached end of file
while inside a 'code' block!"),
"eof inside code block (line 2)": re.compile(rf"The command that should
end the block seems to be missing!"),
"title mismatch": re.compile(rf"{main_match} group (?P<group_id>\w+):
ignoring title \"(?P<new_title>{verbose_name})\" that does not match old title
\"(?P<old_title>{verbose_name})\""),
- "end of comment expecting command": re.compile(rf"{main_match} end of
comment block while expecting command {command_re}"),
+ "end of comment expecting command": re.compile(rf"{main_match} end of
comment block while expecting command ({command_re})"),
"no matching tag": re.compile(rf"{main_match} found </(?P<tag>[^>]+)> tag
without matching <(?P=tag)>"),
"documented empty return type": re.compile(rf"{main_match} documented
empty return type of {func_name}"),
"unsupported tag": re.compile(rf"{main_match} Unsupported xml/html tag
<(?P<tag>[^>]+)> found"),
"expected whitespace after command": re.compile(rf"{main_match} expected
whitespace after \\(?P<command>\w+) command"),
- "illegal command": re.compile(rf"{main_match} Illegal command
(?P<illegal_cmd>(?:@|\\)\w+) as part of a (?P<command>\\\w+) command"),
+ "illegal command": re.compile(rf"{main_match} Illegal command
(?P<illegal_cmd>(?:@|\\)\w+) as part of a \\(?P<command>\w+) command"),
"undeclared symbol": re.compile(rf"{main_match} documented symbol '(\w+)'
was not declared or defined\."),
"nameless member": re.compile(rf"{main_match} member with no name found."),
"end of empty list": re.compile(rf"{main_match} End of list marker found
without any preceding list items"),
diff --git a/doc/doxygen/.gitignore b/doc/doxygen/.gitignore
index 6000c5c92..8cfc0958d 100644
--- a/doc/doxygen/.gitignore
+++ b/doc/doxygen/.gitignore
@@ -1,4 +1,5 @@
version.doxy
gnunet.tag
+doxygen_warnings.log
html/
xml/
diff --git a/doc/doxygen/gnunet.doxy b/doc/doxygen/gnunet.doxy
index bfde393ae..3a7a9165f 100644
--- a/doc/doxygen/gnunet.doxy
+++ b/doc/doxygen/gnunet.doxy
@@ -820,7 +820,7 @@ WARN_FORMAT = "$file:$line: $text"
# messages should be written. If left blank the output is written to standard
# error (stderr).
-WARN_LOGFILE =
+WARN_LOGFILE = "doxygen_warnings.log"
#---------------------------------------------------------------------------
# Configuration options related to the input files
@@ -1537,7 +1537,7 @@ ECLIPSE_DOC_ID = org.doxygen.Project
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
-DISABLE_INDEX = NO
+DISABLE_INDEX = YES
# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
# structure should be generated to display hierarchical information. If the tag
@@ -1554,7 +1554,7 @@ DISABLE_INDEX = NO
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
-GENERATE_TREEVIEW = NONE
+GENERATE_TREEVIEW = YES
# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values
that
# doxygen will group on one line in the generated HTML documentation.
@@ -2485,7 +2485,7 @@ DOT_IMAGE_FORMAT = svg
# The default value is: NO.
# This tag requires that the tag HAVE_DOT is set to YES.
-INTERACTIVE_SVG = NO
+INTERACTIVE_SVG = YES
# The DOT_PATH tag can be used to specify the path where the dot tool can be
# found. If left blank, it is assumed the dot tool can be found in the path.
diff --git a/src/abd/delegate_misc.c b/src/abd/delegate_misc.c
index 0c5520d52..cc45cde04 100644
--- a/src/abd/delegate_misc.c
+++ b/src/abd/delegate_misc.c
@@ -190,6 +190,7 @@ GNUNET_ABD_delegate_from_string (const char *s)
* @param issuer the ego that should be used to issue the attribute
* @param subject the subject of the attribute
* @param iss_attr the name of the attribute
+ * @param expiration the TTL of the credential
* @return handle to the queued request
*/
diff --git a/src/abd/gnunet-abd.c b/src/abd/gnunet-abd.c
index 9f5fef958..6f6521d98 100644
--- a/src/abd/gnunet-abd.c
+++ b/src/abd/gnunet-abd.c
@@ -429,8 +429,8 @@ identity_cb (void *cls, struct GNUNET_IDENTITY_Ego *ego)
* Parse expiration time.
*
* @param expirationstring text to parse
- * @param etime_is_rel[out] set to #GNUNET_YES if time is relative
- * @param etime[out] set to expiration time (abs or rel)
+ * @param[out] etime_is_rel set to #GNUNET_YES if time is relative
+ * @param[out] etime set to expiration time (abs or rel)
* @return #GNUNET_OK on success
*/
static int
diff --git a/src/arm/gnunet-service-arm.c b/src/arm/gnunet-service-arm.c
index b412094d3..da94efdd8 100644
--- a/src/arm/gnunet-service-arm.c
+++ b/src/arm/gnunet-service-arm.c
@@ -1358,7 +1358,7 @@ pool_write (char *pool_start, size_t pool_size, size_t
*pool_pos, char *str)
* Handle LIST-message.
*
* @param cls identification of the client
- * @param message the actual message
+ * @param request the actual message
*/
static void
handle_list (void *cls, const struct GNUNET_ARM_Message *request)
diff --git a/src/ats/gnunet-service-ats_connectivity.c
b/src/ats/gnunet-service-ats_connectivity.c
index 5ee9b60f5..702c5ba87 100644
--- a/src/ats/gnunet-service-ats_connectivity.c
+++ b/src/ats/gnunet-service-ats_connectivity.c
@@ -76,7 +76,7 @@ GAS_connectivity_has_peer (void *cls,
* Handle #GNUNET_MESSAGE_TYPE_ATS_REQUEST_ADDRESS messages from clients.
*
* @param client client that sent the request
- * @param message the request message
+ * @param msg the request message
*/
void
GAS_handle_request_address (struct GNUNET_SERVICE_Client *client,
diff --git a/src/ats/gnunet-service-ats_reservations.h
b/src/ats/gnunet-service-ats_reservations.h
index d95945697..07edd69e0 100644
--- a/src/ats/gnunet-service-ats_reservations.h
+++ b/src/ats/gnunet-service-ats_reservations.h
@@ -58,8 +58,6 @@ GAS_handle_reservation_request (struct GNUNET_SERVICE_Client
*client,
/**
* Initialize reservations subsystem.
- *
- * @param server handle to our server
*/
void
GAS_reservations_init (void);
diff --git a/src/block/bg_bf.c b/src/block/bg_bf.c
index b79ea3c55..c8269498e 100644
--- a/src/block/bg_bf.c
+++ b/src/block/bg_bf.c
@@ -226,7 +226,7 @@ GNUNET_BLOCK_GROUP_bf_create (void *cls,
* @param bg block group to use for testing
* @param hc hash of element to evaluate
* @return #GNUNET_YES if @a hc is (likely) a duplicate
- * #GNUNET_NO if @a hc was definitively not in @bg (but now is)
+ * #GNUNET_NO if @a hc was definitively not in @a bg (but now is)
*/
enum GNUNET_GenericReturnValue
GNUNET_BLOCK_GROUP_bf_test_and_set (struct GNUNET_BLOCK_Group *bg,
diff --git a/src/block/plugin_block_template.c
b/src/block/plugin_block_template.c
index 46a370924..4a271fa42 100644
--- a/src/block/plugin_block_template.c
+++ b/src/block/plugin_block_template.c
@@ -55,7 +55,7 @@
* by this @a type of block (this is not an error)
*/
static struct GNUNET_BLOCK_Group *
-block_plugin_template_create_group (void *cls,
+block_plugin_template_create_group (void *ctx,
enum GNUNET_BLOCK_Type type,
const void *raw_data,
size_t raw_data_size,
@@ -79,7 +79,7 @@ block_plugin_template_create_group (void *cls,
bf_size = TEMPLATE_BF_SIZE;
}
GNUNET_break (NULL == va_arg (va, const char *));
- return GNUNET_BLOCK_GROUP_bf_create (cls,
+ return GNUNET_BLOCK_GROUP_bf_create (ctx,
bf_size,
BLOOMFILTER_K,
type,
@@ -92,10 +92,9 @@ block_plugin_template_create_group (void *cls,
* Function called to validate a query.
*
* @param cls closure
- * @param ctx block context
* @param type block type
* @param query original query (hash)
- * @param xquery extrended query data (can be NULL, depending on type)
+ * @param xquery extended query data (can be NULL, depending on type)
* @param xquery_size number of bytes in @a xquery
* @return #GNUNET_OK if the query is fine, #GNUNET_NO if not, #GNUNET_SYSERR
if not supported
*/
diff --git a/src/block/plugin_block_test.c b/src/block/plugin_block_test.c
index 2e404bbc2..5afac9205 100644
--- a/src/block/plugin_block_test.c
+++ b/src/block/plugin_block_test.c
@@ -53,7 +53,7 @@
* by this @a type of block (this is not an error)
*/
static struct GNUNET_BLOCK_Group *
-block_plugin_test_create_group (void *cls,
+block_plugin_test_create_group (void *ctx,
enum GNUNET_BLOCK_Type type,
const void *raw_data,
size_t raw_data_size,
@@ -77,7 +77,7 @@ block_plugin_test_create_group (void *cls,
bf_size = TEST_BF_SIZE;
}
GNUNET_break (NULL == va_arg (va, const char *));
- return GNUNET_BLOCK_GROUP_bf_create (cls,
+ return GNUNET_BLOCK_GROUP_bf_create (ctx,
bf_size,
BLOOMFILTER_K,
type,
@@ -90,10 +90,9 @@ block_plugin_test_create_group (void *cls,
* Function called to validate a query.
*
* @param cls closure
- * @param ctx block context
* @param type block type
* @param query original query (hash)
- * @param xquery extrended query data (can be NULL, depending on type)
+ * @param xquery extended query data (can be NULL, depending on type)
* @param xquery_size number of bytes in @a xquery
* @return #GNUNET_OK if the query is fine, #GNUNET_NO if not, #GNUNET_SYSERR
if @a type is not supported
*/
diff --git a/src/cadet/cadet_api.c b/src/cadet/cadet_api.c
index 00c3d2e48..0bfb01868 100644
--- a/src/cadet/cadet_api.c
+++ b/src/cadet/cadet_api.c
@@ -198,7 +198,6 @@ create_channel (struct GNUNET_CADET_Handle *h,
* - Frees all memory used
*
* @param ch Pointer to the channel.
- * @param call_cleaner Whether to call the cleaner handler.
*/
static void
destroy_channel (struct GNUNET_CADET_Channel *ch)
@@ -461,7 +460,7 @@ cadet_mq_cancel_impl (struct GNUNET_MQ_Handle *mq, void
*impl_state)
/**
* Process the new channel notification and add it to the channels in the
handle
*
- * @param h The cadet handle
+ * @param cls The cadet handle
* @param msg A message with the details of the new incoming channel
*/
static void
@@ -529,7 +528,7 @@ handle_channel_created (
/**
* Process the channel destroy notification and free associated resources
*
- * @param h The cadet handle
+ * @param cls The cadet handle
* @param msg A message with the details of the channel being destroyed
*/
static void
@@ -582,7 +581,7 @@ check_local_data (void *cls, const struct
GNUNET_CADET_LocalData *message)
/**
* Process the incoming data packets, call appropriate handlers.
*
- * @param h The cadet handle
+ * @param cls The cadet handle
* @param message A message encapsulating the data
*/
static void
@@ -620,7 +619,7 @@ handle_local_data (void *cls, const struct
GNUNET_CADET_LocalData *message)
* Process a local ACK message, enabling the client to send
* more data to the service.
*
- * @param h Cadet handle.
+ * @param cls Cadet handle.
* @param message Message itself.
*/
static void
diff --git a/src/cadet/cadet_api_drop_message.c
b/src/cadet/cadet_api_drop_message.c
index 2b031b5c0..e172418c4 100644
--- a/src/cadet/cadet_api_drop_message.c
+++ b/src/cadet/cadet_api_drop_message.c
@@ -27,7 +27,7 @@
/**
- * Drop the next cadet message of a given type..
+ * Drop the next cadet message of a given type.
*
* @param mq message queue
* @param ccn client channel number.
diff --git a/src/cadet/cadet_api_list_tunnels.c
b/src/cadet/cadet_api_list_tunnels.c
index e9ae069bb..dce12835f 100644
--- a/src/cadet/cadet_api_list_tunnels.c
+++ b/src/cadet/cadet_api_list_tunnels.c
@@ -95,7 +95,7 @@ handle_get_tunnels (void *cls,
* Process a local reply about info on all tunnels, pass info to the user.
*
* @param cls a `struct GNUNET_CADET_ListTunnels *`
- * @param message Message itself.
+ * @param msg Message itself.
*/
static void
handle_get_tunnels_end (void *cls,
diff --git a/src/cadet/gnunet-cadet-profiler.c
b/src/cadet/gnunet-cadet-profiler.c
index e61053f94..b84337370 100644
--- a/src/cadet/gnunet-cadet-profiler.c
+++ b/src/cadet/gnunet-cadet-profiler.c
@@ -659,8 +659,6 @@ ping (void *cls)
/**
* @brief Reply with a pong to origin.
*
- * @param cls Closure (peer).
- * @param tc Task context.
*/
static void
pong (struct GNUNET_CADET_Channel *channel,
diff --git a/src/cadet/gnunet-service-cadet.c b/src/cadet/gnunet-service-cadet.c
index dd1f05807..07b580005 100644
--- a/src/cadet/gnunet-service-cadet.c
+++ b/src/cadet/gnunet-service-cadet.c
@@ -442,7 +442,7 @@ shutdown_task (void *cls)
* client @a cls opened port @a port. Bind them now.
*
* @param cls the `struct CadetClient`
- * @param h_port the hashed port
+ * @param port the hashed port
* @param value the `struct CadetChannel`
* @return #GNUNET_YES (iterate over all such channels)
*/
@@ -1226,7 +1226,6 @@ client_disconnect_cb (void *cls,
* Setup CADET internals.
*
* @param cls closure
- * @param server the initialized server
* @param c configuration to use
*/
static void
diff --git a/src/cadet/gnunet-service-cadet_channel.c
b/src/cadet/gnunet-service-cadet_channel.c
index f742ba4a7..78658c296 100644
--- a/src/cadet/gnunet-service-cadet_channel.c
+++ b/src/cadet/gnunet-service-cadet_channel.c
@@ -1157,7 +1157,7 @@ GCCH_handle_channel_open_ack (
* @param cls closure, to a flag where we indicate duplicate packets
* @param m1 a message of to sort
* @param m2 another message to sort
- * @return #GNUNET_YES if @e1 < @e2, otherwise #GNUNET_NO
+ * @return #GNUNET_YES if @a e1 < @a e2, otherwise #GNUNET_NO
*/
static int
is_before (void *cls,
@@ -1645,7 +1645,7 @@ GCCH_handle_remote_destroy (
* @param cls closure, to a flag where we indicate duplicate packets
* @param crm1 an element of to sort
* @param crm2 another element to sort
- * @return #GNUNET_YES if @e1 < @e2, otherwise #GNUNET_NO
+ * @return #GNUNET_YES if @a e1 < @a e2, otherwise #GNUNET_NO
*/
static int
cmp_crm_by_next_retry (void *cls,
diff --git a/src/cadet/gnunet-service-cadet_connection.c
b/src/cadet/gnunet-service-cadet_connection.c
index 66b67aa64..f01c1388e 100644
--- a/src/cadet/gnunet-service-cadet_connection.c
+++ b/src/cadet/gnunet-service-cadet_connection.c
@@ -431,9 +431,9 @@ GCC_ack_expected (const struct
GNUNET_CADET_ConnectionTunnelIdentifier *cid)
/**
* We observed an ACK for a message that was originally sent via
- * the connection identified by @a cti.
+ * the connection identified by @a cid.
*
- * @param cti connection identifier where we got an ACK for a message
+ * @param cid connection identifier where we got an ACK for a message
* that was originally sent via this connection (the ACK
* may have gotten back to us via a different connection).
*/
@@ -983,7 +983,7 @@ GCC_transmit (struct CadetConnection *cc, struct
GNUNET_MQ_Envelope *env)
* Obtain the path used by this connection.
*
* @param cc connection
- * @param off[out] set to the length of the path we use
+ * @param[out] off set to the length of the path we use
* @return path to @a cc
*/
struct CadetPeerPath *
diff --git a/src/cadet/gnunet-service-cadet_connection.h
b/src/cadet/gnunet-service-cadet_connection.h
index 53c0c1541..54c845b13 100644
--- a/src/cadet/gnunet-service-cadet_connection.h
+++ b/src/cadet/gnunet-service-cadet_connection.h
@@ -322,7 +322,7 @@ GCC_get_ct (struct CadetConnection *cc);
* Obtain the path used by this connection.
*
* @param cc connection
- * @param off[out] set to offset in this path where the connection @a cc ends
+ * @param[out] off set to offset in this path where the connection @a cc ends
* @return path to @a cc
*/
struct CadetPeerPath *
diff --git a/src/cadet/gnunet-service-cadet_core.c
b/src/cadet/gnunet-service-cadet_core.c
index bff7632da..68f7405c3 100644
--- a/src/cadet/gnunet-service-cadet_core.c
+++ b/src/cadet/gnunet-service-cadet_core.c
@@ -612,10 +612,10 @@ timeout_cb (void *cls)
* later if the connection ever goes down.
*
* @param cls the `struct RouteDirection`
- * @param available #GNUNET_YES if sending is now possible,
- * #GNUNET_NO if sending is no longer possible
- * #GNUNET_SYSERR if sending is no longer possible
- * and the last envelope was discarded
+ * @param ready #GNUNET_YES if sending is now possible,
+ * #GNUNET_NO if sending is no longer possible
+ * #GNUNET_SYSERR if sending is no longer possible
+ * and the last envelope was discarded
*/
static void
dir_ready_cb (void *cls, int ready)
diff --git a/src/cadet/gnunet-service-cadet_hello.c
b/src/cadet/gnunet-service-cadet_hello.c
index c7857032b..e1850d60a 100644
--- a/src/cadet/gnunet-service-cadet_hello.c
+++ b/src/cadet/gnunet-service-cadet_hello.c
@@ -57,7 +57,7 @@ static struct GNUNET_PEERINFO_NotifyContext *nc;
* Process each hello message received from peerinfo.
*
* @param cls Closure (unused).
- * @param peer Identity of the peer.
+ * @param id Identity of the peer.
* @param hello Hello of the peer.
* @param err_msg Error message.
*/
diff --git a/src/cadet/gnunet-service-cadet_paths.h
b/src/cadet/gnunet-service-cadet_paths.h
index defdd0df2..0f3b4dd1a 100644
--- a/src/cadet/gnunet-service-cadet_paths.h
+++ b/src/cadet/gnunet-service-cadet_paths.h
@@ -53,8 +53,8 @@ GCPP_try_path_from_dht (const struct GNUNET_DHT_PathElement
*get_path,
* We got an incoming connection, obtain the corresponding path.
*
* @param path_length number of segments on the @a path
- * @param path through the network, in reverse order
- * (we are at the end, at index @a path_length)
+ * @param pids path through the network, in reverse order
+ * (we are at the end, at index @a path_length)
* @return corresponding path object
*/
struct CadetPeerPath *
diff --git a/src/cadet/gnunet-service-cadet_peer.c
b/src/cadet/gnunet-service-cadet_peer.c
index 99669eb05..f2b508ae0 100644
--- a/src/cadet/gnunet-service-cadet_peer.c
+++ b/src/cadet/gnunet-service-cadet_peer.c
@@ -211,7 +211,7 @@ struct CadetPeer
/**
* Sum over all of the offsets of all of the paths in the @a path_heads DLLs.
- * Used to speed-up @GCP_get_desirability_of_path() calculation.
+ * Used to speed-up #GCP_get_desirability_of_path() calculation.
*/
unsigned int off_sum;
@@ -225,19 +225,13 @@ struct CadetPeer
unsigned int mqm_ready_counter;
/**
- * Current length of the @e path_heads and @path_tails arrays.
+ * Current length of the @e path_heads and @e path_tails arrays.
* The arrays should be grown as needed.
*/
unsigned int path_dll_length;
};
-/**
- * Get the static string for a peer ID.
- *
- * @param cp Peer.
- * @return Static string for it's ID.
- */
const char *
GCP_2s (const struct CadetPeer *cp)
{
diff --git a/src/cadet/gnunet-service-cadet_tunnels.c
b/src/cadet/gnunet-service-cadet_tunnels.c
index 9653fd3ec..c7e422926 100644
--- a/src/cadet/gnunet-service-cadet_tunnels.c
+++ b/src/cadet/gnunet-service-cadet_tunnels.c
@@ -169,7 +169,7 @@ struct CadetTunnelAxolotl
* 32-byte chain keys (used for forward-secrecy) for
* receiving messages. Updated for every message. If
* messages are skipped, the respective derived MKs
- * (and the current @HKr) are kept in the @e skipped_head DLL.
+ * (and the current @e HKr) are kept in the @e skipped_head DLL.
*/
struct GNUNET_CRYPTO_SymmetricSessionKey CKr;
@@ -674,7 +674,7 @@ new_ephemeral (struct CadetTunnelAxolotl *ax)
* @param size Size of @c plaintext.
* @param iv Initialization vector for the message.
* @param key Key to use.
- * @param hmac[out] Destination to store the HMAC.
+ * @param[out] hmac Destination to store the HMAC.
*/
static void
t_hmac (const void *plaintext,
@@ -890,7 +890,7 @@ t_ax_decrypt (struct CadetTunnelAxolotl *ax,
* Encrypt header with the axolotl header key.
*
* @param ax key material to use.
- * @param[in|out] msg Message whose header to encrypt.
+ * @param[in,out] msg Message whose header to encrypt.
*/
static void
t_h_encrypt (struct CadetTunnelAxolotl *ax,
@@ -1488,7 +1488,7 @@ cleanup_ax (struct CadetTunnelAxolotl *ax)
* Computes the new chain keys, and root keys, etc, and also checks
* whether this is a replay of the current chain.
*
- * @param[in|out] axolotl chain key state to recompute
+ * @param[in,out] ax chain key state to recompute
* @param pid peer identity of the other peer
* @param ephemeral_key ephemeral public key of the other peer
* @param ratchet_key senders next ephemeral public key
@@ -3487,15 +3487,6 @@ GCT_send (struct CadetTunnel *t,
}
-/**
- * Cancel a previously sent message while it's in the queue.
- *
- * ONLY can be called before the continuation given to the send
- * function is called. Once the continuation is called, the message is
- * no longer in the queue!
- *
- * @param tq Handle to the queue entry to cancel.
- */
void
GCT_send_cancel (struct CadetTunnelQueueEntry *tq)
{
diff --git a/src/cadet/gnunet-service-cadet_tunnels.h
b/src/cadet/gnunet-service-cadet_tunnels.h
index 018a3ec73..e893955a0 100644
--- a/src/cadet/gnunet-service-cadet_tunnels.h
+++ b/src/cadet/gnunet-service-cadet_tunnels.h
@@ -160,8 +160,8 @@ GCT_get_destination (struct CadetTunnel *t);
* Consider using the path @a p for the tunnel @a t.
* The tunnel destination is at offset @a off in path @a p.
*
- * @param cls our tunnel
- * @param path a path to our destination
+ * @param t our tunnel
+ * @param p a path to our destination
* @param off offset of the destination on path @a path
*/
void
diff --git a/src/consensus/plugin_block_consensus.c
b/src/consensus/plugin_block_consensus.c
index f30b9b0d7..241d8fc7b 100644
--- a/src/consensus/plugin_block_consensus.c
+++ b/src/consensus/plugin_block_consensus.c
@@ -52,7 +52,6 @@ struct BlockContext
* Function called to validate a query.
*
* @param cls closure
- * @param ctx block context
* @param type block type
* @param query original query (hash)
* @param xquery extrended query data (can be NULL, depending on type)
diff --git a/src/conversation/conversation_api.c
b/src/conversation/conversation_api.c
index 1984abdd6..2ede33586 100644
--- a/src/conversation/conversation_api.c
+++ b/src/conversation/conversation_api.c
@@ -300,7 +300,7 @@ find_caller (struct GNUNET_CONVERSATION_Phone *phone,
* We received a `struct ClientPhoneHangupMessage`.
*
* @param cls the `struct GNUNET_CONVERSATION_Phone *`
- * @param msg the message
+ * @param hang the message
*/
static void
handle_phone_hangup (void *cls,
diff --git a/src/conversation/conversation_api_call.c
b/src/conversation/conversation_api_call.c
index 2be7886fa..909b603ac 100644
--- a/src/conversation/conversation_api_call.c
+++ b/src/conversation/conversation_api_call.c
@@ -375,7 +375,7 @@ handle_call_hangup (void *cls,
* We received a `struct ClientAudioMessage`, check it is well-formed.
*
* @param cls the `struct GNUNET_CONVERSATION_Call`
- * @param msg the message
+ * @param am the message
* @return #GNUNET_OK (always well-formed)
*/
static int
@@ -393,7 +393,7 @@ check_call_audio (void *cls,
* We received a `struct ClientAudioMessage`
*
* @param cls the `struct GNUNET_CONVERSATION_Call`
- * @param msg the message
+ * @param am the message
*/
static void
handle_call_audio (void *cls,
diff --git a/src/core/core_api.c b/src/core/core_api.c
index 81118693d..2e0bb1785 100644
--- a/src/core/core_api.c
+++ b/src/core/core_api.c
@@ -158,7 +158,6 @@ reconnect (struct GNUNET_CORE_Handle *h);
* Task schedule to try to re-connect to core.
*
* @param cls the `struct GNUNET_CORE_Handle`
- * @param tc task context
*/
static void
reconnect_task (void *cls)
diff --git a/src/core/gnunet-service-core_kx.c
b/src/core/gnunet-service-core_kx.c
index c5992a824..b203f4902 100644
--- a/src/core/gnunet-service-core_kx.c
+++ b/src/core/gnunet-service-core_kx.c
@@ -488,7 +488,8 @@ derive_aes_key (const struct GNUNET_PeerIdentity *sender,
* @param iv initialization vector to use
* @param in ciphertext
* @param out plaintext
- * @param size size of @a in/@a out
+ * @param size size of @a in / @a out
+ *
* @return #GNUNET_OK on success
*/
static int
@@ -1888,12 +1889,6 @@ GSC_NEIGHBOURS_get_queue_length (const struct
GSC_KeyExchangeInfo *kxinfo)
}
-/**
- * Check if the given neighbour has excess bandwidth available.
- *
- * @param target neighbour to check
- * @return #GNUNET_YES if excess bandwidth is available, #GNUNET_NO if not
- */
int
GSC_NEIGHBOURS_check_excess_bandwidth (const struct GSC_KeyExchangeInfo
*kxinfo)
{
diff --git a/src/datacache/plugin_datacache_postgres.c
b/src/datacache/plugin_datacache_postgres.c
index 01b2372f1..df5fc4454 100644
--- a/src/datacache/plugin_datacache_postgres.c
+++ b/src/datacache/plugin_datacache_postgres.c
@@ -211,7 +211,7 @@ struct HandleResultContext
*
* @param cls closure of type `struct HandleResultContext`
* @param result the postgres result
- * @param num_result the number of results in @a result
+ * @param num_results the number of results in @a result
*/
static void
handle_results (void *cls,
@@ -433,7 +433,7 @@ struct ExtractResultContext
*
* @param cls closure with the `struct ExtractResultContext`
* @param result the postgres result
- * @param num_result the number of results in @a result
+ * @param num_results the number of results in @a result
*/
static void
extract_result_cb (void *cls,
diff --git a/src/datacache/plugin_datacache_sqlite.c
b/src/datacache/plugin_datacache_sqlite.c
index 0753d87ce..1c6f24a82 100644
--- a/src/datacache/plugin_datacache_sqlite.c
+++ b/src/datacache/plugin_datacache_sqlite.c
@@ -161,7 +161,7 @@ struct Plugin
* @brief Prepare a SQL statement
*
* @param dbh database handle
- * @param zsql SQL statement text
+ * @param zSql SQL statement text
* @param[out] ppStmt set to the prepared statement
* @return 0 on success
*/
diff --git a/src/datastore/datastore_api.c b/src/datastore/datastore_api.c
index 4b4a76eea..4d27efb4e 100644
--- a/src/datastore/datastore_api.c
+++ b/src/datastore/datastore_api.c
@@ -278,7 +278,7 @@ free_queue_entry (struct GNUNET_DATASTORE_QueueEntry *qe)
/**
* Task that logs an error after some time.
*
- * @param qe `struct GNUNET_DATASTORE_QueueEntry` about which the error is
+ * @param cls `struct GNUNET_DATASTORE_QueueEntry` about which the error is
*/
static void
delay_warning (void *cls)
diff --git a/src/datastore/gnunet-service-datastore.c
b/src/datastore/gnunet-service-datastore.c
index 498a7b3e6..f45e71ee9 100644
--- a/src/datastore/gnunet-service-datastore.c
+++ b/src/datastore/gnunet-service-datastore.c
@@ -560,7 +560,7 @@ transmit_item (void *cls,
* Handle RESERVE-message.
*
* @param cls identification of the client
- * @param message the actual message
+ * @param msg the actual message
*/
static void
handle_reserve (void *cls, const struct ReserveMessage *msg)
@@ -644,7 +644,7 @@ handle_reserve (void *cls, const struct ReserveMessage *msg)
* Handle RELEASE_RESERVE-message.
*
* @param cls identification of the client
- * @param message the actual message
+ * @param msg the actual message
*/
static void
handle_release_reserve (void *cls, const struct ReleaseReserveMessage *msg)
@@ -768,7 +768,7 @@ put_continuation (void *cls,
* Verify PUT-message.
*
* @param cls identification of the client
- * @param message the actual message
+ * @param dm the actual message
* @return #GNUNET_OK if @a dm is well-formed
*/
static int
@@ -787,7 +787,7 @@ check_put (void *cls, const struct DataMessage *dm)
* Handle PUT-message.
*
* @param cls identification of the client
- * @param message the actual message
+ * @param dm the actual message
*/
static void
handle_put (void *cls, const struct DataMessage *dm)
@@ -949,7 +949,7 @@ handle_get_replication (void *cls, const struct
GNUNET_MessageHeader *message)
* Handle GET_ZERO_ANONYMITY-message.
*
* @param cls client identification of the client
- * @param message the actual message
+ * @param msg the actual message
*/
static void
handle_get_zero_anonymity (void *cls, const struct GetZeroAnonymityMessage
*msg)
@@ -1028,7 +1028,7 @@ remove_continuation (void *cls,
* Verify REMOVE-message.
*
* @param cls identification of the client
- * @param message the actual message
+ * @param dm the actual message
* @return #GNUNET_OK if @a dm is well-formed
*/
static int
@@ -1047,8 +1047,7 @@ check_remove (void *cls, const struct DataMessage *dm)
* Handle REMOVE-message.
*
* @param cls closure
- * @param client identification of the client
- * @param message the actual message
+ * @param dm the actual message
*/
static void
handle_remove (void *cls, const struct DataMessage *dm)
diff --git a/src/datastore/plugin_datastore_postgres.c
b/src/datastore/plugin_datastore_postgres.c
index 27e8b7072..e49564dd9 100644
--- a/src/datastore/plugin_datastore_postgres.c
+++ b/src/datastore/plugin_datastore_postgres.c
@@ -760,7 +760,7 @@ struct ProcessKeysContext
*
* @param cls closure with a `struct ProcessKeysContext`
* @param result the postgres result
- * @param num_result the number of results in @a result
+ * @param num_results the number of results in @a result
*/
static void
process_keys (void *cls,
diff --git a/src/dht/dhtu_testbed_connect.sh b/src/dht/dhtu_testbed_connect.sh
index daf6f34cf..b0ba474bf 100755
--- a/src/dht/dhtu_testbed_connect.sh
+++ b/src/dht/dhtu_testbed_connect.sh
@@ -3,17 +3,19 @@
set -eu
+GNUNET_TMP="$(gnunet-config -f -s PATHS -o GNUNET_TMP)"
+
# Helper script for dhtu_testbed_deploy.sh.
# Do not invoke directly.
n=$1
-CFG="/tmp/deployment/${n}.conf"
+CFG="$GNUNET_TMP/deployment/${n}.conf"
HELLO=`gnunet-dht-hello -c $CFG`
# Create dense topology:
#for OFF in `seq 1 $MAX`
#do
-# TCFG="/tmp/deployment/${OFF}.conf"
+# TCFG="$GNUNET_TMP/deployment/${OFF}.conf"
# gnunet-dht-hello -c $TCFG $HELLO
#done
#exit 0
@@ -26,7 +28,7 @@ do
for M in `seq $R $R $END`
do
OFF=`expr \( $n + $M \) % $MAX`
- TCFG="/tmp/deployment/${OFF}.conf"
+ TCFG="$GNUNET_TMP/deployment/${OFF}.conf"
gnunet-dht-hello -c $TCFG $HELLO
done
R=`expr $R + 1`
diff --git a/src/dht/dhtu_testbed_deploy.conf b/src/dht/dhtu_testbed_deploy.conf
index 59d69894a..efabd97d3 100644
--- a/src/dht/dhtu_testbed_deploy.conf
+++ b/src/dht/dhtu_testbed_deploy.conf
@@ -4,7 +4,7 @@
# with peers using the IP underlay.
[paths]
-GNUNET_DATA_HOME=/tmp/%N%
+GNUNET_DATA_HOME=$GNUNET_TMP/%N%
[dht]
UNIXPATH = $GNUNET_RUNTIME_DIR/gnunet-service-dht-%N%.sock
diff --git a/src/dht/dhtu_testbed_deploy.sh b/src/dht/dhtu_testbed_deploy.sh
index 648da7313..e8ac8d5d1 100755
--- a/src/dht/dhtu_testbed_deploy.sh
+++ b/src/dht/dhtu_testbed_deploy.sh
@@ -1,6 +1,9 @@
#!/bin/bash
# This file is in the public domain.
+# Getting location for temporary files
+GNUNET_TMP="$(gnunet-config -f -s PATHS -o GNUNET_TMP)"
+
# We will use UDP ports above this number.
MINPORT=10000
@@ -54,13 +57,13 @@ MAX=`expr $1 - 1`
export GNUNET_FORCE_LOG="dht*;;;;DEBUG"
echo -n "Starting $1 peers "
-mkdir -p /tmp/deployment
+mkdir -p "$GNUNET_TMP/deployment"
for n in `seq 0 $MAX`
do
PORT=`expr $MINPORT + $n`
- CFG="/tmp/deployment/${n}.conf"
+ CFG="$GNUNET_TMP/deployment/${n}.conf"
cat dhtu_testbed_deploy.conf | sed -e "s/%N%/$PORT/" > $CFG
- gnunet-service-dht -c $CFG -L DEBUG &> /tmp/deployment/$n.log &
+ gnunet-service-dht -c $CFG -L DEBUG &> "$GNUNET_TMP/deployment/$n.log" &
echo -n "."
done
@@ -85,7 +88,7 @@ fi
echo ""
echo "Network ready. Press ENTER to terminate the testbed!"
-echo "Interact with peers using '-c /tmp/deployment/\$N.conf'"
+echo "Interact with peers using '-c $GNUNET_TMP/deployment/\$N.conf'"
read
diff --git a/src/dht/gnunet-service-dht.h b/src/dht/gnunet-service-dht.h
index f7c2fed76..dcc972fc2 100644
--- a/src/dht/gnunet-service-dht.h
+++ b/src/dht/gnunet-service-dht.h
@@ -144,7 +144,6 @@ GDS_u_hold (struct GDS_Underlay *u,
*
* @param bd block details
* @param query_hash hash of the original query, might not match key in @a bd
- * @param trunc_peer peer at which the path was truncated, or NULL if path
starts at the origin
* @param get_path_length number of entries in @a get_path
* @param get_path path the reply has taken
* @return true on success, false on failures
diff --git a/src/dht/gnunet-service-dht_clients.c
b/src/dht/gnunet-service-dht_clients.c
index b4d139eec..19b464e63 100644
--- a/src/dht/gnunet-service-dht_clients.c
+++ b/src/dht/gnunet-service-dht_clients.c
@@ -584,7 +584,7 @@ handle_local_result (void *cls,
* Check DHT GET messages from the client.
*
* @param cls the client we received this message from
- * @param message the actual message received
+ * @param get the actual message received
* @return #GNUNET_OK (always)
*/
static enum GNUNET_GenericReturnValue
@@ -602,7 +602,7 @@ check_dht_local_get (void *cls,
* Handler for DHT GET messages from the client.
*
* @param cls the client we received this message from
- * @param message the actual message received
+ * @param get the actual message received
*/
static void
handle_dht_local_get (void *cls,
@@ -720,7 +720,7 @@ find_by_unique_id (void *cls,
* Check "GET result seen" messages from the client.
*
* @param cls the client we received this message from
- * @param message the actual message received
+ * @param seen the actual message received
* @return #GNUNET_OK if @a seen is well-formed
*/
static enum GNUNET_GenericReturnValue
@@ -746,7 +746,7 @@ check_dht_local_get_result_seen (
* Handler for "GET result seen" messages from the client.
*
* @param cls the client we received this message from
- * @param message the actual message received
+ * @param seen the actual message received
*/
static void
handle_dht_local_get_result_seen (
@@ -835,7 +835,7 @@ remove_by_unique_id (void *cls,
* depending on message type (if processed locally)
*
* @param cls client we received this message from
- * @param message the actual message received
+ * @param dht_stop_msg the actual message received
*
*/
static void
@@ -1603,8 +1603,6 @@ GDS_CLIENTS_process_put (const struct
GNUNET_DATACACHE_Block *bd,
/**
* Initialize client subsystem.
- *
- * @param server the initialized server
*/
static void
GDS_CLIENTS_init (void)
diff --git a/src/dht/gnunet-service-dht_neighbours.c
b/src/dht/gnunet-service-dht_neighbours.c
index 65b3014fd..9d1dff8a6 100644
--- a/src/dht/gnunet-service-dht_neighbours.c
+++ b/src/dht/gnunet-service-dht_neighbours.c
@@ -529,7 +529,6 @@ do_send (struct PeerInfo *pi,
* Sign that we are routing a message from @a pred to @a succ.
* (So the route is $PRED->us->$SUCC).
*
- * @param key key of the data (not necessarily the query hash)
* @param data payload (the block)
* @param data_size number of bytes in @a data
* @param exp_time expiration time of @a data
@@ -1890,7 +1889,7 @@ GDS_NEIGHBOURS_handle_reply (struct PeerInfo *pi,
* Check validity of a p2p put request.
*
* @param cls closure with the `struct PeerInfo` of the sender
- * @param message message
+ * @param put message
* @return #GNUNET_OK if the message is valid
*/
static enum GNUNET_GenericReturnValue
@@ -1933,7 +1932,7 @@ check_dht_p2p_put (void *cls,
* Core handler for p2p put requests.
*
* @param cls closure with the `struct Target` of the sender
- * @param message message
+ * @param put message
*/
static void
handle_dht_p2p_put (void *cls,
@@ -2503,7 +2502,7 @@ process_reply_with_path (const struct
GNUNET_DATACACHE_Block *bd,
* Check validity of p2p result message.
*
* @param cls closure
- * @param message message
+ * @param prm message
* @return #GNUNET_YES if the message is well-formed
*/
static enum GNUNET_GenericReturnValue
@@ -2542,7 +2541,7 @@ check_dht_p2p_result (void *cls,
* Core handler for p2p result messages.
*
* @param cls closure
- * @param message message
+ * @param prm message
*/
static void
handle_dht_p2p_result (void *cls,
@@ -2754,7 +2753,7 @@ check_dht_p2p_hello (void *cls,
* Core handler for p2p HELLO messages.
*
* @param cls closure
- * @param message message
+ * @param hello message
*/
static void
handle_dht_p2p_hello (void *cls,
diff --git a/src/dht/gnunet-service-dht_neighbours.h
b/src/dht/gnunet-service-dht_neighbours.h
index 96db21b9b..85e18d46d 100644
--- a/src/dht/gnunet-service-dht_neighbours.h
+++ b/src/dht/gnunet-service-dht_neighbours.h
@@ -101,7 +101,6 @@ GDS_NEIGHBOURS_handle_get (enum GNUNET_BLOCK_Type type,
* forwarding to local clients.
*
* @param pi neighbour that should receive the block
- * @param type type of the block
* @param bd details about the reply
* @param query_hash query that was used for the request
* @param get_path_length number of entries in put_path
@@ -150,7 +149,7 @@ GDS_try_connect (void *cls,
* @param cls the closure, must be a `struct GDS_Underlay`
* @param target handle to the target,
* pointer will remain valid until @e disconnect_cb is called
- * @para pid peer identity,
+ * @param pid peer identity,
* pointer will remain valid until @e disconnect_cb is called
* @param[out] ctx storage space for DHT to use in association with this target
*/
@@ -175,7 +174,6 @@ GDS_u_disconnect (void *ctx);
* Function to call when we receive a message.
*
* @param cls the closure
- * @param origin where the message originated from
* @param[in,out] tctx ctx of target address where we received the message from
* @param[in,out] sctx ctx of our own source address at which we received the
message
* @param message the message we received @param message_size number of
diff --git a/src/dht/gnunet-service-dht_routing.c
b/src/dht/gnunet-service-dht_routing.c
index 8f87751bb..d81a2b2e1 100644
--- a/src/dht/gnunet-service-dht_routing.c
+++ b/src/dht/gnunet-service-dht_routing.c
@@ -341,8 +341,6 @@ try_combine_recent (void *cls,
* @param key key for the content
* @param xquery extended query
* @param xquery_size number of bytes in @a xquery
- * @param reply_bf bloomfilter to filter duplicates
- * @param reply_bf_mutator mutator for @a reply_bf
*/
void
GDS_ROUTING_add (const struct GNUNET_PeerIdentity *sender,
diff --git a/src/dht/test_dht_tools.sh b/src/dht/test_dht_tools.sh
index 56cc99e15..462866f87 100755
--- a/src/dht/test_dht_tools.sh
+++ b/src/dht/test_dht_tools.sh
@@ -1,8 +1,9 @@
#!/bin/sh
# This file is in the public domain.
-out=`mktemp /tmp/test-gnunet-dht-logXXXXXXXX`
-tempcfg=`mktemp /tmp/test-dht-tools.XXXXXXXX`
+GNUNET_TMP="$(gnunet-config -f -s PATHS -o GNUNET_TMP)"
+out=`mktemp $GNUNET_TMP/test-gnunet-dht-logXXXXXXXX`
+tempcfg=`mktemp $GNUNET_TMP/test-dht-tools.XXXXXXXX`
checkout="check.out"
armexe="gnunet-arm -c $tempcfg "
putexe="gnunet-dht-put -c $tempcfg "
diff --git a/src/dhtu/plugin_dhtu_gnunet.c b/src/dhtu/plugin_dhtu_gnunet.c
index b072be2be..b0cee7e01 100644
--- a/src/dhtu/plugin_dhtu_gnunet.c
+++ b/src/dhtu/plugin_dhtu_gnunet.c
@@ -424,7 +424,7 @@ core_disconnect_cb (void *cls,
* @param cls a `struct Plugin`
* @param peer id of the peer, NULL for last call
* @param hello hello message for the peer (can be NULL)
- * @param error message
+ * @param err_msg message
*/
static void
peerinfo_cb (void *cls,
diff --git a/src/dhtu/plugin_dhtu_ip.c b/src/dhtu/plugin_dhtu_ip.c
index 612d2c119..06d0f0f60 100644
--- a/src/dhtu/plugin_dhtu_ip.c
+++ b/src/dhtu/plugin_dhtu_ip.c
@@ -303,7 +303,6 @@ create_target (struct Plugin *plugin,
*
* @param plugin the plugin handle
* @param pid presumed identity of the target
- * @param src source target is from, or NULL if unknown
* @param addr socket address to find
* @param addrlen number of bytes in @a addr
* @return matching target object
diff --git a/src/dns/dns_api.c b/src/dns/dns_api.c
index 89f03bf63..b0bbb894f 100644
--- a/src/dns/dns_api.c
+++ b/src/dns/dns_api.c
@@ -102,7 +102,6 @@ struct GNUNET_DNS_Handle
* Reconnect to the DNS service.
*
* @param cls handle with the connection to connect
- * @param tc scheduler context (unused)
*/
static void
reconnect (void *cls);
@@ -171,7 +170,7 @@ check_request (void *cls,
* handle it.
*
* @param cls the `struct GNUNET_DNS_Handle *`
- * @param msg message from the service (request)
+ * @param req message from the service (request)
*/
static void
handle_request (void *cls,
diff --git a/src/dns/plugin_block_dns.c b/src/dns/plugin_block_dns.c
index 0531a8a5f..1bbd7f750 100644
--- a/src/dns/plugin_block_dns.c
+++ b/src/dns/plugin_block_dns.c
@@ -90,7 +90,6 @@ block_plugin_dns_create_group (void *cls,
* Function called to validate a query.
*
* @param cls closure
- * @param ctx block context
* @param type block type
* @param query original query (hash)
* @param xquery extrended query data (can be NULL, depending on type)
diff --git a/src/exit/gnunet-daemon-exit.c b/src/exit/gnunet-daemon-exit.c
index f4a17e32a..425f7c816 100644
--- a/src/exit/gnunet-daemon-exit.c
+++ b/src/exit/gnunet-daemon-exit.c
@@ -1821,7 +1821,7 @@ handle_tcp_remote (void *cls,
* connection via this peer.
*
* @param cls our `struct ChannelState *`
- * @param message the actual message
+ * @param data the actual message
* @return #GNUNET_OK to keep the connection open,
* #GNUNET_SYSERR to close it (signal serious error)
*/
@@ -1861,7 +1861,7 @@ check_tcp_data (void *cls,
* connection via this peer.
*
* @param cls our `struct ChannelState *`
- * @param message the actual message
+ * @param data the actual message
*/
static void
handle_tcp_data (void *cls,
@@ -3231,7 +3231,6 @@ free_iterate (void *cls,
* service process alive by virtue of being scheduled.
*
* @param cls NULL
- * @param tc scheduler context
*/
static void
dummy_task (void *cls)
diff --git a/src/fs/fs_dirmetascan.c b/src/fs/fs_dirmetascan.c
index cb50182f9..8dd216324 100644
--- a/src/fs/fs_dirmetascan.c
+++ b/src/fs/fs_dirmetascan.c
@@ -112,14 +112,6 @@ GNUNET_FS_directory_scan_abort (struct
GNUNET_FS_DirScanner *ds)
}
-/**
- * Obtain the result of the scan after the scan has signalled
- * completion. Must not be called prior to completion. The 'ds' is
- * freed as part of this call.
- *
- * @param ds directory scanner structure
- * @return the results of the scan (a directory tree)
- */
struct GNUNET_FS_ShareTreeItem *
GNUNET_FS_directory_scan_get_result (struct GNUNET_FS_DirScanner *ds)
{
diff --git a/src/fs/fs_download.c b/src/fs/fs_download.c
index e0ad8cd1d..102b297c1 100644
--- a/src/fs/fs_download.c
+++ b/src/fs/fs_download.c
@@ -1422,7 +1422,6 @@ try_reconnect (struct GNUNET_FS_DownloadContext *dc)
* We're allowed to ask the FS service for our blocks. Start the download.
*
* @param cls the 'struct GNUNET_FS_DownloadContext'
- * @param mq handle to use for communication with FS (we must destroy it!)
*/
static void
activate_fs_download (void *cls)
@@ -2096,36 +2095,6 @@ create_download_context (struct GNUNET_FS_Handle *h,
}
-/**
- * Download parts of a file. Note that this will store
- * the blocks at the respective offset in the given file. Also, the
- * download is still using the blocking of the underlying FS
- * encoding. As a result, the download may *write* outside of the
- * given boundaries (if offset and length do not match the 32k FS
- * block boundaries). <p>
- *
- * This function should be used to focus a download towards a
- * particular portion of the file (optimization), not to strictly
- * limit the download to exactly those bytes.
- *
- * @param h handle to the file sharing subsystem
- * @param uri the URI of the file (determines what to download); CHK or LOC URI
- * @param meta known metadata for the file (can be NULL)
- * @param filename where to store the file, maybe NULL (then no file is
- * created on disk and data must be grabbed from the callbacks)
- * @param tempname where to store temporary file data, not used if filename is
non-NULL;
- * can be NULL (in which case we will pick a name if needed); the
temporary file
- * may already exist, in which case we will try to use the data that is
there and
- * if it is not what is desired, will overwrite it
- * @param offset at what offset should we start the download (typically 0)
- * @param length how many bytes should be downloaded starting at offset
- * @param anonymity anonymity level to use for the download
- * @param options various options
- * @param cctx initial value for the client context for this download
- * @param parent parent download to associate this download with (use NULL
- * for top-level downloads; useful for manually-triggered recursive
downloads)
- * @return context that can be used to control this download
- */
struct GNUNET_FS_DownloadContext *
GNUNET_FS_download_start (struct GNUNET_FS_Handle *h,
const struct GNUNET_FS_Uri *uri,
@@ -2163,40 +2132,6 @@ GNUNET_FS_download_start (struct GNUNET_FS_Handle *h,
}
-/**
- * Download parts of a file based on a search result. The download
- * will be associated with the search result (and the association
- * will be preserved when serializing/deserializing the state).
- * If the search is stopped, the download will not be aborted but
- * be 'promoted' to a stand-alone download.
- *
- * As with the other download function, this will store
- * the blocks at the respective offset in the given file. Also, the
- * download is still using the blocking of the underlying FS
- * encoding. As a result, the download may *write* outside of the
- * given boundaries (if offset and length do not match the 32k FS
- * block boundaries). <p>
- *
- * The given range can be used to focus a download towards a
- * particular portion of the file (optimization), not to strictly
- * limit the download to exactly those bytes.
- *
- * @param h handle to the file sharing subsystem
- * @param sr the search result to use for the download (determines uri and
- * meta data and associations)
- * @param filename where to store the file, maybe NULL (then no file is
- * created on disk and data must be grabbed from the callbacks)
- * @param tempname where to store temporary file data, not used if filename is
non-NULL;
- * can be NULL (in which case we will pick a name if needed); the
temporary file
- * may already exist, in which case we will try to use the data that is
there and
- * if it is not what is desired, will overwrite it
- * @param offset at what offset should we start the download (typically 0)
- * @param length how many bytes should be downloaded starting at offset
- * @param anonymity anonymity level to use for the download
- * @param options various download options
- * @param cctx initial value for the client context for this download
- * @return context that can be used to control this download
- */
struct GNUNET_FS_DownloadContext *
GNUNET_FS_download_start_from_search (struct GNUNET_FS_Handle *h,
struct GNUNET_FS_SearchResult *sr,
diff --git a/src/fs/fs_file_information.c b/src/fs/fs_file_information.c
index c5faa14d4..dc5db9d3f 100644
--- a/src/fs/fs_file_information.c
+++ b/src/fs/fs_file_information.c
@@ -83,20 +83,6 @@ GNUNET_FS_file_information_set_filename (struct
GNUNET_FS_FileInformation *s,
}
-/**
- * Create an entry for a file in a publish-structure.
- *
- * @param h handle to the file sharing subsystem
- * @param client_info initial value for the client-info value for this entry
- * @param filename name of the file or directory to publish
- * @param keywords under which keywords should this file be available
- * directly; can be NULL
- * @param meta metadata for the file
- * @param do_index #GNUNET_YES for index, #GNUNET_NO for insertion,
- * #GNUNET_SYSERR for simulation
- * @param bo block options
- * @return publish structure entry for the file
- */
struct GNUNET_FS_FileInformation *
GNUNET_FS_file_information_create_from_file (
struct GNUNET_FS_Handle *h,
@@ -157,22 +143,6 @@ GNUNET_FS_file_information_create_from_file (
}
-/**
- * Create an entry for a file in a publish-structure.
- *
- * @param h handle to the file sharing subsystem
- * @param client_info initial value for the client-info value for this entry
- * @param length length of the file
- * @param data data for the file (should not be used afterwards by
- * the caller; callee will "free")
- * @param keywords under which keywords should this file be available
- * directly; can be NULL
- * @param meta metadata for the file
- * @param do_index GNUNET_YES for index, GNUNET_NO for insertion,
- * GNUNET_SYSERR for simulation
- * @param bo block options
- * @return publish structure entry for the file
- */
struct GNUNET_FS_FileInformation *
GNUNET_FS_file_information_create_from_data (
struct GNUNET_FS_Handle *h,
@@ -202,22 +172,6 @@ GNUNET_FS_file_information_create_from_data (
}
-/**
- * Create an entry for a file in a publish-structure.
- *
- * @param h handle to the file sharing subsystem
- * @param client_info initial value for the client-info value for this entry
- * @param length length of the file
- * @param reader function that can be used to obtain the data for the file
- * @param reader_cls closure for "reader"
- * @param keywords under which keywords should this file be available
- * directly; can be NULL
- * @param meta metadata for the file
- * @param do_index #GNUNET_YES for index, #GNUNET_NO for insertion,
- * #GNUNET_SYSERR for simulation
- * @param bo block options
- * @return publish structure entry for the file
- */
struct GNUNET_FS_FileInformation *
GNUNET_FS_file_information_create_from_reader (
struct GNUNET_FS_Handle *h,
@@ -267,18 +221,6 @@ GNUNET_FS_file_information_is_directory (
}
-/**
- * Create an entry for an empty directory in a publish-structure.
- *
- * @param h handle to the file sharing subsystem
- * @param client_info initial value for the client-info value for this entry
- * @param meta metadata for the directory
- * @param keywords under which keywords should this directory be available
- * directly; can be NULL
- * @param bo block options
- * @param filename name of the directory; can be NULL
- * @return publish structure entry for the directory , NULL on error
- */
struct GNUNET_FS_FileInformation *
GNUNET_FS_file_information_create_empty_directory (
struct GNUNET_FS_Handle *h,
@@ -303,17 +245,6 @@ GNUNET_FS_file_information_create_empty_directory (
}
-/**
- * Add an entry to a directory in a publish-structure. Clients
- * should never modify publish structures that were passed to
- * #GNUNET_FS_publish_start already.
- *
- * @param dir the directory
- * @param ent the entry to add; the entry must not have been
- * added to any other directory at this point and
- * must not include @a dir in its structure
- * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
- */
int
GNUNET_FS_file_information_add (struct GNUNET_FS_FileInformation *dir,
struct GNUNET_FS_FileInformation *ent)
diff --git a/src/fs/fs_list_indexed.c b/src/fs/fs_list_indexed.c
index 0e16fb01b..6a2ddd93c 100644
--- a/src/fs/fs_list_indexed.c
+++ b/src/fs/fs_list_indexed.c
@@ -155,14 +155,6 @@ mq_error_handler (void *cls,
}
-/**
- * Iterate over all indexed files.
- *
- * @param h handle to the file sharing subsystem
- * @param iterator function to call on each indexed file
- * @param iterator_cls closure for iterator
- * @return NULL on error ('iter' is not called)
- */
struct GNUNET_FS_GetIndexedContext *
GNUNET_FS_get_indexed_files (struct GNUNET_FS_Handle *h,
GNUNET_FS_IndexedFileProcessor iterator,
diff --git a/src/fs/fs_namespace.c b/src/fs/fs_namespace.c
index 155486be5..bc94dd1fc 100644
--- a/src/fs/fs_namespace.c
+++ b/src/fs/fs_namespace.c
@@ -423,21 +423,6 @@ sks_publish_cont (void *cls, const char *msg)
}
-/**
- * Publish an SBlock on GNUnet.
- *
- * @param h handle to the file sharing subsystem
- * @param ns namespace to publish in
- * @param identifier identifier to use
- * @param update update identifier to use
- * @param meta metadata to use
- * @param uri URI to refer to in the SBlock
- * @param bo block options
- * @param options publication options
- * @param cont continuation
- * @param cont_cls closure for cont
- * @return NULL on error ('cont' will still be called)
- */
struct GNUNET_FS_PublishSksContext *
GNUNET_FS_publish_sks (struct GNUNET_FS_Handle *h,
const struct GNUNET_CRYPTO_EcdsaPrivateKey *ns,
diff --git a/src/fs/fs_search.c b/src/fs/fs_search.c
index 3f3d30146..5538b7838 100644
--- a/src/fs/fs_search.c
+++ b/src/fs/fs_search.c
@@ -927,7 +927,7 @@ try_reconnect (struct GNUNET_FS_SearchContext *sc);
* We check a result message from the service.
*
* @param cls closure
- * @param msg result message received
+ * @param cm result message received
*/
static int
check_result (void *cls,
@@ -942,7 +942,7 @@ check_result (void *cls,
* We process a search result from the service.
*
* @param cls closure
- * @param msg result message received
+ * @param cm result message received
*/
static void
handle_result (void *cls,
diff --git a/src/fs/fs_test_lib.c b/src/fs/fs_test_lib.c
index 94bf469f7..f80a2859c 100644
--- a/src/fs/fs_test_lib.c
+++ b/src/fs/fs_test_lib.c
@@ -177,7 +177,6 @@ struct TestDownloadOperation
* Task scheduled to report on the completion of our publish operation.
*
* @param cls the publish operation context
- * @param tc scheduler context (unused)
*/
static void
report_uri (void *cls)
diff --git a/src/fs/fs_uri.c b/src/fs/fs_uri.c
index 2d5566b54..cdea8b72d 100644
--- a/src/fs/fs_uri.c
+++ b/src/fs/fs_uri.c
@@ -91,14 +91,6 @@
#include <unistdio.h>
-/**
- * Get a unique key from a URI. This is for putting URIs
- * into HashMaps. The key may change between FS implementations.
- *
- * @param uri uri to convert to a unique key
- * @param key where to store the unique key
- * @return #GNUNET_OK on success
- */
int
GNUNET_FS_uri_to_key (const struct GNUNET_FS_Uri *uri,
struct GNUNET_HashCode *key)
@@ -723,15 +715,6 @@ GNUNET_FS_uri_ksk_get_keyword_count (const struct
GNUNET_FS_Uri *uri)
}
-/**
- * Iterate over all keywords in this keyword URI.
- *
- * @param uri ksk uri to get the keywords from
- * @param iterator function to call on each keyword
- * @param iterator_cls closure for iterator
- * @return -1 if this is not a keyword URI, otherwise number of
- * keywords iterated over until iterator aborted
- */
int
GNUNET_FS_uri_ksk_get_keywords (const struct GNUNET_FS_Uri *uri,
GNUNET_FS_KeywordIterator iterator,
diff --git a/src/fs/gnunet-service-fs.c b/src/fs/gnunet-service-fs.c
index c22a5b5a9..7da92ed44 100644
--- a/src/fs/gnunet-service-fs.c
+++ b/src/fs/gnunet-service-fs.c
@@ -603,7 +603,7 @@ update_latencies (void *cls,
* Check P2P "PUT" message.
*
* @param cls closure with the `struct GSF_ConnectedPeer`
- * @param message the actual message
+ * @param put the actual message
* @return #GNUNET_OK to keep the connection open,
* #GNUNET_SYSERR to close it (signal serious error)
*/
@@ -1063,7 +1063,7 @@ hash_for_index_val (void *cls,
* Handle INDEX_START-message.
*
* @param cls identification of the client
- * @param message the actual message
+ * @param ism the actual message
*/
static void
handle_client_index_start (void *cls,
@@ -1144,7 +1144,7 @@ handle_client_index_list_get (void *cls,
* Handle UNINDEX-message.
*
* @param cls identification of the client
- * @param message the actual message
+ * @param um the actual message
*/
static void
handle_client_unindex (void *cls,
diff --git a/src/fs/gnunet-service-fs_cadet_server.c
b/src/fs/gnunet-service-fs_cadet_server.c
index 395842ebb..8bfe91cf0 100644
--- a/src/fs/gnunet-service-fs_cadet_server.c
+++ b/src/fs/gnunet-service-fs_cadet_server.c
@@ -415,7 +415,6 @@ connect_cb (void *cls,
*
* @param cls our `struct CadetClient`
* @param channel channel of the disconnecting client
- * @param channel_ctx
*/
static void
disconnect_cb (void *cls,
diff --git a/src/fs/gnunet-service-fs_cp.c b/src/fs/gnunet-service-fs_cp.c
index 96b21783c..29e4c5910 100644
--- a/src/fs/gnunet-service-fs_cp.c
+++ b/src/fs/gnunet-service-fs_cp.c
@@ -1342,8 +1342,6 @@ handle_p2p_get (void *cls,
* @param cp target peer
* @param is_query is this a query (#GNUNET_YES) or content (#GNUNET_NO) or
neither (#GNUNET_SYSERR)
* @param priority how important is this request?
- * @param timeout when does this request timeout
- * @param size number of bytes we would like to send to the peer
* @param env message to send
*/
void
diff --git a/src/fs/gnunet-service-fs_push.c b/src/fs/gnunet-service-fs_push.c
index 80c2c00e6..92dbba8e6 100644
--- a/src/fs/gnunet-service-fs_push.c
+++ b/src/fs/gnunet-service-fs_push.c
@@ -210,7 +210,7 @@ find_content (void *cls);
/**
* Send the given block to the given peer.
*
- * @param peer target peer
+ * @param mrp target peer
* @param block the block
* @return #GNUNET_YES if the block was deleted (!)
*/
diff --git a/src/fs/plugin_block_fs.c b/src/fs/plugin_block_fs.c
index 18aa289ef..11677a6b2 100644
--- a/src/fs/plugin_block_fs.c
+++ b/src/fs/plugin_block_fs.c
@@ -158,10 +158,9 @@ block_plugin_fs_get_key (void *cls,
* Function called to validate a query.
*
* @param cls closure
- * @param ctx block context
* @param type block type
* @param query original query (hash)
- * @param xquery extrended query data (can be NULL, depending on type)
+ * @param xquery extended query data (can be NULL, depending on type)
* @param xquery_size number of bytes in @a xquery
* @return #GNUNET_OK if the query is fine, #GNUNET_NO if not
*/
diff --git a/src/gns/gns_tld_api.c b/src/gns/gns_tld_api.c
index 1b711cf40..c88ce776e 100644
--- a/src/gns/gns_tld_api.c
+++ b/src/gns/gns_tld_api.c
@@ -186,7 +186,7 @@ lookup_with_public_key (struct
GNUNET_GNS_LookupWithTldRequest *ltr,
* @param cls a `struct GNUNET_GNS_LookupWithTldRequest *`
* @param ego ego handle, NULL at the end of the iteration
* @param ctx context we could store data to associate with @e ego
- * @param name name of the ego
+ * @param ego_name name of the ego
*/
static void
identity_zone_cb (void *cls,
diff --git a/src/gns/gnunet-gns-proxy.c b/src/gns/gnunet-gns-proxy.c
index a834c5c19..312fde293 100644
--- a/src/gns/gnunet-gns-proxy.c
+++ b/src/gns/gnunet-gns-proxy.c
@@ -3429,7 +3429,6 @@ do_s5r_read (void *cls)
* Accept new incoming connections
*
* @param cls the closure with the lsock4 or lsock6
- * @param tc the scheduler context
*/
static void
do_accept (void *cls)
diff --git a/src/gns/gnunet-service-gns.c b/src/gns/gnunet-service-gns.c
index b28236fed..6a11ec2ce 100644
--- a/src/gns/gnunet-service-gns.c
+++ b/src/gns/gnunet-service-gns.c
@@ -412,8 +412,7 @@ check_lookup (void *cls,
* Handle lookup requests from client
*
* @param cls the closure
- * @param client the client
- * @param message the message
+ * @param sh_msg the message
*/
static void
handle_lookup (void *cls,
diff --git a/src/gns/nss/nss_gns.c b/src/gns/nss/nss_gns.c
index 77b4340ee..ff34cedd5 100644
--- a/src/gns/nss/nss_gns.c
+++ b/src/gns/nss/nss_gns.c
@@ -193,7 +193,7 @@ finish:
* @param result the result hostent
* @param buffer the result buffer
* @param buflen length of the buffer
- * @param errnop[out] the low-level error code to return to the application
+ * @param[out] errnop the low-level error code to return to the application
* @param h_errnop idk
* @return a nss_status code
*/
@@ -225,7 +225,7 @@ _nss_gns_gethostbyname_r (const char *name,
* @param result the result hostent
* @param buffer the result buffer
* @param buflen length of the buffer
- * @param errnop[out] the low-level error code to return to the application
+ * @param[out] errnop the low-level error code to return to the application
* @param h_errnop idk
* @return NSS_STATUS_UNAVAIL
*/
diff --git a/src/gns/plugin_block_gns.c b/src/gns/plugin_block_gns.c
index a683ecacc..75e182092 100644
--- a/src/gns/plugin_block_gns.c
+++ b/src/gns/plugin_block_gns.c
@@ -133,7 +133,6 @@ block_plugin_gns_get_key (void *cls,
* Function called to validate a query.
*
* @param cls closure
- * @param ctx block context
* @param type block type
* @param query original query (hash)
* @param xquery extrended query data (can be NULL, depending on type)
diff --git a/src/gns/plugin_rest_gns.c b/src/gns/plugin_rest_gns.c
index 3a35c9999..659b77493 100644
--- a/src/gns/plugin_rest_gns.c
+++ b/src/gns/plugin_rest_gns.c
@@ -159,7 +159,7 @@ static struct RequestHandle *requests_tail;
/**
* Cleanup lookup handle
- * @param handle Handle to clean up
+ * @param cls `struct RequestHandle` to clean up
*/
static void
cleanup_handle (void *cls)
diff --git a/src/gns/test_dns2gns.conf b/src/gns/test_dns2gns.conf
index 3b034f8d5..f484d4114 100644
--- a/src/gns/test_dns2gns.conf
+++ b/src/gns/test_dns2gns.conf
@@ -22,7 +22,7 @@ DNS_ROOT=PD67SGHF3E0447TU9HADIVU9OM7V4QHTOG0EBU69TFRI2LG63DR0
[namestore]
IMMEDIATE_START = YES
-#PREFIX = valgrind --leak-check=full --track-origins=yes --log-file=/tmp/ns_log
+#PREFIX = valgrind --leak-check=full --track-origins=yes
--log-file=$GNUNET_TMP/ns_log
[revocation]
WORKBITS = 1
diff --git a/src/gns/test_gns_lookup.conf b/src/gns/test_gns_lookup.conf
index fe7970018..322af0784 100644
--- a/src/gns/test_gns_lookup.conf
+++ b/src/gns/test_gns_lookup.conf
@@ -20,7 +20,7 @@ ZONE_PUBLISH_TIME_WINDOW = 1 h
DNS_ROOT=PD67SGHF3E0447TU9HADIVU9OM7V4QHTOG0EBU69TFRI2LG63DR0
[namestore]
-#PREFIX = valgrind --leak-check=full --track-origins=yes --log-file=/tmp/ns_log
+#PREFIX = valgrind --leak-check=full --track-origins=yes
--log-file=$GNUNET_TMP/ns_log
[zonemaster-monitor]
IMMEDIATE_START = YES
diff --git a/src/gns/test_gns_lookup_peer1.conf
b/src/gns/test_gns_lookup_peer1.conf
index 1cf0ba628..69e2f0973 100644
--- a/src/gns/test_gns_lookup_peer1.conf
+++ b/src/gns/test_gns_lookup_peer1.conf
@@ -24,7 +24,7 @@ DNS_ROOT=PD67SGHF3E0447TU9HADIVU9OM7V4QHTOG0EBU69TFRI2LG63DR0
[namestore]
IMMEDIATE_START = YES
-#PREFIX = valgrind --leak-check=full --track-origins=yes --log-file=/tmp/ns_log
+#PREFIX = valgrind --leak-check=full --track-origins=yes
--log-file=$GNUNET_TMP/ns_log
[revocation]
WORKBITS = 1
diff --git a/src/gns/test_gns_lookup_peer2.conf
b/src/gns/test_gns_lookup_peer2.conf
index 2e861ff0a..3de81d7f3 100644
--- a/src/gns/test_gns_lookup_peer2.conf
+++ b/src/gns/test_gns_lookup_peer2.conf
@@ -29,7 +29,7 @@ DNS_ROOT=PD67SGHF3E0447TU9HADIVU9OM7V4QHTOG0EBU69TFRI2LG63DR0
[namestore]
IMMEDIATE_START = YES
-#PREFIX = valgrind --leak-check=full --track-origins=yes --log-file=/tmp/ns_log
+#PREFIX = valgrind --leak-check=full --track-origins=yes
--log-file=$GNUNET_TMP/ns_log
[revocation]
WORKBITS = 1
diff --git a/src/gns/test_gns_proxy.conf b/src/gns/test_gns_proxy.conf
index c87f26d40..3dfeacafe 100644
--- a/src/gns/test_gns_proxy.conf
+++ b/src/gns/test_gns_proxy.conf
@@ -24,7 +24,7 @@ START_ON_DEMAND = YES
[gns-proxy]
-PROXY_CACERT = /tmp/proxy_cacert.pem
+PROXY_CACERT = $GNUNET_TMP/proxy_cacert.pem
PROXY_UNIXPATH = $GNUNET_RUNTIME_DIR/gnunet-gns-proxy.sock
[namestore]
diff --git a/src/gns/test_proxy.sh b/src/gns/test_proxy.sh
index ee288413f..720fe643d 100755
--- a/src/gns/test_proxy.sh
+++ b/src/gns/test_proxy.sh
@@ -1,9 +1,11 @@
#!/bin/bash
# This file is in the public domain.
TEST_DOMAIN="www.test"
+GNUNET_TMP="$(gnunet-config -f -s PATHS -o GNUNET_TMP)"
+PROXY_CACERT="$(gnunet-config -f -c test_gnunet_proxy.conf -s gns-proxy -o
PROXY_CACERT)"
# Delete old files before starting test
-rm -rf /tmp/gnunet/test-gnunet-gns-testing/
+rm -rf "$GNUNET_TMP/test-gnunet-gns-testing/"
gnunet-arm -s -c test_gns_proxy.conf
gnunet-gns-proxy-setup-ca -c test_gns_proxy.conf
@@ -27,8 +29,9 @@ HEXCERT=`xxd -p local.der | tr -d '\n'`
#echo "This is the certificate the server does use: $HEXCERT"
BOXVALUE="6 8443 52 3 0 0 $HEXCERT"
-cat local.crt > /tmp/server_cacert.pem
-cat local.key >> /tmp/server_cacert.pem
+SERVER_CACERT="$GNUNET_TMP/server_cacert.pem"
+cat local.crt > "$SERVER_CACERT"
+cat local.key >> "$SERVER_CACERT"
gnunet-identity -C test -c test_gns_proxy.conf
gnunet-namestore -p -z "test" -a -n www -t A -V 127.0.0.1 -e never -c
test_gns_proxy.conf
@@ -38,13 +41,13 @@ gnunet-namestore -p -z "test" -a -n www -t BOX -V
"$BOXVALUE" -e never -c test_g
gnunet-arm -i gns-proxy -c test_gns_proxy.conf
-#gnurl --socks5-hostname 127.0.0.1:7777 https://www.test -v --cacert
/tmp/proxy_cacert.pem
-./test_gns_proxy -A /tmp/proxy_cacert.pem -S /tmp/server_cacert.pem -p 8443 -c
test_gns_proxy.conf
+#gnurl --socks5-hostname 127.0.0.1:7777 "https://$TEST_DOMAIN"; -v --cacert
"$PROXY_CACERT"
+./test_gns_proxy -A "$PROXY_CACERT" -S "$SERVER_CACERT" -p 8443 -c
test_gns_proxy.conf
RES=$?
-rm /tmp/proxy_cacert.pem
-rm /tmp/server_cacert.pem
+rm "$PROXY_CACERT"
+rm "$SERVER_CACERT"
gnunet-arm -e test_gns_proxy.conf
diff --git a/src/gnsrecord/gnsrecord.c b/src/gnsrecord/gnsrecord.c
index 52c480ef6..ae4223021 100644
--- a/src/gnsrecord/gnsrecord.c
+++ b/src/gnsrecord/gnsrecord.c
@@ -174,16 +174,6 @@ GNUNET_GNSRECORD_value_to_string (uint32_t type,
}
-/**
- * Convert human-readable version of a 'value' of a record to the binary
- * representation.
- *
- * @param type type of the record
- * @param s human-readable string
- * @param data set to value in binary encoding (will be allocated)
- * @param data_size set to number of bytes in @a data
- * @return #GNUNET_OK on success
- */
int
GNUNET_GNSRECORD_string_to_value (uint32_t type,
const char *s,
@@ -207,12 +197,6 @@ GNUNET_GNSRECORD_string_to_value (uint32_t type,
}
-/**
- * Convert a type name (e.g "AAAA") to the corresponding number.
- *
- * @param dns_typename name to convert
- * @return corresponding number, UINT32_MAX on error
- */
uint32_t
GNUNET_GNSRECORD_typename_to_number (const char *dns_typename)
{
diff --git a/src/gnsrecord/gnsrecord_crypto.c b/src/gnsrecord/gnsrecord_crypto.c
index b5e8be82b..6c1bc6045 100644
--- a/src/gnsrecord/gnsrecord_crypto.c
+++ b/src/gnsrecord/gnsrecord_crypto.c
@@ -868,17 +868,6 @@ block_decrypt_eddsa (const struct GNUNET_GNSRECORD_Block
*block,
}
-/**
- * Decrypt block.
- *
- * @param block block to decrypt
- * @param zone_key public key of the zone
- * @param label the name for the records
- * @param proc function to call with the result
- * @param proc_cls closure for proc
- * @return #GNUNET_OK on success, #GNUNET_SYSERR if the block was
- * not well-formed
- */
enum GNUNET_GenericReturnValue
GNUNET_GNSRECORD_block_decrypt (const struct GNUNET_GNSRECORD_Block *block,
const struct
@@ -946,14 +935,6 @@ GNUNET_GNSRECORD_query_from_private_key (const struct
}
-/**
- * Calculate the DHT query for a given @a label in a given @a zone.
- * FIXME: We may want to plugin-ize this at some point.
- *
- * @param pub public key of the zone
- * @param label label of the record
- * @param query hash to use for the query
- */
void
GNUNET_GNSRECORD_query_from_public_key (const struct
GNUNET_IDENTITY_PublicKey *pub,
diff --git a/src/gnsrecord/gnsrecord_misc.c b/src/gnsrecord/gnsrecord_misc.c
index 880fc68c6..5a24a83d3 100644
--- a/src/gnsrecord/gnsrecord_misc.c
+++ b/src/gnsrecord/gnsrecord_misc.c
@@ -62,14 +62,6 @@ GNUNET_GNSRECORD_label_check (const char*label, char **emsg)
}
-/**
- * Convert a zone key to a string (for printing debug messages).
- * This is one of the very few calls in the entire API that is
- * NOT reentrant!
- *
- * @param z the zone key
- * @return string form; will be overwritten by next call to
#GNUNET_GNSRECORD_z2s
- */
const char *
GNUNET_GNSRECORD_z2s (const struct GNUNET_IDENTITY_PublicKey *z)
{
diff --git a/src/gnsrecord/gnsrecord_serialization.c
b/src/gnsrecord/gnsrecord_serialization.c
index 97c488c2b..ef7684892 100644
--- a/src/gnsrecord/gnsrecord_serialization.c
+++ b/src/gnsrecord/gnsrecord_serialization.c
@@ -77,14 +77,6 @@ struct NetworkRecord
GNUNET_NETWORK_STRUCT_END
-/**
- * Calculate how many bytes we will need to serialize the given
- * records.
- *
- * @param rd_count number of records in the rd array
- * @param rd array of #GNUNET_GNSRECORD_Data with @a rd_count elements
- * @return the required size to serialize, -1 on error
- */
ssize_t
GNUNET_GNSRECORD_records_get_size (unsigned int rd_count,
const struct GNUNET_GNSRECORD_Data *rd)
@@ -143,15 +135,6 @@ GNUNET_GNSRECORD_records_get_size (unsigned int rd_count,
}
-/**
- * Serialize the given records to the given destination buffer.
- *
- * @param rd_count number of records in the rd array
- * @param rd array of #GNUNET_GNSRECORD_Data with @a rd_count elements
- * @param dest_size size of the destination array
- * @param dest where to write the result
- * @return the size of serialized records, -1 if records do not fit
- */
ssize_t
GNUNET_GNSRECORD_records_serialize (unsigned int rd_count,
const struct GNUNET_GNSRECORD_Data *rd,
diff --git a/src/hello/address.c b/src/hello/address.c
index e22f3850f..6a1b68029 100644
--- a/src/hello/address.c
+++ b/src/hello/address.c
@@ -59,16 +59,6 @@ GNUNET_HELLO_address_get_size (const struct
GNUNET_HELLO_Address *address)
}
-/**
- * Allocate an address struct.
- *
- * @param peer the peer
- * @param transport_name plugin name
- * @param address binary address
- * @param address_length number of bytes in 'address'
- * @param local_info additional local information for the address
- * @return the address struct
- */
struct GNUNET_HELLO_Address *
GNUNET_HELLO_address_allocate (const struct GNUNET_PeerIdentity *peer,
const char *transport_name,
@@ -118,14 +108,6 @@ GNUNET_HELLO_address_copy (const struct
GNUNET_HELLO_Address *address)
}
-/**
- * Compare two addresses. Does NOT compare the peer identity,
- * that is assumed already to match!
- *
- * @param a1 first address
- * @param a2 second address
- * @return 0 if the addresses are equal, -1 if a1<a2, 1 if a1>a2.
- */
int
GNUNET_HELLO_address_cmp (const struct GNUNET_HELLO_Address *a1,
const struct GNUNET_HELLO_Address *a2)
diff --git a/src/hello/hello-ng.c b/src/hello/hello-ng.c
index 96856a692..da3a069e0 100644
--- a/src/hello/hello-ng.c
+++ b/src/hello/hello-ng.c
@@ -60,8 +60,8 @@ GNUNET_NETWORK_STRUCT_END
* @param nt network type of @a address
* @param mono_time monotonic time at which @a address was valid
* @param private_key signing key to use
- * @param result[out] where to write address record (allocated)
- * @param result_size[out] set to size of @a result
+ * @param[out] result where to write address record (allocated)
+ * @param[out] result_size set to size of @a result
*/
void
GNUNET_HELLO_sign_address (
diff --git a/src/hello/hello.c b/src/hello/hello.c
index 12b576ceb..45d27c5d4 100644
--- a/src/hello/hello.c
+++ b/src/hello/hello.c
@@ -511,15 +511,6 @@ merge_addr (void *cls,
}
-/**
- * Construct a HELLO message by merging the
- * addresses in two existing HELLOs (which
- * must be for the same peer).
- *
- * @param h1 first HELLO message
- * @param h2 the second HELLO message
- * @return the combined HELLO message
- */
struct GNUNET_HELLO_Message *
GNUNET_HELLO_merge (const struct GNUNET_HELLO_Message *h1,
const struct GNUNET_HELLO_Message *h2)
@@ -606,19 +597,6 @@ delta_match (void *cls,
}
-/**
- * Iterate over addresses in @a new_hello that are NOT already present
- * in @a old_hello. Note that if the address is present in @a old_hello
- * but the expiration time in @a new_hello is more recent, the iterator
- * is also called.
- *
- * @param new_hello a HELLO message
- * @param old_hello a HELLO message
- * @param expiration_limit ignore addresses in @a old_hello
- * that expired before the given time stamp
- * @param it iterator to call on each address
- * @param it_cls closure for @a it
- */
void
GNUNET_HELLO_iterate_new_addresses (const struct
GNUNET_HELLO_Message *new_hello,
diff --git a/src/hostlist/gnunet-daemon-hostlist_client.c
b/src/hostlist/gnunet-daemon-hostlist_client.c
index f097cecc9..399a7dc39 100644
--- a/src/hostlist/gnunet-daemon-hostlist_client.c
+++ b/src/hostlist/gnunet-daemon-hostlist_client.c
@@ -1318,8 +1318,6 @@ primary_task (void *cls, int success)
* we go the stat. Initiates hostlist download scheduling.
*
* @param cls closure
- * @param success #GNUNET_OK if statistics were
- * successfully obtained, #GNUNET_SYSERR if not.
*/
static void
stat_timeout_task (void *cls)
diff --git a/src/identity/gnunet-service-identity.c
b/src/identity/gnunet-service-identity.c
index 51f897557..51fca7816 100644
--- a/src/identity/gnunet-service-identity.c
+++ b/src/identity/gnunet-service-identity.c
@@ -476,8 +476,7 @@ check_get_default_message (void *cls,
* default identity for some service.
*
* @param cls unused
- * @param client who sent the message
- * @param message the message received
+ * @param gdm the message received
*/
static void
handle_get_default_message (void *cls,
@@ -587,8 +586,7 @@ check_set_default_message (void *cls,
* default identity for some service.
*
* @param cls unused
- * @param client who sent the message
- * @param message the message received
+ * @param sdm the message received
*/
static void
handle_set_default_message (void *cls,
@@ -699,8 +697,7 @@ check_create_message (void *cls,
* Handler for CREATE message from client, creates new identity.
*
* @param cls unused
- * @param client who sent the message
- * @param message the message received
+ * @param crm the message received
*/
static void
handle_create_message (void *cls,
@@ -839,8 +836,7 @@ check_rename_message (void *cls, const struct RenameMessage
*msg)
* new identity.
*
* @param cls unused
- * @param client who sent the message
- * @param message the message received
+ * @param rm the message received
*/
static void
handle_rename_message (void *cls, const struct RenameMessage *rm)
@@ -985,8 +981,7 @@ check_delete_message (void *cls, const struct DeleteMessage
*msg)
* new identity.
*
* @param cls unused
- * @param client who sent the message
- * @param message the message received
+ * @param dm the message received
*/
static void
handle_delete_message (void *cls, const struct DeleteMessage *dm)
diff --git a/src/identity/identity_api.c b/src/identity/identity_api.c
index 471569cb3..934ee31c6 100644
--- a/src/identity/identity_api.c
+++ b/src/identity/identity_api.c
@@ -661,16 +661,6 @@ GNUNET_IDENTITY_ego_get_public_key (struct
GNUNET_IDENTITY_Ego *ego,
}
-/**
- * Obtain the identity that is currently preferred/default
- * for a service.
- *
- * @param h identity service to query
- * @param service_name for which service is an identity wanted
- * @param cb function to call with the result (will only be called once)
- * @param cb_cls closure for @a cb
- * @return handle to abort the operation
- */
struct GNUNET_IDENTITY_Operation *
GNUNET_IDENTITY_get (struct GNUNET_IDENTITY_Handle *h,
const char *service_name,
diff --git a/src/identity/plugin_rest_identity.c
b/src/identity/plugin_rest_identity.c
index d9b1e7c2c..5327d0b1f 100644
--- a/src/identity/plugin_rest_identity.c
+++ b/src/identity/plugin_rest_identity.c
@@ -280,7 +280,7 @@ static struct RequestHandle *requests_tail;
/**
* Cleanup lookup handle
- * @param handle Handle to clean up
+ * @param cls Handle to clean up
*/
static void
cleanup_handle (void *cls)
@@ -696,7 +696,7 @@ do_finished (void *cls, const char *emsg)
* Processing finished, when creating an ego.
*
* @param cls request handle
- * @param private key of the ego, or NULL on error
+ * @param pk private key of the ego, or NULL on error
* @param emsg error message
*/
static void
diff --git a/src/include/block_dns.h b/src/include/block_dns.h
index 2186cb1a1..2c573fb20 100644
--- a/src/include/block_dns.h
+++ b/src/include/block_dns.h
@@ -19,6 +19,9 @@
*/
/**
+ * @addtogroup vpn_suite
+ * @{
+ *
* @author Christian Grothoff
*
* @file
@@ -65,3 +68,5 @@ GNUNET_NETWORK_STRUCT_END
#endif
/** @} */ /* end of group */
+
+/** @} */ /* end of group addition to vpn_suite */
diff --git a/src/include/block_fs.h b/src/include/block_fs.h
index e4caf6e50..f05bb4a29 100644
--- a/src/include/block_fs.h
+++ b/src/include/block_fs.h
@@ -19,6 +19,9 @@
*/
/**
+ * @addtogroup fs_l2
+ * @{
+ *
* @author Christian Grothoff
*
* @file
@@ -98,3 +101,5 @@ GNUNET_NETWORK_STRUCT_END
#endif
/** @} */ /* end of group */
+
+/** @} */ /* end of group addition to fs_l2 */
diff --git a/src/include/gnunet_abd_service.h b/src/include/gnunet_abd_service.h
index 21f668a8d..a52ed29ff 100644
--- a/src/include/gnunet_abd_service.h
+++ b/src/include/gnunet_abd_service.h
@@ -19,13 +19,16 @@
*/
/**
+ * @addtogroup reclaim_suite
+ * @{
+ *
* @author Martin Schanzenbach
*
* @file
* API to the Credential service
*
* @defgroup abd Credential service
- * Credentials
+ * Credential service for Attribute-Based Decryption
*
* @{
*/
@@ -384,7 +387,7 @@ GNUNET_ABD_remove_delegation (struct GNUNET_ABD_Handle
*handle,
*
* @param issuer the ego that should be used to issue the attribute
* @param subject the subject of the attribute
- * @param attribute the name of the attribute
+ * @param iss_attr the name of the attribute
* @param expiration the TTL of the credential
* @return handle to the queued request
*/
@@ -415,3 +418,5 @@ GNUNET_ABD_request_cancel (struct GNUNET_ABD_Request *lr);
#endif
/** @} */ /* end of group */
+
+/** @} */ /* end of group addition to reclaim_suite */
diff --git a/src/include/gnunet_applications.h
b/src/include/gnunet_applications.h
index 1e2ac59f7..489dc7050 100644
--- a/src/include/gnunet_applications.h
+++ b/src/include/gnunet_applications.h
@@ -19,6 +19,9 @@
*/
/**
+ * @addtogroup Backbone
+ * @{
+ *
* @author Christian Grothoff
*
* @file
@@ -133,4 +136,6 @@ extern "C"
/** @} */ /* end of group */
+/** @} */ /* end of group addition to Backbone */
+
/* end of gnunet_applications.h */
diff --git a/src/include/gnunet_ats_service.h b/src/include/gnunet_ats_service.h
index 11a65c4f5..321e621d2 100644
--- a/src/include/gnunet_ats_service.h
+++ b/src/include/gnunet_ats_service.h
@@ -158,7 +158,7 @@ struct GNUNET_ATS_PropertiesNBO
/**
* Convert ATS properties from host to network byte order.
*
- * @param nbo[OUT] value written
+ * @param nbo[out] value written
* @param hbo value read
*/
void
@@ -169,7 +169,7 @@ GNUNET_ATS_properties_hton (struct GNUNET_ATS_PropertiesNBO
*nbo,
/**
* Convert ATS properties from network to host byte order.
*
- * @param hbo[OUT] value written
+ * @param hbo[out] value written
* @param nbo value read
*/
void
@@ -344,7 +344,7 @@ GNUNET_ATS_address_add_session (struct
GNUNET_ATS_AddressRecord *ar,
* @param session session handle
* @return #GNUNET_YES if the @a ar was destroyed because
* it was an incoming address,
- * #GNUNET_NO if the @ar was kept because we can
+ * #GNUNET_NO if the @a ar was kept because we can
* use it still to establish a new session
*/
int
diff --git a/src/include/gnunet_block_group_lib.h
b/src/include/gnunet_block_group_lib.h
index d242ceefb..53827f5f4 100644
--- a/src/include/gnunet_block_group_lib.h
+++ b/src/include/gnunet_block_group_lib.h
@@ -90,7 +90,7 @@ GNUNET_BLOCK_GROUP_bf_create (void *cls,
* @param bg block group to use for testing
* @param hc hash of element to evaluate
* @return #GNUNET_YES if @a hc is (likely) a duplicate
- * #GNUNET_NO if @a hc was definitively not in @bg (but now is)
+ * #GNUNET_NO if @a hc was definitively not in @a bg (but now is)
*/
enum GNUNET_GenericReturnValue
GNUNET_BLOCK_GROUP_bf_test_and_set (struct GNUNET_BLOCK_Group *bg,
diff --git a/src/include/gnunet_block_lib.h b/src/include/gnunet_block_lib.h
index fe6c99613..6a6de712b 100644
--- a/src/include/gnunet_block_lib.h
+++ b/src/include/gnunet_block_lib.h
@@ -131,7 +131,6 @@ struct GNUNET_BLOCK_Group;
*
* @param ctx block context in which the block group is created
* @param type type of the block for which we are creating the group
- * @param nonce random value used to seed the group creation
* @param raw_data optional serialized prior state of the group, NULL if
unavailable/fresh
* @param raw_data_size number of bytes in @a raw_data, 0 if unavailable/fresh
* @param ... type-specific additional data, can be empty
@@ -272,7 +271,7 @@ GNUNET_BLOCK_group_set_seen (struct GNUNET_BLOCK_Group *bg,
/**
* Try merging two block groups. Afterwards, @a bg1 should remain
- * valid and contain the rules from both @a bg1 and @bg2, and
+ * valid and contain the rules from both @a bg1 and @a bg2, and
* @a bg2 should be destroyed (as part of this call). The latter
* should happen even if merging is not supported.
*
diff --git a/src/include/gnunet_client_lib.h b/src/include/gnunet_client_lib.h
index 3cafa7e45..321810eb4 100644
--- a/src/include/gnunet_client_lib.h
+++ b/src/include/gnunet_client_lib.h
@@ -101,8 +101,8 @@ GNUNET_CLIENT_connect (const struct
GNUNET_CONFIGURATION_Handle *cfg,
/** @} */ /* end of group client */
-/* @} */ /* end of group addition */
+/** @} */ /* end of group addition */
-/* @} */ /* end of group addition */
+/** @} */ /* end of group addition */
/* end of gnunet_client_lib.h */
diff --git a/src/include/gnunet_common.h b/src/include/gnunet_common.h
index 5035d6baa..8c58fd6e3 100644
--- a/src/include/gnunet_common.h
+++ b/src/include/gnunet_common.h
@@ -1510,7 +1510,7 @@ GNUNET_is_zero_ (const void *a,
* will be updated to reflect the new address. The TYPE of
* arr is important since size is the number of elements and
* not the size in bytes
- * @param len the number of elements in the existing vector (number
+ * @param len2 the number of elements in the existing vector (number
* of elements to copy over), will be updated with the new
* array size
@@ -1743,7 +1743,7 @@ GNUNET_copy_message (const struct GNUNET_MessageHeader
*msg);
* Set the async scope for the current thread.
*
* @param aid the async scope identifier
- * @param old_scope[out] location to save the old scope
+ * @param[out] old_scope location to save the old scope
*/
void
GNUNET_async_scope_enter (const struct GNUNET_AsyncScopeId *aid,
diff --git a/src/include/gnunet_configuration_lib.h
b/src/include/gnunet_configuration_lib.h
index ac0013e94..2d26f3c05 100644
--- a/src/include/gnunet_configuration_lib.h
+++ b/src/include/gnunet_configuration_lib.h
@@ -174,7 +174,7 @@ GNUNET_CONFIGURATION_serialize_diagnostics (
* @param mem the memory block of serialized configuration
* @param size the size of the memory block
* @param source_filename source filename, will be used
- * to resolve relative @INLINE@ statements
+ * to resolve relative \@INLINE\@ statements
* @return #GNUNET_OK on success, #GNUNET_SYSERR on error
*/
enum GNUNET_GenericReturnValue
diff --git a/src/include/gnunet_container_lib.h
b/src/include/gnunet_container_lib.h
index 097ee040d..b31a95fac 100644
--- a/src/include/gnunet_container_lib.h
+++ b/src/include/gnunet_container_lib.h
@@ -28,24 +28,30 @@
*
* @file
* Container classes for GNUnet
- *
- * @defgroup hashmap Container library: MultiHashMap
+ *
+ * @addtogroup container
+ * Common data structures in GNUnet programs
+ * @{
+ *
+ * @defgroup hashmap MultiHashMap
* Hash map with multiple values per key.
*
* @see [Documentation](https://gnunet.org/util_multihashmap)
*
- * @defgroup heap Container library: Heap
+ * @defgroup heap Heap
* Min- or max-heap with arbitrary element removal
*
- * @defgroup bloomfilter Container library: Bloom filter
+ * @defgroup bloomfilter Bloom filter
* Probabilistic set tests
*
- * @defgroup dll Container library: Doubly-linked list
+ * @defgroup dll Doubly-linked list
*
* @see [Documentation](https://gnunet.org/mdll-api)
*
- * @defgroup metadata Container library: Metadata
+ * @defgroup metadata Metadata
* GNU libextractor key-value pairs
+ *
+ * @}
*/
#ifndef GNUNET_CONTAINER_LIB_H
diff --git a/src/include/gnunet_crypto_lib.h b/src/include/gnunet_crypto_lib.h
index 7ff50dda1..36e6743b3 100644
--- a/src/include/gnunet_crypto_lib.h
+++ b/src/include/gnunet_crypto_lib.h
@@ -1431,7 +1431,7 @@ enum GNUNET_GenericReturnValue
GNUNET_CRYPTO_eddsa_private_key_from_string (
const char *enc,
size_t enclen,
- struct GNUNET_CRYPTO_EddsaPrivateKey *pub);
+ struct GNUNET_CRYPTO_EddsaPrivateKey *priv);
/**
@@ -1683,7 +1683,7 @@ GNUNET_CRYPTO_ecc_dlog_prepare (unsigned int max,
* Calculate ECC discrete logarithm for small factors.
* Opposite of #GNUNET_CRYPTO_ecc_dexp().
*
- * @param dlc precalculated values, determine range of factors
+ * @param edc precalculated values, determine range of factors
* @param input point on the curve to factor
* @return INT_MAX if dlog failed, otherwise the factor
*/
@@ -1954,7 +1954,7 @@ GNUNET_CRYPTO_ecdsa_sign_ (
*
* @param priv
* @param data
- * @param len
+ * @param size
* @param sig
* @return enum GNUNET_GenericReturnValue
*/
@@ -2239,7 +2239,7 @@ GNUNET_CRYPTO_ecdsa_public_key_derive (
* @param label label to use for key deriviation
* @param context additional context to use for HKDF of 'h';
* typically the name of the subsystem/application
- * @param purp the signature purpose
+ * @param purpose the signature purpose
* @param sig the resulting signature
* @return GNUNET_OK on success
*/
@@ -2304,7 +2304,7 @@ GNUNET_CRYPTO_eddsa_public_key_derive (
* @param label label to use for key deriviation
* @param context additional context to use for HKDF of 'h';
* typically the name of the subsystem/application
- * @param purp the signature purpose
+ * @param purpose the signature purpose
* @param sig the resulting signature
* @return GNUNET_OK on success
*/
@@ -2432,7 +2432,7 @@ GNUNET_CRYPTO_paillier_encrypt (
* @param private_key Private key to use for decryption.
* @param public_key Public key to use for decryption.
* @param ciphertext Ciphertext to decrypt.
- * @param[out] m Decryption of @a ciphertext with @private_key.
+ * @param[out] m Decryption of @a ciphertext with @a private_key.
*/
void
GNUNET_CRYPTO_paillier_decrypt (
@@ -2690,7 +2690,7 @@ GNUNET_CRYPTO_rsa_public_key_cmp (const struct
GNUNET_CRYPTO_RsaPublicKey *p1,
* Blinds the given message with the given blinding key
*
* @param hash hash of the message to sign
- * @param bkey the blinding key
+ * @param bks the blinding key
* @param pkey the public key of the signer
* @param[out] buf set to a buffer with the blinded message to be signed
* @param[out] buf_size number of bytes stored in @a buf
diff --git a/src/include/gnunet_curl_lib.h b/src/include/gnunet_curl_lib.h
index b5d62ba0f..92334887d 100644
--- a/src/include/gnunet_curl_lib.h
+++ b/src/include/gnunet_curl_lib.h
@@ -18,6 +18,9 @@
SPDX-License-Identifier: AGPL3.0-or-later
*/
/**
+ * @addtogroup lib_extra Additional libraries
+ * @{
+ *
* @file src/include/gnunet_curl_lib.h
* @brief library to make it easy to download JSON replies over HTTP
* @author Sree Harsha Totakura <sreeharsha@totakura.in>
@@ -224,7 +227,7 @@ typedef void
* be executed AND cleaned up
* @param jcc callback to invoke upon completion
* @param jcc_cls closure for @a jcc
- * @return NULL on error (in this case, @eh is still released!)
+ * @return NULL on error (in this case, @a eh is still released!)
*/
struct GNUNET_CURL_Job *
GNUNET_CURL_job_add (struct GNUNET_CURL_Context *ctx,
@@ -246,7 +249,7 @@ GNUNET_CURL_job_add (struct GNUNET_CURL_Context *ctx,
* be executed AND cleaned up
* @param jcc callback to invoke upon completion
* @param jcc_cls closure for @a jcc
- * @return NULL on error (in this case, @eh is still released!)
+ * @return NULL on error (in this case, @a eh is still released!)
*/
struct GNUNET_CURL_Job *
GNUNET_CURL_job_add_with_ct_json (struct GNUNET_CURL_Context *ctx,
@@ -304,7 +307,7 @@ GNUNET_CURL_set_tlscert (struct GNUNET_CURL_Context *ctx,
* @param job_headers extra headers to add for this request
* @param jcc callback to invoke upon completion
* @param jcc_cls closure for @a jcc
- * @return NULL on error (in this case, @eh is still released!)
+ * @return NULL on error (in this case, @a eh is still released!)
*/
struct GNUNET_CURL_Job *
GNUNET_CURL_job_add2 (struct GNUNET_CURL_Context *ctx,
@@ -324,10 +327,9 @@ GNUNET_CURL_job_add2 (struct GNUNET_CURL_Context *ctx,
* @param eh curl easy handle for the request, will
* be executed AND cleaned up
* @param job_headers extra headers to add for this request
- * @param max_reply_size largest acceptable response body
* @param jcc callback to invoke upon completion
* @param jcc_cls closure for @a jcc
- * @return NULL on error (in this case, @eh is still released!)
+ * @return NULL on error (in this case, @a eh is still released!)
*/
struct GNUNET_CURL_Job *
GNUNET_CURL_job_add_raw (struct GNUNET_CURL_Context *ctx,
@@ -437,4 +439,6 @@ GNUNET_CURL_is_valid_scope_id (const char *scope_id);
#endif
/** @} */ /* end of group */
+/** @} */ /* end of group addition to lib_extra */
+
/* end of gnunet_curl_lib.h */
diff --git a/src/include/gnunet_dhtu_plugin.h b/src/include/gnunet_dhtu_plugin.h
index fa0b5f667..81b0f1d7b 100644
--- a/src/include/gnunet_dhtu_plugin.h
+++ b/src/include/gnunet_dhtu_plugin.h
@@ -119,7 +119,7 @@ struct GNUNET_DHTU_PluginEnvironment
* @param cls the closure
* @param target handle to the target,
* pointer will remain valid until @e disconnect_cb is called
- * @para pid peer identity,
+ * @param pid peer identity,
* pointer will remain valid until @e disconnect_cb is called
* @param[out] ctx storage space for DHT to use in association with this
target
*/
diff --git a/src/include/gnunet_disk_lib.h b/src/include/gnunet_disk_lib.h
index 71c1f88a5..c76cdc231 100644
--- a/src/include/gnunet_disk_lib.h
+++ b/src/include/gnunet_disk_lib.h
@@ -674,7 +674,7 @@ GNUNET_DISK_directory_scan (const char *dir_name,
* Currently, the glob_pattern only supports asterisks in the last
* path component.
*
- * @param glob_patterb the glob pattern to search for
+ * @param glob_pattern the glob pattern to search for
* @param callback the method to call for each file
* @param callback_cls closure for @a callback
* @return the number of files found, -1 on error
diff --git a/src/include/gnunet_dnsstub_lib.h b/src/include/gnunet_dnsstub_lib.h
index 1310ce55a..4cc5e7fd0 100644
--- a/src/include/gnunet_dnsstub_lib.h
+++ b/src/include/gnunet_dnsstub_lib.h
@@ -89,7 +89,7 @@ GNUNET_DNSSTUB_add_dns_sa (struct GNUNET_DNSSTUB_Context *ctx,
* Only effective for requests issued after this call.
*
* @param ctx resolver context to modify
- * @param retry_frequ how long to wait between retries
+ * @param retry_freq how long to wait between retries
*/
void
GNUNET_DNSSTUB_set_retry (struct GNUNET_DNSSTUB_Context *ctx,
diff --git a/src/include/gnunet_friends_lib.h b/src/include/gnunet_friends_lib.h
index d591ea082..03fa6c72d 100644
--- a/src/include/gnunet_friends_lib.h
+++ b/src/include/gnunet_friends_lib.h
@@ -19,6 +19,9 @@
*/
/**
+ * @addtogroup Backbone
+ * @{
+ *
* @author Christian Grothoff
*
* @file
@@ -116,3 +119,5 @@ GNUNET_FRIENDS_write (struct GNUNET_FRIENDS_Writer *w,
#endif
/** @} */ /* end of group */
+
+/** @} */ /* end of group addition to backbone */
diff --git a/src/include/gnunet_fs_service.h b/src/include/gnunet_fs_service.h
index 6b664169a..8ae826380 100644
--- a/src/include/gnunet_fs_service.h
+++ b/src/include/gnunet_fs_service.h
@@ -111,7 +111,7 @@ typedef int
* into HashMaps. The key may change between FS implementations.
*
* @param uri uri to convert to a unique key
- * @param key wherer to store the unique key
+ * @param key where to store the unique key
* @return #GNUNET_OK on success
*/
int
@@ -464,7 +464,7 @@ GNUNET_FS_GETOPT_KEYWORDS (char shortName,
* @param name long name of the option
* @param argumentHelp help text for the option argument
* @param description long help text for the option
- * @param[out] metadata set to the desired value
+ * @param[out] meta metadata set to the desired value
*/
struct GNUNET_GETOPT_CommandLineOption
GNUNET_FS_GETOPT_METADATA (char shortName,
diff --git a/src/include/gnunet_getopt_lib.h b/src/include/gnunet_getopt_lib.h
index c7c1d57a3..87ad591b7 100644
--- a/src/include/gnunet_getopt_lib.h
+++ b/src/include/gnunet_getopt_lib.h
@@ -404,7 +404,6 @@ GNUNET_GETOPT_option_timestamp (char shortName,
*
* @param shortName short name of the option
* @param name long name of the option
- * @param argumentHelp help text for the option argument
* @param description long help text for the option
* @param[out] val set to 1 if the option is present
*/
diff --git a/src/include/gnunet_gns_service.h b/src/include/gnunet_gns_service.h
index d367ac076..a32bb77ae 100644
--- a/src/include/gnunet_gns_service.h
+++ b/src/include/gnunet_gns_service.h
@@ -238,3 +238,5 @@ GNUNET_GNS_lookup_with_tld_cancel (struct
GNUNET_GNS_LookupWithTldRequest *ltr);
#endif
/** @} */ /* end of group */
+
+/** @} */ /* end of group addition */
diff --git a/src/include/gnunet_gnsrecord_lib.h
b/src/include/gnunet_gnsrecord_lib.h
index 21fb610f3..357f87587 100644
--- a/src/include/gnunet_gnsrecord_lib.h
+++ b/src/include/gnunet_gnsrecord_lib.h
@@ -528,6 +528,7 @@ GNUNET_GNSRECORD_query_from_private_key (
/**
* Calculate the DHT query for a given @a label in a given @a zone.
+ * FIXME: We may want to plugin-ize this at some point.
*
* @param pub public key of the zone
* @param label label of the record
@@ -752,7 +753,7 @@ GNUNET_GNSRECORD_is_critical (uint32_t type);
* @param rd input records
* @param rd_count size of the @a rd and @a rd_public arrays
* @param rd_public where to write the converted records
- * @param rd_public_count number of records written to @a rd_public
+ * @param rd_count_public number of records written to @a rd_public
* @param min_expiry the minimum expiration of this set
* @param filter the record set filter, see GNUNET_GNSRECORD_Filter.
* @param emsg the error message if something went wrong
@@ -768,7 +769,6 @@ GNUNET_GNSRECORD_normalize_record_set (const char *label,
enum GNUNET_GNSRECORD_Filter filter,
char **emsg);
-
/**
* Check label for invalid characters.
*
diff --git a/src/include/gnunet_hello_lib.h b/src/include/gnunet_hello_lib.h
index b12108a33..86bf35110 100644
--- a/src/include/gnunet_hello_lib.h
+++ b/src/include/gnunet_hello_lib.h
@@ -485,8 +485,8 @@ GNUNET_HELLO_parse_uri (const char *uri,
* @param nt network type of @a address
* @param mono_time when was @a address valid
* @param private_key signing key to use
- * @param result[out] where to write address record (allocated)
- * @param result_size[out] set to size of @a result
+ * @param[out] result where to write address record (allocated)
+ * @param[out] result_size set to size of @a result
*/
void
GNUNET_HELLO_sign_address (
@@ -504,8 +504,8 @@ GNUNET_HELLO_sign_address (
* @param raw raw signed address
* @param raw_size size of @a raw
* @param pid public key to use for signature verification
- * @param nt[out] set to network type
- * @param mono_time[out] when was the address generated
+ * @param[out] nt set to network type
+ * @param[out] mono_time when was the address generated
* @return NULL on error, otherwise the address
*/
char *
diff --git a/src/include/gnunet_json_lib.h b/src/include/gnunet_json_lib.h
index af63c5e42..8809afb71 100644
--- a/src/include/gnunet_json_lib.h
+++ b/src/include/gnunet_json_lib.h
@@ -129,7 +129,7 @@ struct GNUNET_JSON_Specification
* @param root the JSON node to start the navigation at.
* @param spec parse specification array
* @param[out] error_json_name which JSON field was problematic
- * @param[out] which index into @a spec did we encounter an error
+ * @param[out] error_line which index into @a spec did we encounter an error
* @return #GNUNET_OK on success, #GNUNET_SYSERR on error
*/
enum GNUNET_GenericReturnValue
@@ -338,7 +338,7 @@ GNUNET_JSON_spec_boolean (const char *name,
* Timestamp.
*
* @param name name of the JSON field
- * @param[out] at where to store the absolute time found under @a name
+ * @param[out] t at where to store the absolute time found under @a name
*/
struct GNUNET_JSON_Specification
GNUNET_JSON_spec_timestamp (const char *name,
diff --git a/src/include/gnunet_load_lib.h b/src/include/gnunet_load_lib.h
index ef596807a..397d3aa2d 100644
--- a/src/include/gnunet_load_lib.h
+++ b/src/include/gnunet_load_lib.h
@@ -19,6 +19,9 @@
*/
/**
+ * @addtogroup libgnunetutil
+ * @{
+ *
* @author Christian Grothoff
*
* @file
@@ -124,4 +127,6 @@ GNUNET_LOAD_update (struct GNUNET_LOAD_Value *load,
uint64_t data);
/** @} */ /* end of group */
+/** @} */ /* end of group addition to libgnunetutil */
+
/* end of gnunet_load_lib.h */
diff --git a/src/include/gnunet_messenger_service.h
b/src/include/gnunet_messenger_service.h
index f8bbc7398..12f021d35 100644
--- a/src/include/gnunet_messenger_service.h
+++ b/src/include/gnunet_messenger_service.h
@@ -613,9 +613,9 @@ typedef int
* @param[in] cfg Configuration to use
* @param[in] name Name to look up an ego or NULL to stay anonymous
* @param[in] identity_callback Function called when the EGO of the handle
changes
- * @param[in/out] identity_cls Closure for the <i>identity_callback</i> handler
+ * @param[in,out] identity_cls Closure for the <i>identity_callback</i> handler
* @param[in] msg_callback Function called when a new message is sent or
received
- * @param[in/out] msg_cls Closure for the <i>msg_callback</i> handler
+ * @param[in,out] msg_cls Closure for the <i>msg_callback</i> handler
* @return Messenger handle to use, NULL on error
*/
struct GNUNET_MESSENGER_Handle*
@@ -634,7 +634,7 @@ GNUNET_MESSENGER_connect (const struct
GNUNET_CONFIGURATION_Handle *cfg,
* Keep in mind that this will fully delete the old ego key (if any is used)
even if any other service wants to use it
* as default.
*
- * @param[in/out] handle Messenger handle to use
+ * @param[in,out] handle Messenger handle to use
* @return #GNUNET_OK on success, #GNUNET_SYSERR on failure
*/
int
@@ -643,7 +643,7 @@ GNUNET_MESSENGER_update (struct GNUNET_MESSENGER_Handle
*handle);
/**
* Disconnect all of the messengers used services and clears up its used
memory.
*
- * @param[in/out] handle Messenger handle to use
+ * @param[in,out] handle Messenger handle to use
*/
void
GNUNET_MESSENGER_disconnect (struct GNUNET_MESSENGER_Handle *handle);
@@ -662,7 +662,7 @@ GNUNET_MESSENGER_get_name (const struct
GNUNET_MESSENGER_Handle *handle);
* name to its new directory. If anything fails during this process the
function returns #GNUNET_NO and the name for
* the messenger won't change as specified.
*
- * @param[in/out] handle Messenger handle to use
+ * @param[in,out] handle Messenger handle to use
* @param[in] name Name for the messenger to change to
* @return #GNUNET_YES on success, #GNUNET_NO on failure and #GNUNET_SYSERR if
<i>handle</i> is NULL
*/
@@ -691,7 +691,7 @@ GNUNET_MESSENGER_get_key (const struct
GNUNET_MESSENGER_Handle *handle);
*
* ( All <b>doors</b> form a ring structured network to shorten the latency
sending and receiving messages. )
*
- * @param[in/out] handle Messenger handle to use
+ * @param[in,out] handle Messenger handle to use
* @param[in] key Hash identifying the port
* @return Room handle, NULL on error
*/
@@ -712,7 +712,7 @@ GNUNET_MESSENGER_open_room (struct GNUNET_MESSENGER_Handle
*handle,
*
* ( All <b>doors</b> form a ring structured network to shorten the latency
sending and receiving messages. )
*
- * @param[in/out] handle Messenger handle to use
+ * @param[in,out] handle Messenger handle to use
* @param[in] door Peer identity of an open <b>door</b>
* @param[in] key Hash identifying the port
* @return Room handle, NULL on error
@@ -729,7 +729,7 @@ GNUNET_MESSENGER_enter_room (struct GNUNET_MESSENGER_Handle
*handle,
* ( After a member closes a <b>door</b>, all members entered through that
specific <b>door</b> have to use another one
* or open the room on their own. )
*
- * @param[in/out] room Room handle
+ * @param[in,out] room Room handle
*/
void
GNUNET_MESSENGER_close_room (struct GNUNET_MESSENGER_Room *room);
@@ -792,7 +792,7 @@ const struct GNUNET_IDENTITY_PublicKey*
GNUNET_MESSENGER_contact_get_key (const struct GNUNET_MESSENGER_Contact
*contact);
/**
- * Send a <i>message</i> into a </i>room</i>. If you opened the <i>room</i>
all entered members will receive the
+ * Send a <i>message</i> into a <i>room</i>. If you opened the <i>room</i> all
entered members will receive the
* <i>message</i>. If you entered the <i>room</i> through a <b>door</b> all so
entered <b>doors</b> will receive the
* <i>message</i> as well. All members receiving the <i>message</i> will also
propagate this <i>message</i> recursively
* as long as the <i>message</i> is unknown to them.
@@ -805,7 +805,7 @@ GNUNET_MESSENGER_contact_get_key (const struct
GNUNET_MESSENGER_Contact *contact
*
* Sending a message to all members in a given room can be done by providing
NULL as contact.
*
- * @param[in/out] room Room handle
+ * @param[in,out] room Room handle
* @param[in] message New message to send
* @param[in] contact Contact or NULL
*/
diff --git a/src/include/gnunet_mq_lib.h b/src/include/gnunet_mq_lib.h
index bf2902707..a06fb4eb7 100644
--- a/src/include/gnunet_mq_lib.h
+++ b/src/include/gnunet_mq_lib.h
@@ -390,9 +390,9 @@ typedef void
* FIFO of envelopes independent of MQ itself and wants to
* re-use the pointers internal to @a env. Use with caution.
*
- * @param[in|out] env_head of envelope DLL
- * @param[in|out] env_tail tail of envelope DLL
- * @param[in|out] env element to insert at the tail
+ * @param[in,out] env_head of envelope DLL
+ * @param[in,out] env_tail tail of envelope DLL
+ * @param[in,out] env element to insert at the tail
*/
void
GNUNET_MQ_dll_insert_head (struct GNUNET_MQ_Envelope **env_head,
@@ -408,9 +408,9 @@ GNUNET_MQ_dll_insert_head (struct GNUNET_MQ_Envelope
**env_head,
* FIFO of envelopes independent of MQ itself and wants to
* re-use the pointers internal to @a env. Use with caution.
*
- * @param[in|out] env_head of envelope DLL
- * @param[in|out] env_tail tail of envelope DLL
- * @param[in|out] env element to insert at the tail
+ * @param[in,out] env_head of envelope DLL
+ * @param[in,out] env_tail tail of envelope DLL
+ * @param[in,out] env element to insert at the tail
*/
void
GNUNET_MQ_dll_insert_tail (struct GNUNET_MQ_Envelope **env_head,
@@ -426,9 +426,9 @@ GNUNET_MQ_dll_insert_tail (struct GNUNET_MQ_Envelope
**env_head,
* FIFO of envelopes independent of MQ itself and wants to
* re-use the pointers internal to @a env. Use with caution.
*
- * @param[in|out] env_head of envelope DLL
- * @param[in|out] env_tail tail of envelope DLL
- * @param[in|out] env element to remove from the DLL
+ * @param[in,out] env_head of envelope DLL
+ * @param[in,out] env_tail tail of envelope DLL
+ * @param[in,out] env element to remove from the DLL
*/
void
GNUNET_MQ_dll_remove (struct GNUNET_MQ_Envelope **env_head,
@@ -601,6 +601,7 @@ struct GNUNET_MQ_MessageHandler
* "context"),
* GNUNET_MQ_handler_end()
* };
+ * </code>
*
* @param name unique basename for the functions
* @param code message type constant
diff --git a/src/include/gnunet_mst_lib.h b/src/include/gnunet_mst_lib.h
index 36b1fd8d5..43a8ab838 100644
--- a/src/include/gnunet_mst_lib.h
+++ b/src/include/gnunet_mst_lib.h
@@ -168,6 +168,8 @@ GNUNET_MST_destroy (struct GNUNET_MessageStreamTokenizer
*mst);
/** @} */ /* end of group server */
-/** @} */ /* end of group addition */
+/** @} */ /* end of group addition to networking */
+
+/** @} */ /* end of group addition to libgnunetutil*/
/* end of gnunet_mst_lib.h */
diff --git a/src/include/gnunet_my_lib.h b/src/include/gnunet_my_lib.h
index 0c95d50d0..96d8cab42 100644
--- a/src/include/gnunet_my_lib.h
+++ b/src/include/gnunet_my_lib.h
@@ -18,6 +18,9 @@
SPDX-License-Identifier: AGPL3.0-or-later
*/
/**
+ * @addtogroup lib_extra
+ * @{
+ *
* @author Christian Grothoff
* @author Christophe Genevey
*
@@ -126,7 +129,7 @@ struct GNUNET_MY_QueryParam
* @a ptr_size bytes.FG
*
* @param ptr pointer to the query parameter to pass
- * @oaran ptr_size number of bytes in @a ptr
+ * @param ptr_size number of bytes in @a ptr
*/
struct GNUNET_MY_QueryParam
GNUNET_MY_query_param_fixed_size (const void *ptr,
@@ -262,7 +265,7 @@ struct GNUNET_MY_ResultSpec
* MySQL, store in already allocated buffer at @a ptr.
*
* @spec ptr where to write the result
- * @oaran ptr_size number of bytes available at @a ptr
+ * @param ptr_size number of bytes available at @a ptr
*/
struct GNUNET_MY_ResultSpec
GNUNET_MY_result_spec_fixed_size (void *ptr,
@@ -271,7 +274,7 @@ GNUNET_MY_result_spec_fixed_size (void *ptr,
/**
* Generate query parameter for a string
*
- *@param ptr pointer to the string query parameter to pass
+ * @param ptr pointer to the string query parameter to pass
*/
struct GNUNET_MY_QueryParam
GNUNET_MY_query_param_string (const char *ptr);
@@ -339,7 +342,7 @@ GNUNET_MY_query_param_uint16 (const uint16_t *x);
/**
* Generate query parameter for an uint32_t in host byte order
*
- *@param x pointer to the query parameter to pass
+ * @param x pointer to the query parameter to pass
*/
struct GNUNET_MY_QueryParam
GNUNET_MY_query_param_uint32 (const uint32_t *x);
@@ -347,7 +350,7 @@ GNUNET_MY_query_param_uint32 (const uint32_t *x);
/**
* Generate query parameter for an uint64_t in host byte order
*
- *@param x pointer to the query parameter to pass
+ * @param x pointer to the query parameter to pass
*/
struct GNUNET_MY_QueryParam
GNUNET_MY_query_param_uint64 (const uint64_t *x);
@@ -367,8 +370,8 @@ GNUNET_MY_query_param_uint64 (const uint64_t *x);
* Variable-size result expected
*
* @param[out] dst where to store the result, allocated
- * @param[out] sptr where to store the size of @a dst
- * @return array entru for the result specification to use
+ * @param[out] ptr_size where to store the size of @a dst
+ * @return array entry for the result specification to use
*/
struct GNUNET_MY_ResultSpec
GNUNET_MY_result_spec_variable_size (void **dst,
@@ -498,3 +501,5 @@ GNUNET_MY_cleanup_result (struct GNUNET_MY_ResultSpec *rs);
#endif
/** @} */ /* end of group */
+
+/** @} */ /* end of group addition to lib_extra */
diff --git a/src/include/gnunet_nat_auto_service.h
b/src/include/gnunet_nat_auto_service.h
index 78284dc01..db3a8460d 100644
--- a/src/include/gnunet_nat_auto_service.h
+++ b/src/include/gnunet_nat_auto_service.h
@@ -26,7 +26,7 @@
* Service for testing and autoconfiguration of
* NAT traversal functionality
*
- * @defgroup nat NAT testing library
+ * @defgroup nat NAT library
*
* @{
*/
diff --git a/src/include/gnunet_nc_lib.h b/src/include/gnunet_nc_lib.h
index 7eef49900..dbd2aa12f 100644
--- a/src/include/gnunet_nc_lib.h
+++ b/src/include/gnunet_nc_lib.h
@@ -104,4 +104,6 @@ GNUNET_notification_context_get_size (struct
GNUNET_NotificationContext *nc);
#endif
+/** @} */ /* end of group mq */
+
/** @} */ /* end of group addition */
diff --git a/src/include/gnunet_nt_lib.h b/src/include/gnunet_nt_lib.h
index 5c3ec86af..144a3daa3 100644
--- a/src/include/gnunet_nt_lib.h
+++ b/src/include/gnunet_nt_lib.h
@@ -18,6 +18,9 @@
SPDX-License-Identifier: AGPL3.0-or-later
*/
/**
+ * @addtogroup Backbone
+ * @{
+ *
* @file network type characterization
* @author Christian Grothoff
* @author Matthias Wachs
@@ -122,3 +125,5 @@ GNUNET_NT_scanner_done (struct GNUNET_NT_InterfaceScanner
*is);
#endif
/** @} */ /* end of group */
+
+/** @} */ /* end of group addition to backbone */
diff --git a/src/include/gnunet_peerinfo_service.h
b/src/include/gnunet_peerinfo_service.h
index 739e7ed24..3be4a6977 100644
--- a/src/include/gnunet_peerinfo_service.h
+++ b/src/include/gnunet_peerinfo_service.h
@@ -142,7 +142,6 @@ struct GNUNET_PEERINFO_IteratorContext;
* @param h handle to the peerinfo service
* @param include_friend_only include HELLO messages for friends only
* @param peer restrict iteration to this peer only (can be NULL)
- * @param timeout how long to wait until timing out
* @param callback the method to call for each peer
* @param callback_cls closure for @a callback
* @return iterator context
diff --git a/src/include/gnunet_peerstore_service.h
b/src/include/gnunet_peerstore_service.h
index deea3ae96..f9b283a9f 100644
--- a/src/include/gnunet_peerstore_service.h
+++ b/src/include/gnunet_peerstore_service.h
@@ -249,6 +249,7 @@ GNUNET_PEERSTORE_store_cancel (struct
GNUNET_PEERSTORE_StoreContext *sc);
* @param key entry key string (can be NULL)
* @param callback function called with each matching record, all NULL's on end
* @param callback_cls closure for @a callback
+ * @return Handle to iteration request
*/
struct GNUNET_PEERSTORE_IterateContext *
GNUNET_PEERSTORE_iterate (struct GNUNET_PEERSTORE_Handle *h,
diff --git a/src/include/gnunet_pq_lib.h b/src/include/gnunet_pq_lib.h
index 7396c6861..d52c0e40d 100644
--- a/src/include/gnunet_pq_lib.h
+++ b/src/include/gnunet_pq_lib.h
@@ -118,7 +118,7 @@ GNUNET_PQ_query_param_null (void);
* @a ptr_size bytes.
*
* @param ptr pointer to the query parameter to pass
- * @oaran ptr_size number of bytes in @a ptr
+ * @param ptr_size number of bytes in @a ptr
* @return query parameter to use
*/
struct GNUNET_PQ_QueryParam
@@ -235,7 +235,7 @@ GNUNET_PQ_query_param_absolute_time_nbo (
*/
struct GNUNET_PQ_QueryParam
GNUNET_PQ_query_param_timestamp_nbo (
- const struct GNUNET_TIME_TimestampNBO *t);
+ const struct GNUNET_TIME_TimestampNBO *x);
/**
@@ -861,7 +861,7 @@ GNUNET_PQ_make_try_execute (const char *sql);
/**
* Request execution of an array of statements @a es from Postgres.
*
- * @param pq database to execute the statements in
+ * @param db database to execute the statements in
* @param es #GNUNET_PQ_PREPARED_STATEMENT_END-terminated array of prepared
* statements.
* @return #GNUNET_OK on success (modulo statements where errors can be
ignored)
@@ -903,14 +903,14 @@ enum GNUNET_PQ_Options
* configuration. Initialize logging via GNUnet's log routines and disable
* Postgres's logger. Also ensures that the statements in @a load_path and @a
* es are executed whenever we (re)connect to the database, and that the
- * prepared statements in @a ps are "ready". If statements in @es fail that
+ * prepared statements in @a ps are "ready". If statements in @a es fail that
* were created with #GNUNET_PQ_make_execute(), then the entire operation
* fails.
*
* In @a load_path, a list of "$XXXX.sql" files is expected where $XXXX
* must be a sequence of contiguous integer values starting at 0000.
* These files are then loaded in sequence using "psql $config_str" before
- * running statements from @e es. The directory is inspected again on
+ * running statements from @a es. The directory is inspected again on
* reconnect.
*
* @param config_str configuration to use
@@ -947,7 +947,7 @@ GNUNET_PQ_exec_sql (struct GNUNET_PQ_Context *db,
* configuration. Initialize logging via GNUnet's log routines and disable
* Postgres's logger. Also ensures that the statements in @a load_path and @a
* es are executed whenever we (re)connect to the database, and that the
- * prepared statements in @a ps are "ready". If statements in @es fail that
+ * prepared statements in @a ps are "ready". If statements in @a es fail that
* were created with #GNUNET_PQ_make_execute(), then the entire operation
* fails.
*
diff --git a/src/include/gnunet_reclaim_lib.h b/src/include/gnunet_reclaim_lib.h
index 0d5ef59b7..35b58cd0e 100644
--- a/src/include/gnunet_reclaim_lib.h
+++ b/src/include/gnunet_reclaim_lib.h
@@ -515,7 +515,7 @@ GNUNET_RECLAIM_attribute_number_to_typename (uint32_t type);
/**
* Get required size for serialization buffer
*
- * @param attrs the attribute list to serialize
+ * @param credentials the attribute list to serialize
* @return the required buffer size
*/
size_t
@@ -524,9 +524,9 @@ GNUNET_RECLAIM_credential_list_serialize_get_size (
/**
- * Destroy claim list
+ * Destroy credential list
*
- * @param attrs list to destroy
+ * @param credentials list to destroy
*/
void
GNUNET_RECLAIM_credential_list_destroy (
@@ -551,15 +551,15 @@ GNUNET_RECLAIM_credential_list_add (
/**
- * Serialize an attribute list
+ * Serialize a credential list
*
- * @param attrs the attribute list to serialize
- * @param result the serialized attribute
+ * @param credentials the credential list to serialize
+ * @param result the serialized credential
* @return length of serialized data
*/
size_t
GNUNET_RECLAIM_credential_list_serialize (
- const struct GNUNET_RECLAIM_CredentialList *attrs,
+ const struct GNUNET_RECLAIM_CredentialList *credentials,
char *result);
diff --git a/src/include/gnunet_reclaim_service.h
b/src/include/gnunet_reclaim_service.h
index 9f348a1cb..e9e0f144d 100644
--- a/src/include/gnunet_reclaim_service.h
+++ b/src/include/gnunet_reclaim_service.h
@@ -200,7 +200,7 @@ GNUNET_RECLAIM_attribute_store (
*
* @param h handle to the re:claimID service
* @param pkey private key of the identity
- * @param attr the credential value
+ * @param credential the credential value
* @param exp_interval the relative expiration interval for the credential
* @param cont continuation to call when done
* @param cont_cls closure for @a cont
@@ -235,7 +235,7 @@ GNUNET_RECLAIM_attribute_delete (
GNUNET_RECLAIM_ContinuationWithStatus cont, void *cont_cls);
/**
- * Delete a credential. Tickets used to share use a presentation of this
+ * Delete a credential. Tickets used to share a presentation of this
* credential are updated accordingly.
*
* @param h handle to the re:claimID service
@@ -349,7 +349,7 @@ GNUNET_RECLAIM_get_credentials_start (
* Calls the record processor specified in
#GNUNET_RECLAIM_get_credentials_start
* for the next record.
*
- * @param it the iterator
+ * @param ait the iterator
*/
void
GNUNET_RECLAIM_get_credentials_next (
@@ -361,7 +361,7 @@ GNUNET_RECLAIM_get_credentials_next (
* be called on any iteration that has not yet completed prior to calling
* #GNUNET_RECLAIM_disconnect.
*
- * @param it the iterator
+ * @param ait the iterator
*/
void
GNUNET_RECLAIM_get_credentials_stop (
diff --git a/src/include/gnunet_resolver_service.h
b/src/include/gnunet_resolver_service.h
index 956e4d67e..80c92dc4e 100644
--- a/src/include/gnunet_resolver_service.h
+++ b/src/include/gnunet_resolver_service.h
@@ -19,6 +19,9 @@
*/
/**
+ * @addtogroup vpn_suite
+ * @{
+ *
* @author Christian Grothoff
*
* @file
@@ -178,4 +181,6 @@ GNUNET_RESOLVER_request_cancel (struct
GNUNET_RESOLVER_RequestHandle *rh);
/** @} */ /* end of group resolver */
+/** @} */ /* end of group addition to vpn_suite */
+
/* end of gnunet_resolver_service.h */
diff --git a/src/include/gnunet_scalarproduct_service.h
b/src/include/gnunet_scalarproduct_service.h
index 1d775f659..7f60bb325 100644
--- a/src/include/gnunet_scalarproduct_service.h
+++ b/src/include/gnunet_scalarproduct_service.h
@@ -179,7 +179,7 @@ GNUNET_SCALARPRODUCT_start_computation (
struct GNUNET_SCALARPRODUCT_ComputationHandle *
GNUNET_SCALARPRODUCT_accept_computation (
const struct GNUNET_CONFIGURATION_Handle *cfg,
- const struct GNUNET_HashCode *key,
+ const struct GNUNET_HashCode *session_key,
const struct GNUNET_SCALARPRODUCT_Element *elements,
uint32_t element_count,
GNUNET_SCALARPRODUCT_ContinuationWithStatus cont,
diff --git a/src/include/gnunet_service_lib.h b/src/include/gnunet_service_lib.h
index 5baa9100e..8c8591af0 100644
--- a/src/include/gnunet_service_lib.h
+++ b/src/include/gnunet_service_lib.h
@@ -282,8 +282,8 @@ GNUNET_SERVICE_run_ (int argc,
* #GNUNET_SERVICE_client_drop().
*
* @param service_name name of the service to run
- * @param options options controlling shutdown of the service
- * @param service_init_cb function to call once the service is ready
+ * @param service_options options controlling shutdown of the service
+ * @param init_cb function to call once the service is ready
* @param connect_cb function to call whenever a client connects
* @param disconnect_cb function to call whenever a client disconnects
* @param cls closure argument for @a service_init_cb, @a connect_cb and @a
disconnect_cb
@@ -449,6 +449,8 @@ GNUNET_SERVICE_client_persist (struct GNUNET_SERVICE_Client
*c);
/** @} */ /* end of group service */
-/** @} */ /* end of group addition */
+/** @} */ /* end of group addition to networking*/
+
+/** @} */ /* end of group addition to libgnunetutil */
/* end of gnunet_service_lib.h */
diff --git a/src/include/gnunet_set_service.h b/src/include/gnunet_set_service.h
index 25e3e9630..255eef265 100644
--- a/src/include/gnunet_set_service.h
+++ b/src/include/gnunet_set_service.h
@@ -368,10 +368,10 @@ GNUNET_SET_add_element (struct GNUNET_SET_Handle *set,
/**
- * Remove an element to the given set.
- * After the element has been removed (in the sense of the
- * request being transmitted to the set service), cont will be called.
- * Calls to remove_element can be queued
+ * Remove an element to the given set.
+ * After the element has been removed (in the sense of the request
+ * being transmitted to the set service), @a cont will be called.
+ * Multiple calls to GNUNET_SET_remove_element() can be queued
*
* @param set set to remove element from
* @param element element to remove from the set
@@ -559,7 +559,7 @@ GNUNET_SET_element_dup (const struct GNUNET_SET_Element
*element);
* Hash a set element.
*
* @param element the element that should be hashed
- * @param ret_hash a pointer to where the hash of @a element
+ * @param[out] ret_hash a pointer to where the hash of @a element
* should be stored
*/
void
diff --git a/src/include/gnunet_setu_service.h
b/src/include/gnunet_setu_service.h
index fb2614bc8..89ac3cd07 100644
--- a/src/include/gnunet_setu_service.h
+++ b/src/include/gnunet_setu_service.h
@@ -291,9 +291,9 @@ GNUNET_SETU_destroy (struct GNUNET_SETU_Handle *set);
/**
- * Prepare a set operation to be evaluated with another peer. The evaluation
- * will not start until the client provides a local set with
- * GNUNET_SETU_commit().
+ * Prepare a set operation to be evaluated with another peer.
+ * The evaluation will not start until the client provides a
+ * local set with GNUNET_SETU_commit().
*
* @param other_peer peer with the other set
* @param app_id hash for the application using the set
diff --git a/src/include/gnunet_socks.h b/src/include/gnunet_socks.h
index 1a6ae1119..b82943da3 100644
--- a/src/include/gnunet_socks.h
+++ b/src/include/gnunet_socks.h
@@ -19,6 +19,9 @@
*/
/**
+ * @addtogroup libgnunetutil
+ * @{
+ *
* @author Jeffrey Burdges
*
* @file
@@ -81,4 +84,6 @@ GNUNET_SOCKS_do_connect (const char *service_name,
/** @} */ /* end of group */
+/** @} */ /* end of group addition to libgnunetutil */
+
/* end of gnunet_socks.h */
diff --git a/src/include/gnunet_sq_lib.h b/src/include/gnunet_sq_lib.h
index 51713e755..3406b9031 100644
--- a/src/include/gnunet_sq_lib.h
+++ b/src/include/gnunet_sq_lib.h
@@ -91,7 +91,7 @@ struct GNUNET_SQ_QueryParam
* @a ptr_size bytes.
*
* @param ptr pointer to the query parameter to pass
- * @oaran ptr_size number of bytes in @a ptr
+ * @param ptr_size number of bytes in @a ptr
*/
struct GNUNET_SQ_QueryParam
GNUNET_SQ_query_param_fixed_size (const void *ptr,
diff --git a/src/include/gnunet_strings_lib.h b/src/include/gnunet_strings_lib.h
index e96888db5..7e06768b8 100644
--- a/src/include/gnunet_strings_lib.h
+++ b/src/include/gnunet_strings_lib.h
@@ -403,7 +403,7 @@ GNUNET_STRINGS_base64_encode (const void *in,
*
* @param data the data to decode
* @param len the length of the input
- * @param output where to write the output (*output should be NULL,
+ * @param out where to write the output (*out should be NULL,
* is allocated)
* @return the size of the output
*/
@@ -448,7 +448,7 @@ GNUNET_STRINGS_base64_decode (const char *data,
*
* @param data the data to decode
* @param len the length of the input
- * @param output where to write the output (*output should be NULL,
+ * @param out where to write the output (*out should be NULL,
* is allocated)
* @return the size of the output
*/
diff --git a/src/include/gnunet_testbed_service.h
b/src/include/gnunet_testbed_service.h
index 29515b7af..ef67ab8ca 100644
--- a/src/include/gnunet_testbed_service.h
+++ b/src/include/gnunet_testbed_service.h
@@ -1030,8 +1030,8 @@ enum GNUNET_TESTBED_TopologyOption
* Configure overall network topology to have a particular shape.
*
* @param op_cls closure argument to give with the operation event
- * @param num_peers number of peers in 'peers'
- * @param peers array of 'num_peers' with the peers to configure
+ * @param num_peers number of peers in @a peers
+ * @param peers array of @a num_peers with the peers to configure
* @param topo desired underlay topology to use
* @param ap topology-specific options
* @return handle to the operation, NULL if configuring the topology
@@ -1052,8 +1052,8 @@ GNUNET_TESTBED_underlay_configure_topology_va (void
*op_cls,
* Configure overall network topology to have a particular shape.
*
* @param op_cls closure argument to give with the operation event
- * @param num_peers number of peers in 'peers'
- * @param peers array of 'num_peers' with the peers to configure
+ * @param num_peers number of peers in @a peers
+ * @param peers array of @a num_peers with the peers to configure
* @param topo desired underlay topology to use
* @param ... topology-specific options
* @return handle to the operation, NULL if configuring the topology
diff --git a/src/include/gnunet_testing_lib.h b/src/include/gnunet_testing_lib.h
index 724382c66..2f64c306b 100644
--- a/src/include/gnunet_testing_lib.h
+++ b/src/include/gnunet_testing_lib.h
@@ -401,7 +401,7 @@ typedef void
* Starts a peer using the given configuration and then invokes the
* given callback. This function ALSO initializes the scheduler loop
* and should thus be called directly from "main". The testcase
- * should self-terminate by invoking 'GNUNET_SCHEDULER_shutdown'.
+ * should self-terminate by invoking #GNUNET_SCHEDULER_shutdown().
*
* @param testdir only the directory name without any path. This is used for
* all service homes; the directory will be created in a temporary
@@ -409,7 +409,7 @@ typedef void
* @param cfgfilename name of the configuration file to use;
* use NULL to only run with defaults
* @param tm main function of the testcase
- * @param tm_cls closure for 'tm'
+ * @param tm_cls closure for @a tm
* @return 0 on success, 1 on error
*/
int
@@ -425,7 +425,7 @@ GNUNET_TESTING_peer_run (const char *testdir,
* Starts a service using the given configuration and then invokes the
* given callback. This function ALSO initializes the scheduler loop
* and should thus be called directly from "main". The testcase
- * should self-terminate by invoking 'GNUNET_SCHEDULER_shutdown'.
+ * should self-terminate by invoking #GNUNET_SCHEDULER_shutdown().
*
* This function is useful if the testcase is for a single service
* and if that service doesn't itself depend on other services.
diff --git a/src/include/gnunet_testing_netjail_lib.h
b/src/include/gnunet_testing_netjail_lib.h
index ea44e030d..f736e1b42 100644
--- a/src/include/gnunet_testing_netjail_lib.h
+++ b/src/include/gnunet_testing_netjail_lib.h
@@ -470,12 +470,11 @@ GNUNET_TESTING_cmd_stop_testing_system (
const char *helper_start_label,
struct GNUNET_TESTING_NetjailTopology *topology);
-
/**
* Create a GNUNET_CMDS_LOCAL_FINISHED message.
*
* @return The GNUNET_CMDS_LOCAL_FINISHED message.
-*/
+ */
struct GNUNET_MessageHeader *
GNUNET_TESTING_send_local_test_finished_msg ();
@@ -546,7 +545,6 @@ GNUNET_TESTING_cmd_local_test_finished (
*
* @param label name for command.
* @param write_message Callback to write messages to the master loop.
- * @param all_local_tests_prepared Flag which will be set from outside.
* @return command.
*/
struct GNUNET_TESTING_Command
diff --git a/src/include/gnunet_testing_ng_lib.h
b/src/include/gnunet_testing_ng_lib.h
index 1bc66e59d..d810a5342 100644
--- a/src/include/gnunet_testing_ng_lib.h
+++ b/src/include/gnunet_testing_ng_lib.h
@@ -415,7 +415,7 @@ GNUNET_TESTING_interpreter_get_current_command (
/**
* Check if the command is running.
*
- * @param cmd The command to check.
+ * @param command The command to check.
* @return GNUNET_NO if the command is not running, GNUNET_YES if it is
running.
*/
enum GNUNET_GenericReturnValue
@@ -425,7 +425,7 @@ GNUNET_TESTING_running (const struct GNUNET_TESTING_Command
*command);
/**
* Check if a command is finished.
*
- * @param cmd The command to check.
+ * @param command The command to check.
* @return GNUNET_NO if the command is not finished, GNUNET_YES if it is
finished.
*/
enum GNUNET_GenericReturnValue
diff --git a/src/include/gnunet_time_lib.h b/src/include/gnunet_time_lib.h
index d753d62f7..e66ce6ea9 100644
--- a/src/include/gnunet_time_lib.h
+++ b/src/include/gnunet_time_lib.h
@@ -242,7 +242,7 @@ GNUNET_TIME_timestamp2s (struct GNUNET_TIME_Timestamp ts);
* Note that the returned value will be overwritten if this function
* is called again.
*
- * @param t the absolute time to convert
+ * @param ts the absolute time to convert
* @return timestamp in human-readable form in local time
*/
const char *
diff --git a/src/include/gnunet_transport_application_service.h
b/src/include/gnunet_transport_application_service.h
index 5767082d9..9a6ddd36a 100644
--- a/src/include/gnunet_transport_application_service.h
+++ b/src/include/gnunet_transport_application_service.h
@@ -27,9 +27,7 @@
* @author Christian Grothoff
* @author Matthias Wachs
*
- * @defgroup TRANSPORT service
- * Bandwidth allocation
- *
+ * @defgroup transport Transport service
* @{
*/
#ifndef GNUNET_TRANSPORT_APPLICATION_SERVICE_H
diff --git a/src/include/gnunet_transport_communication_service.h
b/src/include/gnunet_transport_communication_service.h
index 9b536297e..6c99de78e 100644
--- a/src/include/gnunet_transport_communication_service.h
+++ b/src/include/gnunet_transport_communication_service.h
@@ -138,7 +138,8 @@ typedef void (*GNUNET_TRANSPORT_CommunicatorNotify) (
* Connect to the transport service.
*
* @param cfg configuration to use
- * @param config_section section of the configuration to use for options
+ * @param config_section_name section of the configuration to use for
+ * options
* @param addr_prefix address prefix for addresses supported by this
* communicator, could be NULL for incoming-only communicators
* @param cc what characteristics does the communicator have?
@@ -283,7 +284,7 @@ GNUNET_TRANSPORT_communicator_mq_add (
* Notify transport service that an MQ was updated
*
* @param ch connection to transport service
- * @param qh the queue to update
+ * @param u_qh the queue to update
* @param q_len number of messages that can be send through this queue
* @param priority queue priority. Queues with highest priority should be
* used
diff --git a/src/include/gnunet_transport_service.h
b/src/include/gnunet_transport_service.h
index 99246f136..daa79bf1c 100644
--- a/src/include/gnunet_transport_service.h
+++ b/src/include/gnunet_transport_service.h
@@ -360,8 +360,9 @@ typedef void
* @param cfg configuration to use
* @param peer a specific peer identity to obtain information for,
* NULL for all peers
- * @param one_shot #GNUNET_YES to return the current state and then end (with
- * NULL+NULL), #GNUNET_NO to monitor peers continuously
+ * @param one_shot #GNUNET_YES to return the current state and
+ * then end (with NULL+NULL),
+ * #GNUNET_NO to monitor peers continuously
* @param peer_callback function to call with the results
* @param peer_callback_cls closure for @a peer_callback
*/
diff --git a/src/messenger/gnunet-messenger.c b/src/messenger/gnunet-messenger.c
index e2d106be8..11b0e091a 100644
--- a/src/messenger/gnunet-messenger.c
+++ b/src/messenger/gnunet-messenger.c
@@ -34,7 +34,7 @@ struct GNUNET_MESSENGER_Handle *messenger;
/**
* Function called whenever a message is received or sent.
*
- * @param[in/out] cls Closure
+ * @param[in,out] cls Closure
* @param[in] room Room
* @param[in] sender Sender of message
* @param[in] message Message
@@ -104,7 +104,7 @@ struct GNUNET_SCHEDULER_Task *read_task;
/**
* Task to shut down this application.
*
- * @param[in/out] cls Closure
+ * @param[in,out] cls Closure
*/
static void
shutdown_hook (void *cls)
@@ -144,7 +144,7 @@ int private_mode;
/**
* Task run in stdio mode, after some data is available at stdin.
*
- * @param[in/out] cls Closure
+ * @param[in,out] cls Closure
*/
static void
read_stdio (void *cls)
@@ -184,7 +184,7 @@ read_stdio (void *cls)
/**
* Wait for input on STDIO and send it out over the #ch.
*
- * @param[in/out] cls Closure
+ * @param[in,out] cls Closure
*/
static void
listen_stdio (void *cls)
@@ -205,7 +205,7 @@ listen_stdio (void *cls)
/**
* Initial task to startup application.
*
- * @param[in/out] cls Closure
+ * @param[in,out] cls Closure
*/
static void
idle (void *cls)
@@ -226,8 +226,8 @@ struct GNUNET_SCHEDULER_Task *shutdown_task;
/**
* Function called when an identity is retrieved.
*
- * @param[in/out] cls Closure
- * @param[in/out] handle Handle of messenger service
+ * @param[in,out] cls Closure
+ * @param[in,out] handle Handle of messenger service
*/
static void
on_identity (void *cls,
diff --git a/src/messenger/gnunet-service-messenger_ego_store.h
b/src/messenger/gnunet-service-messenger_ego_store.h
index 4ed2bbf6d..dbe6c05b9 100644
--- a/src/messenger/gnunet-service-messenger_ego_store.h
+++ b/src/messenger/gnunet-service-messenger_ego_store.h
@@ -96,7 +96,7 @@ init_ego_store (struct GNUNET_MESSENGER_EgoStore *store,
/**
* Clears an EGO-store, wipes its content and deallocates its memory.
*
- * @param[in/out] store EGO-store
+ * @param[in,out] store EGO-store
*/
void
clear_ego_store (struct GNUNET_MESSENGER_EgoStore *store);
@@ -105,7 +105,7 @@ clear_ego_store (struct GNUNET_MESSENGER_EgoStore *store);
* Creates a new EGO which will be registered to a <i>store</i> under
* a specific <i>identifier</i>.
*
- * @param[in/out] store EGO-store
+ * @param[in,out] store EGO-store
* @param[in] identifier Identifier string
*/
void
@@ -116,9 +116,9 @@ create_store_ego (struct GNUNET_MESSENGER_EgoStore *store,
* Binds an EGO which was registered to a <i>store</i> under
* a specific <i>identifier</i> to a given <i>handle</i>
*
- * @param[in/out] store EGO-store
+ * @param[in,out] store EGO-store
* @param[in] identifier Identifier string
- * @param[in/out] handle Handle
+ * @param[in,out] handle Handle
*/
void
bind_store_ego (struct GNUNET_MESSENGER_EgoStore *store,
@@ -129,9 +129,9 @@ bind_store_ego (struct GNUNET_MESSENGER_EgoStore *store,
* Binds an EGO which was registered to a <i>store</i> under
* a specific <i>identifier</i> to a given <i>handle</i>
*
- * @param[in/out] store EGO-store
+ * @param[in,out] store EGO-store
* @param[in] identifier Identifier string
- * @param[in/out] handle Handle
+ * @param[in,out] handle Handle
*/
void
unbind_store_ego (struct GNUNET_MESSENGER_EgoStore *store,
@@ -142,7 +142,7 @@ unbind_store_ego (struct GNUNET_MESSENGER_EgoStore *store,
* Lookups an EGO which was registered to a <i>store</i> under
* a specific <i>identifier</i>.
*
- * @param[in/out] store EGO-store
+ * @param[in,out] store EGO-store
* @param[in] identifier Identifier string
* @param[in] lookup Lookup callback (non-NULL)
* @param[in] cls Closure
@@ -157,7 +157,7 @@ lookup_store_ego (struct GNUNET_MESSENGER_EgoStore *store,
* Updates the registration of an EGO to a <i>store</i> under
* a specific <i>identifier</i> with a new <i>key</i>.
*
- * @param[in/out] store EGO-store
+ * @param[in,out] store EGO-store
* @param[in] identifier Identifier string
* @param[in] key Private EGO key
* @return Updated EGO
@@ -171,7 +171,7 @@ update_store_ego (struct GNUNET_MESSENGER_EgoStore *store,
* Deletes the registration of an EGO in a <i>store</i> under
* a specific <i>identifier</i>.
*
- * @param[in/out] store EGO-store
+ * @param[in,out] store EGO-store
* @param[in] identifier Identifier string
*/
void
@@ -180,10 +180,10 @@ delete_store_ego (struct GNUNET_MESSENGER_EgoStore *store,
/**
* Updates the location of a registered EGO in a <i>store</i> to
- * a different one under a specific <i>new_identifier<i> replacing
+ * a different one under a specific <i>new_identifier</i> replacing
* its old one.
*
- * @param[in/out] store EGO-store
+ * @param[in,out] store EGO-store
* @param[in] old_identifier Old identifier string
* @param[in] new_identifier New identifier string
*/
@@ -196,7 +196,7 @@ rename_store_ego (struct GNUNET_MESSENGER_EgoStore *store,
* Replaces the registered EGO in a <i>store</i> under a specific
* <i>identifier</i> with a newly created one.
*
- * @param[in/out] store EGO-store
+ * @param[in,out] store EGO-store
* @param[in] identifier Identifier string
*/
void
diff --git a/src/messenger/gnunet-service-messenger_handle.h
b/src/messenger/gnunet-service-messenger_handle.h
index 8754716e9..c596f4d3b 100644
--- a/src/messenger/gnunet-service-messenger_handle.h
+++ b/src/messenger/gnunet-service-messenger_handle.h
@@ -55,8 +55,8 @@ struct GNUNET_MESSENGER_SrvHandle
/**
* Creates and allocates a new handle related to a <i>service</i> and using a
given <i>mq</i> (message queue).
*
- * @param[in/out] service MESSENGER Service
- * @param[in/out] mq Message queue
+ * @param[in,out] service MESSENGER Service
+ * @param[in,out] mq Message queue
* @return New handle
*/
struct GNUNET_MESSENGER_SrvHandle*
@@ -66,7 +66,7 @@ create_srv_handle (struct GNUNET_MESSENGER_Service *service,
/**
* Destroys a handle and frees its memory fully.
*
- * @param[in/out] handle Handle
+ * @param[in,out] handle Handle
*/
void
destroy_srv_handle (struct GNUNET_MESSENGER_SrvHandle *handle);
@@ -103,7 +103,7 @@ get_srv_handle_member_id (const struct
GNUNET_MESSENGER_SrvHandle *handle,
*
* The client connected to the <i>handle</i> will be informed afterwards
automatically.
*
- * @param[in/out] handle Handle
+ * @param[in,out] handle Handle
* @param[in] key Key of a room
* @param[in] unique_id Unique member id
* @return GNUNET_OK on success, otherwise GNUNET_SYSERR
@@ -116,7 +116,7 @@ change_srv_handle_member_id (struct
GNUNET_MESSENGER_SrvHandle *handle,
/**
* Sets the EGO used by a given <i>handle</i>.
*
- * @param[in/out] handle Handle
+ * @param[in,out] handle Handle
* @param[in] ego EGO key pair
*/
void
@@ -135,7 +135,7 @@ get_srv_handle_ego (const struct GNUNET_MESSENGER_SrvHandle
*handle);
/**
* Tries to set the name and EGO key of a <i>handle</i> initially by looking
up a specific <i>name</i>.
*
- * @param[in/out] handle Handle
+ * @param[in,out] handle Handle
* @param[in] name Name (optionally: valid EGO name)
*/
void
@@ -146,7 +146,7 @@ setup_srv_handle_name (struct GNUNET_MESSENGER_SrvHandle
*handle,
* Tries to change the key pair of an EGO of a <i>handle</i> under the same
name and informs all rooms
* about the change automatically.
*
- * @param[in/out] handle Handle
+ * @param[in,out] handle Handle
*/
void
update_srv_handle (struct GNUNET_MESSENGER_SrvHandle *handle);
@@ -157,7 +157,7 @@ update_srv_handle (struct GNUNET_MESSENGER_SrvHandle
*handle);
*
* The client connected to the <i>handle</i> will be informed afterwards
automatically.
*
- * @param[in/out] handle Handle
+ * @param[in,out] handle Handle
* @param[in] name New name
*/
void
@@ -168,7 +168,7 @@ set_srv_handle_name (struct GNUNET_MESSENGER_SrvHandle
*handle,
* Makes a given <i>handle</i> a member of the room using a specific
<i>key</i> and opens the
* room from the handles service.
*
- * @param[in/out] handle Handle
+ * @param[in,out] handle Handle
* @param[in] key Key of a room
* @return #GNUNET_YES on success, otherwise #GNUNET_NO
*/
@@ -180,7 +180,7 @@ open_srv_handle_room (struct GNUNET_MESSENGER_SrvHandle
*handle,
* Makes a given <i>handle</i> a member of the room using a specific
<i>key</i> and enters the room
* through a tunnel to a peer identified by a given <i>door</i> (peer
identity).
*
- * @param[in/out] handle Handle
+ * @param[in,out] handle Handle
* @param[in] door Peer identity
* @param[in] key Key of a room
* @return #GNUNET_YES on success, otherwise #GNUNET_NO
@@ -194,7 +194,7 @@ entry_srv_handle_room (struct GNUNET_MESSENGER_SrvHandle
*handle,
* Removes the membership of the room using a specific <i>key</i> and closes
it if no other handle
* from this service is still a member of it.
*
- * @param[in/out] handle Handle
+ * @param[in,out] handle Handle
* @param[in] key Key of a room
* @return #GNUNET_YES on success, otherwise #GNUNET_NO
*/
@@ -205,7 +205,7 @@ close_srv_handle_room (struct GNUNET_MESSENGER_SrvHandle
*handle,
/**
* Sends a <i>message</i> from a given <i>handle</i> to the room using a
specific <i>key</i>.
*
- * @param[in/out] handle Handle
+ * @param[in,out] handle Handle
* @param[in] key Key of a room
* @param[in] message Message
* @return #GNUNET_YES on success, #GNUNET_NO or #GNUNET_SYSERR otherwise.
@@ -218,7 +218,7 @@ send_srv_handle_message (struct GNUNET_MESSENGER_SrvHandle
*handle,
/**
* Notifies the handle that a new message was received or sent.
*
- * @param[in/out] handle Handle
+ * @param[in,out] handle Handle
* @param[in] room Room of the message
* @param[in] session Member session
* @param[in] message Message
diff --git a/src/messenger/gnunet-service-messenger_list_handles.h
b/src/messenger/gnunet-service-messenger_list_handles.h
index f4d7ca5c0..f41807d00 100644
--- a/src/messenger/gnunet-service-messenger_list_handles.h
+++ b/src/messenger/gnunet-service-messenger_list_handles.h
@@ -57,7 +57,7 @@ init_list_handles (struct GNUNET_MESSENGER_ListHandles
*handles);
/**
* Destroys remaining <i>handles</i> and clears the list.
*
- * @param[in/out] handles List of handles
+ * @param[in,out] handles List of handles
*/
void
clear_list_handles (struct GNUNET_MESSENGER_ListHandles *handles);
@@ -65,8 +65,8 @@ clear_list_handles (struct GNUNET_MESSENGER_ListHandles
*handles);
/**
* Adds a specific <i>handle</i> to the end of the list.
*
- * @param[in/out] handles List of handles
- * @param[in/out] handle Handle
+ * @param[in,out] handles List of handles
+ * @param[in,out] handle Handle
*/
void
add_list_handle (struct GNUNET_MESSENGER_ListHandles *handles,
@@ -76,8 +76,8 @@ add_list_handle (struct GNUNET_MESSENGER_ListHandles *handles,
* Removes the first entry matching with a specific <i>handle</i> from the
list of
* <i>handles</i> and returns #GNUNET_YES on success or #GNUNET_NO on failure.
*
- * @param[in/out] handles List of handles
- * @param[in/out] handle Handle
+ * @param[in,out] handles List of handles
+ * @param[in,out] handle Handle
* @return #GNUNET_YES on success, otherwise #GNUNET_NO
*/
int
diff --git a/src/messenger/gnunet-service-messenger_list_messages.h
b/src/messenger/gnunet-service-messenger_list_messages.h
index 7abc8c00f..e270209c8 100644
--- a/src/messenger/gnunet-service-messenger_list_messages.h
+++ b/src/messenger/gnunet-service-messenger_list_messages.h
@@ -56,7 +56,7 @@ init_list_messages (struct GNUNET_MESSENGER_ListMessages
*messages);
/**
* Clears the list of message hashes.
*
- * @param[in/out] messages List of hashes
+ * @param[in,out] messages List of hashes
*/
void
clear_list_messages (struct GNUNET_MESSENGER_ListMessages *messages);
@@ -64,7 +64,7 @@ clear_list_messages (struct GNUNET_MESSENGER_ListMessages
*messages);
/**
* Adds a specific <i>hash</i> from a message to the end of the list.
*
- * @param[in/out] messages List of hashes
+ * @param[in,out] messages List of hashes
* @param[in] hash Hash of message
*/
void
@@ -74,7 +74,7 @@ add_to_list_messages (struct GNUNET_MESSENGER_ListMessages
*messages,
/**
* Copies all message hashes from an <i>origin</i> to another list.
*
- * @param[in/out] messages Destination list of hashes
+ * @param[in,out] messages Destination list of hashes
* @param[in] origin Source list of hashes
*/
void
@@ -84,7 +84,7 @@ copy_list_messages (struct GNUNET_MESSENGER_ListMessages
*messages,
/**
* Removes the first entry with a matching <i>hash</i> from the list.
*
- * @param[in/out] messages List of hashes
+ * @param[in,out] messages List of hashes
* @param[in] hash Hash of message
*/
void
diff --git a/src/messenger/gnunet-service-messenger_member.h
b/src/messenger/gnunet-service-messenger_member.h
index 46269315a..0c5870fd3 100644
--- a/src/messenger/gnunet-service-messenger_member.h
+++ b/src/messenger/gnunet-service-messenger_member.h
@@ -47,7 +47,7 @@ struct GNUNET_MESSENGER_Member
*
* If the creation fails, NULL gets returned.
*
- * @param[in/out] store Member store
+ * @param[in,out] store Member store
* @param[in] id Member id or NULL
* @return New member or NULL
*/
@@ -58,7 +58,7 @@ create_member (struct GNUNET_MESSENGER_MemberStore *store,
/**
* Destroys a member and frees its memory fully.
*
- * @param[in/out] member Member
+ * @param[in,out] member Member
*/
void
destroy_member (struct GNUNET_MESSENGER_Member *member);
@@ -88,7 +88,7 @@ load_member (struct GNUNET_MESSENGER_MemberStore *store,
* Loads data about next sessions from a <i>directory</i> into an empty loaded
* <i>member</i> which does not contain a fully built session graph yet.
*
- * @param[in/out] member Member
+ * @param[in,out] member Member
* @param[in] directory Path to a directory
*/
void
@@ -110,7 +110,7 @@ save_member (struct GNUNET_MESSENGER_Member *member,
* Synchronizes contacts between all sessions from a given <i>member</i>
* and other sessions which are linked to them.
*
- * @param[in/out] member Member
+ * @param[in,out] member Member
*/
void
sync_member_contacts (struct GNUNET_MESSENGER_Member *member);
@@ -145,8 +145,8 @@ get_member_session_of (struct GNUNET_MESSENGER_Member
*member,
/**
* Adds a given member <i>session</i> to its <i>member</i>.
*
- * @param[in/out] member Member
- * @param[in/out] session Member session
+ * @param[in,out] member Member
+ * @param[in,out] session Member session
*/
void
add_member_session (struct GNUNET_MESSENGER_Member *member,
@@ -155,8 +155,8 @@ add_member_session (struct GNUNET_MESSENGER_Member *member,
/**
* Removes a given member <i>session</i> from its <i>member</i>.
*
- * @param[in/out] member Member
- * @param[in/out] session Member session
+ * @param[in,out] member Member
+ * @param[in,out] session Member session
*/
void
remove_member_session (struct GNUNET_MESSENGER_Member *member,
@@ -167,9 +167,9 @@ remove_member_session (struct GNUNET_MESSENGER_Member
*member,
* and call the provided iterator callback with a selected closure. The
function
* will return the amount of member sessions it iterated through.
*
- * @param[in/out] member Member
+ * @param[in,out] member Member
* @param[in] it Iterator callback
- * @param[in/out] cls Closure
+ * @param[in,out] cls Closure
* @return Amount of sessions iterated through
*/
int
diff --git a/src/messenger/gnunet-service-messenger_member_session.h
b/src/messenger/gnunet-service-messenger_member_session.h
index 9ba801776..fcde2c3de 100644
--- a/src/messenger/gnunet-service-messenger_member_session.h
+++ b/src/messenger/gnunet-service-messenger_member_session.h
@@ -62,7 +62,7 @@ struct GNUNET_MESSENGER_MemberSession {
*
* If the creation fails, NULL gets returned.
*
- * @param[in/out] member Member
+ * @param[in,out] member Member
* @param[in] pubkey Public key of EGO
* @return New member session
*/
@@ -77,7 +77,7 @@ create_member_session (struct GNUNET_MESSENGER_Member *member,
* <i>message</i> to switch session. The new session will be linked to the old
* one.
*
- * @param[in/out] session Old member session
+ * @param[in,out] session Old member session
* @param[in] message Message
* @param[in] hash Hash of message
* @return New member session
@@ -90,7 +90,7 @@ switch_member_session (struct GNUNET_MESSENGER_MemberSession
*session,
/**
* Destroys a member session and frees its memory fully.
*
- * @param[in/out] session Member session
+ * @param[in,out] session Member session
*/
void
destroy_member_session(struct GNUNET_MESSENGER_MemberSession* session);
@@ -101,7 +101,7 @@ destroy_member_session(struct
GNUNET_MESSENGER_MemberSession* session);
* be dropped. The member sessions messages will be cleared but old
* history from uncompleted sessions however can be reused!
*
- * @param[in/out] session Member session
+ * @param[in,out] session Member session
* @param[in] hash Hash of initial message (JOIN message!)
* @return #GNUNET_OK on success, #GNUNET_SYSERR otherwise
*/
@@ -116,7 +116,7 @@ reset_member_session (struct
GNUNET_MESSENGER_MemberSession* session,
* Closing a session may complete a session and can't be used without
* a reset! ( @see #reset_member_session() )
*
- * @param[in/out] session Member session
+ * @param[in,out] session Member session
*/
void
close_member_session (struct GNUNET_MESSENGER_MemberSession* session);
@@ -234,7 +234,7 @@ check_member_session_history (const struct
GNUNET_MESSENGER_MemberSession *sessi
*
* @see #is_member_session_completed() for updating a history.
*
- * @param[in/out] session Member session
+ * @param[in,out] session Member session
* @param[in] message Message
* @param[in] hash Hash of message
*/
@@ -247,7 +247,7 @@ update_member_session_history (struct
GNUNET_MESSENGER_MemberSession *session,
* Removes a message from the history of a <i>session</i> using the messages
* <i>hash</i>.
*
- * @param[in/out] session Member session
+ * @param[in,out] session Member session
* @param[in] hash Hash of message
*/
void
@@ -271,7 +271,7 @@ load_member_session (struct GNUNET_MESSENGER_Member *member,
* next attribute. Necessary information will be loaded from a configuration
* file inside of a given <i>directory</i>.
*
- * @param[in/out] session Member session
+ * @param[in,out] session Member session
* @param[in] directory Path to a directory
*/
void
diff --git a/src/messenger/gnunet-service-messenger_member_store.h
b/src/messenger/gnunet-service-messenger_member_store.h
index af50f0d36..c3f6d478a 100644
--- a/src/messenger/gnunet-service-messenger_member_store.h
+++ b/src/messenger/gnunet-service-messenger_member_store.h
@@ -62,7 +62,7 @@ init_member_store (struct GNUNET_MESSENGER_MemberStore *store,
/**
* Clears a member <i>store</i>, wipes its content and deallocates its memory.
*
- * @param[in/out] store Member store
+ * @param[in,out] store Member store
*/
void
clear_member_store (struct GNUNET_MESSENGER_MemberStore *store);
@@ -70,7 +70,7 @@ clear_member_store (struct GNUNET_MESSENGER_MemberStore
*store);
/**
* Returns the used contact store of a given member <i>store</i>.
*
- * @param[in/out] store Member store
+ * @param[in,out] store Member store
* @return Contact store
*/
struct GNUNET_MESSENGER_ContactStore*
@@ -121,7 +121,7 @@ get_store_member (const struct GNUNET_MESSENGER_MemberStore
*store,
* Returns the member of a <i>store</i> using a sender id of a given
<i>message</i>.
* If the member does not provide a matching session, NULL gets returned.
*
- * @param[in/out] store Member store
+ * @param[in,out] store Member store
* @param[in] message Message
* @return Member or NULL
*/
@@ -132,7 +132,7 @@ get_store_member_of (struct GNUNET_MESSENGER_MemberStore
*store,
/**
* Adds a member to a <i>store</i> under a specific <i>id</i> and returns it
on success.
*
- * @param[in/out] store Member store
+ * @param[in,out] store Member store
* @param[in] id Member id
* @return Member or NULL
*/
@@ -145,9 +145,9 @@ add_store_member (struct GNUNET_MESSENGER_MemberStore
*store,
* member <i>store</i> and call the provided iterator callback with a selected
closure.
* The function will return the amount of members it iterated through.
*
- * @param[in/out] store Member store
+ * @param[in,out] store Member store
* @param[in] it Iterator callback
- * @param[in/out] cls Closure
+ * @param[in,out] cls Closure
* @return Amount of members iterated through
*/
int
diff --git a/src/messenger/gnunet-service-messenger_message_handle.h
b/src/messenger/gnunet-service-messenger_message_handle.h
index 0e5be3408..62940e6b6 100644
--- a/src/messenger/gnunet-service-messenger_message_handle.h
+++ b/src/messenger/gnunet-service-messenger_message_handle.h
@@ -39,8 +39,8 @@
* Handles a received or sent join message to make changes of current member
information.
* (add matching member and clear member info)
*
- * @param[in/out] room Room of the message
- * @param[in/out] session Member session
+ * @param[in,out] room Room of the message
+ * @param[in,out] session Member session
* @param[in] message JOIN-Message
* @param[in] hash Hash of the message
*/
@@ -54,8 +54,8 @@ handle_message_join (struct GNUNET_MESSENGER_SrvRoom *room,
* Handles a received or sent leave message to make changes of current member
information.
* (remove matching member and clear member info)
*
- * @param[in/out] room Room of the message
- * @param[in/out] session Member session
+ * @param[in,out] room Room of the message
+ * @param[in,out] session Member session
* @param[in] message LEAVE-Message
* @param[in] hash Hash of the message
*/
@@ -69,8 +69,8 @@ handle_message_leave (struct GNUNET_MESSENGER_SrvRoom *room,
* Handles a received or sent name message to rename a current member.
* (change name of matching member)
*
- * @param[in/out] room Room of the message
- * @param[in/out] session Member session
+ * @param[in,out] room Room of the message
+ * @param[in,out] session Member session
* @param[in] message NAME-Message
* @param[in] hash Hash of the message
*/
@@ -84,8 +84,8 @@ handle_message_name (struct GNUNET_MESSENGER_SrvRoom *room,
* Handles a received or sent key message to change the key of a member and
rearrange the contacts accordingly.
* (move the member in the contacts and change its key)
*
- * @param[in/out] room Room of the message
- * @param[in/out] session Member session
+ * @param[in,out] room Room of the message
+ * @param[in,out] session Member session
* @param[in] message KEY-Message
* @param[in] hash Hash of the message
*/
@@ -99,8 +99,8 @@ handle_message_key (struct GNUNET_MESSENGER_SrvRoom *room,
* Handles a received or sent peer message to make changes of the basement in
the room.
* (add a new peer to the basement and restructure connections based on
updated list of peers)
*
- * @param[in/out] room Room of the message
- * @param[in/out] session Member session
+ * @param[in,out] room Room of the message
+ * @param[in,out] session Member session
* @param[in] message PEER-Message
* @param[in] hash Hash of the message
*/
@@ -114,8 +114,8 @@ handle_message_peer (struct GNUNET_MESSENGER_SrvRoom *room,
* Handles a received or sent id message to change a members id.
* (change id of matching member)
*
- * @param[in/out] room Room of the message
- * @param[in/out] session Member session
+ * @param[in,out] room Room of the message
+ * @param[in,out] session Member session
* @param[in] message ID-Message
* @param[in] hash Hash of the message
*/
@@ -129,8 +129,8 @@ handle_message_id (struct GNUNET_MESSENGER_SrvRoom *room,
* Handles a received or sent miss message to drop a peer from the basement in
the room.
* (remove a peer from the basement and restructure connections based on
updated list of peers)
*
- * @param[in/out] room Room of the message
- * @param[in/out] session Member session
+ * @param[in,out] room Room of the message
+ * @param[in,out] session Member session
* @param[in] message MISS-Message
* @param[in] hash Hash of the message
*/
@@ -144,8 +144,8 @@ handle_message_miss (struct GNUNET_MESSENGER_SrvRoom *room,
* Handles a received or sent delete message to delete a specific message from
the store.
* (remove a message from the store of a room under a given delay)
*
- * @param[in/out] room Room of the message
- * @param[in/out] session Member session
+ * @param[in,out] room Room of the message
+ * @param[in,out] session Member session
* @param[in] message DELETE-Message
* @param[in] hash Hash of the message
*/
diff --git a/src/messenger/gnunet-service-messenger_message_kind.h
b/src/messenger/gnunet-service-messenger_message_kind.h
index 508f19074..d07680dfc 100644
--- a/src/messenger/gnunet-service-messenger_message_kind.h
+++ b/src/messenger/gnunet-service-messenger_message_kind.h
@@ -150,7 +150,7 @@ create_message_invite (const struct GNUNET_PeerIdentity
*door,
const struct GNUNET_HashCode *key);
/**
- * Creates and allocates a new <i>text message containing a string
representing text.
+ * Creates and allocates a new <i>text</i> message containing a string
representing text.
* (all values are stored as copy)
*
* @param[in] text Text
diff --git a/src/messenger/gnunet-service-messenger_message_recv.h
b/src/messenger/gnunet-service-messenger_message_recv.h
index 400c10245..b4304762b 100644
--- a/src/messenger/gnunet-service-messenger_message_recv.h
+++ b/src/messenger/gnunet-service-messenger_message_recv.h
@@ -39,8 +39,8 @@
* Handles a received info message to change the current member id to the one
generated by
* the host connected to. (all current tunnels will be informed about the id
change)
*
- * @param[in/out] room Room of the message
- * @param[in/out] tunnel Receiving connection
+ * @param[in,out] room Room of the message
+ * @param[in,out] tunnel Receiving connection
* @param[in] message INFO-Message
* @param[in] hash Hash of the message
* @return #GNUNET_NO to not forward the message
@@ -55,8 +55,8 @@ recv_message_info (struct GNUNET_MESSENGER_SrvRoom *room,
* Handles a received peer message to link it to its origin tunnel if the peer
identity matches.
* (the peer message and the member id can potentially be linked to the tunnel)
*
- * @param[in/out] room Room of the message
- * @param[in/out] tunnel Receiving connection
+ * @param[in,out] room Room of the message
+ * @param[in,out] tunnel Receiving connection
* @param[in] message PEER-Message
* @param[in] hash Hash of the message
* @return #GNUNET_YES to forward the message
@@ -72,8 +72,8 @@ recv_message_peer (struct GNUNET_MESSENGER_SrvRoom *room,
* if the message was found.
* (this can also cause this peer to send a new request instead of only
forwarding the received one)
*
- * @param[in/out] room Room of the message
- * @param[in/out] tunnel Receiving connection
+ * @param[in,out] room Room of the message
+ * @param[in,out] tunnel Receiving connection
* @param[in] message REQUEST-Message
* @param[in] hash Hash of the message
* @return #GNUNET_YES or #GNUNET_NO depending on required forwarding
diff --git a/src/messenger/gnunet-service-messenger_message_send.h
b/src/messenger/gnunet-service-messenger_message_send.h
index 232355c41..8d782c5a6 100644
--- a/src/messenger/gnunet-service-messenger_message_send.h
+++ b/src/messenger/gnunet-service-messenger_message_send.h
@@ -38,8 +38,8 @@
* Handles a sent join message to ensure growth of the decentralized room
structure.
* (if the service provides a peer message for this room currently, it will be
forwarded)
*
- * @param[in/out] room Room of the message
- * @param[in/out] handle Sending handle
+ * @param[in,out] room Room of the message
+ * @param[in,out] handle Sending handle
* @param[in] message JOIN-Message
* @param[in] hash Hash of the message
*/
@@ -53,8 +53,8 @@ send_message_join (struct GNUNET_MESSENGER_SrvRoom *room,
* Handles a sent peer message to update the rooms peer message of this
service.
* (a set peer message indicates this service being a part of the
decentralized room structure)
*
- * @param[in/out] room Room of the message
- * @param[in/out] handle Sending handle
+ * @param[in,out] room Room of the message
+ * @param[in,out] handle Sending handle
* @param[in] message PEER-Message
* @param[in] hash Hash of the message
*/
@@ -68,8 +68,8 @@ send_message_peer (struct GNUNET_MESSENGER_SrvRoom *room,
* Handles a sent id message to update the handles member id in the room.
* (changing member id is useful to prevent collisions)
*
- * @param[in/out] room Room of the message
- * @param[in/out] handle Sending handle
+ * @param[in,out] room Room of the message
+ * @param[in,out] handle Sending handle
* @param[in] message ID-Message
* @param[in] hash Hash of the message
*/
@@ -83,8 +83,8 @@ send_message_id (struct GNUNET_MESSENGER_SrvRoom *room,
* Handles a sent request message to trigger the request operation for this
service.
* (the request operation will deactivate the possibility of spamming requests)
*
- * @param[in/out] room Room of the message
- * @param[in/out] handle Sending handle
+ * @param[in,out] room Room of the message
+ * @param[in,out] handle Sending handle
* @param[in] message PEER-Message
* @param[in] hash Hash of the message
*/
diff --git a/src/messenger/gnunet-service-messenger_message_store.h
b/src/messenger/gnunet-service-messenger_message_store.h
index 476d98dd5..60efb1380 100644
--- a/src/messenger/gnunet-service-messenger_message_store.h
+++ b/src/messenger/gnunet-service-messenger_message_store.h
@@ -69,7 +69,7 @@ init_message_store (struct GNUNET_MESSENGER_MessageStore
*store);
/**
* Clears a message <i>store</i>, wipes its content and deallocates its memory.
*
- * @param[in/out] store Message store
+ * @param[in,out] store Message store
*/
void
clear_message_store (struct GNUNET_MESSENGER_MessageStore *store);
@@ -115,7 +115,7 @@ contains_store_message (const struct
GNUNET_MESSENGER_MessageStore *store,
* This function requires the message to be loaded into memory!
* @see contains_store_message()
*
- * @param[in/out] store Message store
+ * @param[in,out] store Message store
* @param[in] hash Hash of message
* @return Message or NULL
*/
@@ -131,7 +131,7 @@ get_store_message (struct GNUNET_MESSENGER_MessageStore
*store,
* hash. The link which will be returned copies link information from the
message for
* temporary usage.
*
- * @param[in/out] store Message store
+ * @param[in,out] store Message store
* @param[in] hash Hash of message
* @param[in] deleted_only Flag
* @return Message link or NULL
@@ -144,9 +144,9 @@ get_store_message_link (struct
GNUNET_MESSENGER_MessageStore *store,
/**
* Stores a message into the message store. The result indicates if the
operation was successful.
*
- * @param[in/out] store Message store
+ * @param[in,out] store Message store
* @param[in] hash Hash of message
- * @param[in/out] message Message
+ * @param[in,out] message Message
* @return #GNUNET_OK on success, otherwise #GNUNET_NO
*/
int
@@ -158,7 +158,7 @@ put_store_message (struct GNUNET_MESSENGER_MessageStore
*store,
* Deletes a message in the message store. It will be removed from disk space
and memory. The result
* indicates if the operation was successful.
*
- * @param[in/out] store Message store
+ * @param[in,out] store Message store
* @param[in] hash Hash of message
* @return #GNUNET_OK on success, #GNUNET_SYSERR on failure
*/
diff --git a/src/messenger/gnunet-service-messenger_operation.h
b/src/messenger/gnunet-service-messenger_operation.h
index 485668548..8d09ed1b7 100644
--- a/src/messenger/gnunet-service-messenger_operation.h
+++ b/src/messenger/gnunet-service-messenger_operation.h
@@ -66,7 +66,7 @@ create_operation (const struct GNUNET_HashCode *hash);
/**
* Destroys an operation and frees its memory fully.
*
- * @param[in/out] op Operation
+ * @param[in,out] op Operation
*/
void
destroy_operation (struct GNUNET_MESSENGER_Operation *op);
@@ -82,7 +82,7 @@ destroy_operation (struct GNUNET_MESSENGER_Operation *op);
* If the method fails to restore any valid operation from the file,
* NULL gets returned instead.
*
- * @param[in/out] store Operation store
+ * @param[in,out] store Operation store
* @param[in] path Path of a configuration file
*/
struct GNUNET_MESSENGER_Operation*
@@ -107,9 +107,9 @@ save_operation (const struct GNUNET_MESSENGER_Operation *op,
* operations type to process it correctly. An operation can't be
* started twice, it has to be stopped or fully processed first.
*
- * @param[in/out] op Operation
+ * @param[in,out] op Operation
* @param[in] type Type of operation
- * @param[in/out] store Operation store
+ * @param[in,out] store Operation store
* @param[in] delay Delay
* @return #GNUNET_OK on success, otherwise #GNUNET_SYSERR
*/
diff --git a/src/messenger/gnunet-service-messenger_operation_store.h
b/src/messenger/gnunet-service-messenger_operation_store.h
index 18eb7f8a1..db315f251 100644
--- a/src/messenger/gnunet-service-messenger_operation_store.h
+++ b/src/messenger/gnunet-service-messenger_operation_store.h
@@ -45,7 +45,7 @@ struct GNUNET_MESSENGER_OperationStore
* Initializes an operation <i>store</i> as fully empty with a given
<i>room</i>.
*
* @param[out] store Operation store
- * @param[in/out] room Room
+ * @param[in,out] room Room
*/
void
init_operation_store (struct GNUNET_MESSENGER_OperationStore *store,
@@ -54,7 +54,7 @@ init_operation_store (struct GNUNET_MESSENGER_OperationStore
*store,
/**
* Clears an operation <i>store</i>, stops all operations and deallocates its
memory.
*
- * @param[in/out] store Operation store
+ * @param[in,out] store Operation store
*/
void
clear_operation_store (struct GNUNET_MESSENGER_OperationStore *store);
@@ -103,7 +103,7 @@ get_store_operation_type (const struct
GNUNET_MESSENGER_OperationStore *store,
* If the new operation could be started successfully the method returns
* #GNUNET_OK, otherwise #GNUNET_SYSERR.
*
- * @param[in/out] store Operation store
+ * @param[in,out] store Operation store
* @param[in] hash Hash of message
* @param[in] type Operation type
* @param[in] delay Delay
@@ -122,7 +122,7 @@ use_store_operation (struct GNUNET_MESSENGER_OperationStore
*store,
* Beware that calling this method will also implicitly free the memory
* of any active operation under the given hash!
*
- * @param[in/out] store Operation store
+ * @param[in,out] store Operation store
* @param[in] hash Hash of message
*/
void
diff --git a/src/messenger/gnunet-service-messenger_room.h
b/src/messenger/gnunet-service-messenger_room.h
index a6ae45275..6767d96cb 100644
--- a/src/messenger/gnunet-service-messenger_room.h
+++ b/src/messenger/gnunet-service-messenger_room.h
@@ -84,7 +84,7 @@ struct GNUNET_MESSENGER_SrvRoom
/**
* Creates and allocates a new room for a <i>handle</i> with a given
<i>key</i>.
*
- * @param[in/out] handle Handle
+ * @param[in,out] handle Handle
* @param[in] key Key of room
* @return New room
*/
@@ -98,7 +98,7 @@ create_srv_room (struct GNUNET_MESSENGER_SrvHandle *handle,
* The <i>deletion</i> flag should only be set to #GNUNET_YES if the
* room gets dropped by the service, otherwise #GNUNET_NO.
*
- * @param[in/out] room Room
+ * @param[in,out] room Room
* @param[in] deletion Flag to indicate context of destruction
*/
void
@@ -108,7 +108,7 @@ destroy_srv_room (struct GNUNET_MESSENGER_SrvRoom *room,
/**
* Returns the used member store of a given <i>room</i>.
*
- * @param[in/out] room Room
+ * @param[in,out] room Room
* @return Member store
*/
struct GNUNET_MESSENGER_MemberStore*
@@ -117,7 +117,7 @@ get_srv_room_member_store (struct GNUNET_MESSENGER_SrvRoom
*room);
/**
* Returns the used message store of a given <i>room</i>.
*
- * @param[in/out] room Room
+ * @param[in,out] room Room
* @return Message store
*/
struct GNUNET_MESSENGER_MessageStore*
@@ -126,7 +126,7 @@ get_srv_room_message_store (struct GNUNET_MESSENGER_SrvRoom
*room);
/**
* Returns the used operation store of a given <i>room</i>.
*
- * @param[in/out] room Room
+ * @param[in,out] room Room
* @return Operation store
*/
struct GNUNET_MESSENGER_OperationStore*
@@ -140,8 +140,8 @@ get_srv_room_operation_store (struct
GNUNET_MESSENGER_SrvRoom *room);
*
* If the function returns #GNUNET_YES the port for this room is guaranteed to
be open for incoming connections.
*
- * @param[in/out] room Room
- * @param[in/out] handle Handle
+ * @param[in,out] room Room
+ * @param[in,out] handle Handle
* @return #GNUNET_YES on success, #GNUNET_NO on failure.
*/
int
@@ -153,8 +153,8 @@ open_srv_room (struct GNUNET_MESSENGER_SrvRoom *room,
* a peer identity of a hosting peer. During the connection the handle will
join the room as a member, waiting for
* an info message from the selected host.
*
- * @param[in/out] room Room
- * @param[in/out] handle Handle
+ * @param[in,out] room Room
+ * @param[in,out] handle Handle
* @param[in] door Peer identity
* @return #GNUNET_YES on success, #GNUNET_NO on failure.
*/
@@ -175,7 +175,7 @@ enter_srv_room_at (struct GNUNET_MESSENGER_SrvRoom *room,
*
* @param[in] room Room
* @param[in] handle Handle
- * @param[in/out] message Message
+ * @param[in,out] message Message
* @param[out] hash Hash of message
* @param[in] mode Packing mode
* @return New envelope or NULL
@@ -197,9 +197,9 @@ pack_srv_room_message (const struct
GNUNET_MESSENGER_SrvRoom *room,
* The function returns #GNUNET_YES on success, #GNUNET_NO if message is null
and
* #GNUNET_SYSERR if the message was known already.
*
- * @param[in/out] room Room
- * @param[in/out] handle Handle
- * @param[in/out] message Message
+ * @param[in,out] room Room
+ * @param[in,out] handle Handle
+ * @param[in,out] message Message
* @return #GNUNET_YES on success, #GNUNET_NO or #GNUNET_SYSERR otherwise.
*/
int
@@ -210,9 +210,9 @@ send_srv_room_message (struct GNUNET_MESSENGER_SrvRoom
*room,
/**
* Forwards a <i>message</i> with a given <i>hash</i> to a specific
<i>tunnel</i> inside of a <i>room</i>.
*
- * @param[in/out] room Room
- * @param[in/out] tunnel Tunnel
- * @param[in/out] message Message
+ * @param[in,out] room Room
+ * @param[in,out] tunnel Tunnel
+ * @param[in,out] message Message
* @param[in] hash Hash of message
*/
void
@@ -226,8 +226,8 @@ forward_srv_room_message (struct GNUNET_MESSENGER_SrvRoom
*room,
* if necessary to a selected <i>tunnel</i> or to all connected tunnels if
necessary or if the
* selected tunnel is NULL.
*
- * @param[in/out] room Room
- * @param[in/out] tunnel Tunnel
+ * @param[in,out] room Room
+ * @param[in,out] tunnel Tunnel
*/
void
check_srv_room_peer_status (struct GNUNET_MESSENGER_SrvRoom *room,
@@ -237,8 +237,8 @@ check_srv_room_peer_status (struct GNUNET_MESSENGER_SrvRoom
*room,
* Reduces all current forks inside of the message history of a <i>room</i> to
one remaining last message
* by merging them down. All merge messages will be sent from a given
<i>handle</i>.
*
- * @param[in/out] room Room
- * @param[in/out] handle Handle
+ * @param[in,out] room Room
+ * @param[in,out] handle Handle
*/
void
merge_srv_room_last_messages (struct GNUNET_MESSENGER_SrvRoom *room,
@@ -248,8 +248,8 @@ merge_srv_room_last_messages (struct
GNUNET_MESSENGER_SrvRoom *room,
* Deletes a message from the <i>room</i> with a given <i>hash</i> in a
specific <i>delay</i> if
* the provided member by its session is permitted to do so.
*
- * @param[in/out] room Room
- * @param[in/out] session Member session
+ * @param[in,out] room Room
+ * @param[in,out] session Member session
* @param[in] hash Hash of message
* @param[in] delay Delay of deletion
* @return #GNUNET_YES on success, #GNUNET_NO if permission gets denied,
#GNUNET_SYSERR on operation failure
@@ -263,7 +263,7 @@ delete_srv_room_message (struct GNUNET_MESSENGER_SrvRoom
*room,
/**
* Returns the CADET handle from a rooms service.
*
- * @param[in/out] room Room
+ * @param[in,out] room Room
* @return CADET handle
*/
struct GNUNET_CADET_Handle*
@@ -293,8 +293,8 @@ get_srv_room_tunnel (const struct GNUNET_MESSENGER_SrvRoom
*room,
/**
* Method called whenever a <i>message</i> is found during a request in a
<i>room</i>.
*
- * @param[in/out] cls Closure from #request_room_message
- * @param[in/out] room Room
+ * @param[in,out] cls Closure from #request_room_message
+ * @param[in,out] room Room
* @param[in] message Message or NULL
* @param[in] hash Hash of message
*/
@@ -314,7 +314,7 @@ typedef void (GNUNET_MESSENGER_MessageRequestCallback) (
* It is also possible that the given callback will not be called if the
requesting session is not
* permitted!
*
- * @param[in/out] room Room
+ * @param[in,out] room Room
* @param[in] hash Hash of message
* @param[in] callback Callback to process result
* @param[in] cls Closure for the <i>callback</i>
@@ -331,7 +331,7 @@ request_srv_room_message (struct GNUNET_MESSENGER_SrvRoom
*room,
* Checks for potential collisions with member ids and solves them changing
active handles ids if they
* use an already used member id (comparing public key and timestamp).
*
- * @param[in/out] room Room
+ * @param[in,out] room Room
* @param[in] public_key Public key of EGO
* @param[in] member_id Member ID
* @param[in] timestamp Timestamp
@@ -346,7 +346,7 @@ solve_srv_room_member_collisions (struct
GNUNET_MESSENGER_SrvRoom *room,
* Rebuilds the decentralized structure for a <i>room</i> by ensuring all
required connections are made
* depending on the amount of peers and this peers index in the list of them.
*
- * @param[in/out] room Room
+ * @param[in,out] room Room
*/
void
rebuild_srv_room_basement_structure (struct GNUNET_MESSENGER_SrvRoom *room);
diff --git a/src/messenger/gnunet-service-messenger_service.h
b/src/messenger/gnunet-service-messenger_service.h
index d364a93c0..55e8b6c50 100644
--- a/src/messenger/gnunet-service-messenger_service.h
+++ b/src/messenger/gnunet-service-messenger_service.h
@@ -64,7 +64,7 @@ struct GNUNET_MESSENGER_Service
* Creates and allocates a new service using a given <i>config</i> and a
GNUnet service handle.
*
* @param[in] config Configuration
- * @param[in/out] service_handle GNUnet service handle
+ * @param[in,out] service_handle GNUnet service handle
* @return New service
*/
struct GNUNET_MESSENGER_Service*
@@ -74,7 +74,7 @@ create_service (const struct GNUNET_CONFIGURATION_Handle
*config,
/**
* Destroys a <i>service</i> and frees its memory fully.
*
- * @param[in/out] service Service
+ * @param[in,out] service Service
*/
void
destroy_service (struct GNUNET_MESSENGER_Service *service);
@@ -82,7 +82,7 @@ destroy_service (struct GNUNET_MESSENGER_Service *service);
/**
* Returns the used EGO-store of a given <i>service</i>.
*
- * @param[in/out] service Service
+ * @param[in,out] service Service
* @return EGO-store
*/
struct GNUNET_MESSENGER_EgoStore*
@@ -91,7 +91,7 @@ get_service_ego_store (struct GNUNET_MESSENGER_Service
*service);
/**
* Returns the used contact store of a given <i>service</i>.
*
- * @param[in/out] service Service
+ * @param[in,out] service Service
* @return Contact store
*/
struct GNUNET_MESSENGER_ContactStore*
@@ -100,8 +100,8 @@ get_service_contact_store (struct GNUNET_MESSENGER_Service
*service);
/**
* Creates and adds a new handle to a <i>service</i> using a given message
queue.
*
- * @param[in/out] service Service
- * @param[in/out] mq Message queue
+ * @param[in,out] service Service
+ * @param[in,out] mq Message queue
* @return New handle
*/
struct GNUNET_MESSENGER_SrvHandle*
@@ -111,8 +111,8 @@ add_service_handle (struct GNUNET_MESSENGER_Service
*service,
/**
* Removes a <i>handle</i> from a <i>service</i> and destroys it.
*
- * @param[in/out] service Service
- * @param[in/out] handle Handle
+ * @param[in,out] service Service
+ * @param[in,out] handle Handle
*/
void
remove_service_handle (struct GNUNET_MESSENGER_Service *service,
@@ -146,8 +146,8 @@ get_service_room (const struct GNUNET_MESSENGER_Service
*service,
* Tries to open a room using a given <i>key</i> for a <i>service</i> by a
specific <i>handle</i>. The room will be
* created if necessary. If the function is successful, it returns
#GNUNET_YES, otherwise #GNUNET_NO.
*
- * @param[in/out] service Service
- * @param[in/out] handle Handle
+ * @param[in,out] service Service
+ * @param[in,out] handle Handle
* @param[in] key Key of room
* @return #GNUNET_YES on success, otherwise #GNUNET_NO
*/
@@ -163,8 +163,8 @@ open_service_room (struct GNUNET_MESSENGER_Service *service,
* The room will be entered through the peer identitied by the peer identity
provided as <i>door</i> parameter and
* a new connection will be made.
*
- * @param[in/out] service Service
- * @param[in/out] handle Handle
+ * @param[in,out] service Service
+ * @param[in,out] handle Handle
* @param[in] door Peer identity
* @param[in] key Key of room
* @return #GNUNET_YES on success, otherwise #GNUNET_NO
@@ -182,8 +182,8 @@ entry_service_room (struct GNUNET_MESSENGER_Service
*service,
* If the specific handle is currently the host of the room for this service,
a new handle which is a member will
* take its place. Otherwise the room will be destroyed for this service.
*
- * @param[in/out] service Service
- * @param[in/out] handle Handle
+ * @param[in,out] service Service
+ * @param[in,out] handle Handle
* @param[in] key Key of room
* @return #GNUNET_YES on success, otherwise #GNUNET_NO
*/
@@ -196,8 +196,8 @@ close_service_room (struct GNUNET_MESSENGER_Service
*service,
* Sends a received or sent <i>message</i> with a given <i>hash</i> to each
handle of a <i>service</i> which
* is currently member of a specific <i>room</i> for handling it in the client
API.
*
- * @param[in/out] service Service
- * @param[in/out] room Room
+ * @param[in,out] service Service
+ * @param[in,out] room Room
* @param[in] session Member session
* @param[in] message Message
* @param[in] hash Hash of message
diff --git a/src/messenger/gnunet-service-messenger_tunnel.h
b/src/messenger/gnunet-service-messenger_tunnel.h
index 7bd749281..13cf924f9 100644
--- a/src/messenger/gnunet-service-messenger_tunnel.h
+++ b/src/messenger/gnunet-service-messenger_tunnel.h
@@ -50,7 +50,7 @@ struct GNUNET_MESSENGER_SrvTunnel
/**
* Creates and allocates a tunnel of a <i>room</i> to a specific peer identity
(called <i>door</i>).
*
- * @param[in/out] room Room
+ * @param[in,out] room Room
* @param[in] door Peer identity
* @return New tunnel
*/
@@ -61,7 +61,7 @@ create_tunnel (struct GNUNET_MESSENGER_SrvRoom *room,
/**
* Destroys a <i>tunnel</i> and frees its memory fully.
*
- * @param[in/out] tunnel
+ * @param[in,out] tunnel
*/
void
destroy_tunnel (struct GNUNET_MESSENGER_SrvTunnel *tunnel);
@@ -70,8 +70,8 @@ destroy_tunnel (struct GNUNET_MESSENGER_SrvTunnel *tunnel);
* Binds a CADET <i>channel</i> to a <i>tunnel</i> and replaces its channel
* the tunnel is currently bound to if necessary.
*
- * @param[in/out] tunnel Tunnel
- * @param[in/out] channel CADET channel
+ * @param[in,out] tunnel Tunnel
+ * @param[in,out] channel CADET channel
*/
void
bind_tunnel (struct GNUNET_MESSENGER_SrvTunnel *tunnel,
@@ -81,7 +81,7 @@ bind_tunnel (struct GNUNET_MESSENGER_SrvTunnel *tunnel,
* Tries to connect a <i>tunnel</i> by creating a new CADET channel and
binding it.
* The function returns #GNUNET_YES on success, otherwise #GNUNET_NO.
*
- * @param[in/out] tunnel Tunnel
+ * @param[in,out] tunnel Tunnel
* @return #GNUNET_YES on success, otherwise #GNUNET_NO
*/
int
@@ -91,7 +91,7 @@ connect_tunnel (struct GNUNET_MESSENGER_SrvTunnel *tunnel);
* Disconnects and unbinds a channel from a <i>tunnel</i>. The actual
disconnection
* will be asynchronous.
*
- * @param[in/out] tunnel Tunnel
+ * @param[in,out] tunnel Tunnel
*/
void
disconnect_tunnel (struct GNUNET_MESSENGER_SrvTunnel *tunnel);
@@ -109,8 +109,8 @@ is_tunnel_connected (const struct
GNUNET_MESSENGER_SrvTunnel *tunnel);
* Sends an envelope containing a <i>message</i> with a given <i>hash</i>
through
* a <i>tunnel</i>.
*
- * @param[in/out] tunnel Tunnel
- * @param[in/out] env Envelope
+ * @param[in,out] tunnel Tunnel
+ * @param[in,out] env Envelope
* @param[in] hash Hash of message
*/
void
@@ -123,9 +123,9 @@ send_tunnel_envelope (struct GNUNET_MESSENGER_SrvTunnel
*tunnel,
* through the <i>tunnel</i>. The used <i>handle</i> will sign the message and
* the <i>hash</i> will be calculated and stored.
*
- * @param[in/out] tunnel Tunnel
- * @param[in/out] handle Handle
- * @param[in/out] message Message
+ * @param[in,out] tunnel Tunnel
+ * @param[in,out] handle Handle
+ * @param[in,out] message Message
* @return #GNUNET_YES on success, GNUNET_NO otherwise
*/
int
@@ -136,7 +136,7 @@ send_tunnel_message (struct GNUNET_MESSENGER_SrvTunnel
*tunnel,
/**
* Forwards a given <i>message</i> with a known <i>hash</i> through a
<i>tunnel</i>.
*
- * @param[in/out] tunnel Tunnel
+ * @param[in,out] tunnel Tunnel
* @param[in] message Message
* @param[in] hash Hash of message
*/
@@ -184,7 +184,7 @@ get_tunnel_messenger_version (const struct
GNUNET_MESSENGER_SrvTunnel *tunnel);
* it is compatible to the running peer of the service. Depending on success it
* returns #GNUNET_OK or #GNUNET_SYSERR on failure.
*
- * @param[in/out] tunnel Tunnel
+ * @param[in,out] tunnel Tunnel
* @param[in] version Version of messenger
*/
int
diff --git a/src/messenger/messenger_api_contact.h
b/src/messenger/messenger_api_contact.h
index b5410f998..6619d8fa2 100644
--- a/src/messenger/messenger_api_contact.h
+++ b/src/messenger/messenger_api_contact.h
@@ -50,7 +50,7 @@ create_contact (const struct GNUNET_IDENTITY_PublicKey *key);
/**
* Destroys a contact and frees its memory fully.
*
- * @param[in/out] contact Contact
+ * @param[in,out] contact Contact
*/
void
destroy_contact (struct GNUNET_MESSENGER_Contact *contact);
@@ -67,7 +67,7 @@ get_contact_name (const struct GNUNET_MESSENGER_Contact
*contact);
/**
* Changes the current name of a given <i>contact</i> by copying it from the
parameter <i>name</i>.
*
- * @param[in/out] contact Contact
+ * @param[in,out] contact Contact
* @param[in] name Name
*/
void
@@ -86,7 +86,7 @@ get_contact_key (const struct GNUNET_MESSENGER_Contact
*contact);
/**
* Increases the reference counter of a given <i>contact</i> which is zero as
default.
*
- * @param[in/out] contact Contact
+ * @param[in,out] contact Contact
*/
void
increase_contact_rc (struct GNUNET_MESSENGER_Contact *contact);
@@ -95,7 +95,7 @@ increase_contact_rc (struct GNUNET_MESSENGER_Contact
*contact);
* Decreases the reference counter if possible (can not underflow!) of a given
<i>contact</i>
* and returns #GNUNET_YES if the counter is equal to zero, otherwise
#GNUNET_NO.
*
- * @param[in/out] contact Contact
+ * @param[in,out] contact Contact
* @return #GNUNET_YES or #GNUNET_NO depending on the reference counter
*/
int
@@ -106,7 +106,7 @@ decrease_contact_rc (struct GNUNET_MESSENGER_Contact
*contact);
*
* @param[in] key Key of room
* @param[in] id Member id
- * @param[out] hash Member context
+ * @param[out] context Member context
*/
void
get_context_from_member (const struct GNUNET_HashCode *key,
diff --git a/src/messenger/messenger_api_contact_store.h
b/src/messenger/messenger_api_contact_store.h
index bdab2ceeb..1cdd3197b 100644
--- a/src/messenger/messenger_api_contact_store.h
+++ b/src/messenger/messenger_api_contact_store.h
@@ -50,7 +50,7 @@ init_contact_store (struct GNUNET_MESSENGER_ContactStore
*store);
/**
* Clears a contact store, wipes its content and deallocates its memory.
*
- * @param[in/out] store Contact store
+ * @param[in,out] store Contact store
*/
void
clear_contact_store (struct GNUNET_MESSENGER_ContactStore *store);
@@ -63,7 +63,7 @@ clear_contact_store (struct GNUNET_MESSENGER_ContactStore
*store);
* In case there is no contact stored which uses the given key or context,
* NULL gets returned.
*
- * @param[in/out] store Contact store
+ * @param[in,out] store Contact store
* @param[in] context Member context
* @param[in] key_hash Hash of public key
*/
@@ -83,7 +83,7 @@ get_store_contact_raw (struct GNUNET_MESSENGER_ContactStore
*store,
* The function returns NULL if an error occurs during allocation
* or validation of the contacts key.
*
- * @param[in/out] store Contact store
+ * @param[in,out] store Contact store
* @param[in] context Member context
* @param[in] pubkey Public key of EGO
*/
@@ -98,8 +98,8 @@ get_store_contact (struct GNUNET_MESSENGER_ContactStore
*store,
*
* This function allows changes of keys or changes of member contexts!
*
- * @param[in/out] store Contact store
- * @param[in/out] contact Contact
+ * @param[in,out] store Contact store
+ * @param[in,out] contact Contact
* @param[in] context Member context
* @param[in] next_context Member context
* @param[in] pubkey Public key of EGO
@@ -115,8 +115,8 @@ update_store_contact (struct GNUNET_MESSENGER_ContactStore
*store,
* Removes a <i>contact</i> from the <i>store</i> which uses
* a given member <i>context</i>.
*
- * @param[in/out] store Contact store
- * @param[in/out] contact Contact
+ * @param[in,out] store Contact store
+ * @param[in,out] contact Contact
* @param[in] context Member context
*/
void
diff --git a/src/messenger/messenger_api_handle.h
b/src/messenger/messenger_api_handle.h
index 6a43f13a6..8430f40d5 100644
--- a/src/messenger/messenger_api_handle.h
+++ b/src/messenger/messenger_api_handle.h
@@ -67,7 +67,7 @@ struct GNUNET_MESSENGER_Handle
*
* @param[in] cfg Configuration
* @param[in] msg_callback Message callback
- * @param[in/out] msg_cls Closure
+ * @param[in,out] msg_cls Closure
* @return New handle
*/
struct GNUNET_MESSENGER_Handle*
@@ -80,7 +80,7 @@ create_handle (const struct GNUNET_CONFIGURATION_Handle *cfg,
/**
* Destroys a <i>handle</i> and frees its memory fully from the client API.
*
- * @param[in/out] handle Handle
+ * @param[in,out] handle Handle
*/
void
destroy_handle (struct GNUNET_MESSENGER_Handle *handle);
@@ -88,7 +88,7 @@ destroy_handle (struct GNUNET_MESSENGER_Handle *handle);
/**
* Sets the name of a <i>handle</i> to a specific <i>name</i>.
*
- * @param[in/out] handle Handle
+ * @param[in,out] handle Handle
* @param[in] name New name
*/
void
@@ -107,7 +107,7 @@ get_handle_name (const struct GNUNET_MESSENGER_Handle
*handle);
/**
* Sets the public key of a given <i>handle</i> to a specific public key.
*
- * @param[in/out] handle Handle
+ * @param[in,out] handle Handle
* @param[in] pubkey Public key
*/
void
@@ -126,7 +126,7 @@ get_handle_key (const struct GNUNET_MESSENGER_Handle
*handle);
/**
* Returns the used contact store of a given <i>handle</i>.
*
- * @param[in/out] handle Handle
+ * @param[in,out] handle Handle
* @return Contact store
*/
struct GNUNET_MESSENGER_ContactStore*
@@ -136,7 +136,7 @@ get_handle_contact_store (struct GNUNET_MESSENGER_Handle
*handle);
* Returns the contact of a given <i>handle</i> in a room identified by a
* given <i>key</i>.
*
- * @param[in/out] handle Handle
+ * @param[in,out] handle Handle
* @param[in] key Key of room
* @return Contact
*/
@@ -147,7 +147,7 @@ get_handle_contact (struct GNUNET_MESSENGER_Handle *handle,
/**
* Marks a room known to a <i>handle</i> identified by a given <i>key</i> as
open.
*
- * @param[in/out] handle Handle
+ * @param[in,out] handle Handle
* @param[in] key Key of room
*/
void
@@ -158,7 +158,7 @@ open_handle_room (struct GNUNET_MESSENGER_Handle *handle,
* Adds a tunnel for a room known to a <i>handle</i> identified by a given
<i>key</i> to a
* list of opened connections.
*
- * @param[in/out] handle Handle
+ * @param[in,out] handle Handle
* @param[in] door Peer identity
* @param[in] key Key of room
*/
@@ -170,7 +170,7 @@ entry_handle_room_at (struct GNUNET_MESSENGER_Handle
*handle,
/**
* Destroys and so implicitly closes a room known to a <i>handle</i>
identified by a given <i>key</i>.
*
- * @param[in/out] handle Handle
+ * @param[in,out] handle Handle
* @param[in] key Key of room
*/
void
diff --git a/src/messenger/messenger_api_list_tunnels.h
b/src/messenger/messenger_api_list_tunnels.h
index 0e086ee5e..e28935c3e 100644
--- a/src/messenger/messenger_api_list_tunnels.h
+++ b/src/messenger/messenger_api_list_tunnels.h
@@ -55,7 +55,7 @@ init_list_tunnels (struct GNUNET_MESSENGER_ListTunnels
*tunnels);
/**
* Clears the list of tunnels peer identities.
*
- * @param[in/out] tunnels List of peer identities
+ * @param[in,out] tunnels List of peer identities
*/
void
clear_list_tunnels (struct GNUNET_MESSENGER_ListTunnels *tunnels);
@@ -63,7 +63,7 @@ clear_list_tunnels (struct GNUNET_MESSENGER_ListTunnels
*tunnels);
/**
* Adds a specific <i>peer</i> from a tunnel to the end of the list.
*
- * @param[in/out] tunnels List of peer identities
+ * @param[in,out] tunnels List of peer identities
* @param[in] peer Peer identity of tunnel
*/
void
@@ -80,7 +80,7 @@ add_to_list_tunnels (struct GNUNET_MESSENGER_ListTunnels
*tunnels,
* the found element in the list. If no matching element is found,
<i>index</i> will
* contain the total amount of elements in the list.
*
- * @param[in/out] tunnels List of peer identities
+ * @param[in,out] tunnels List of peer identities
* @param[in] peer Peer identity of tunnel
* @param[out] index Index of found element (optional)
* @return Element in the list with matching peer identity
@@ -94,7 +94,7 @@ find_list_tunnels (struct GNUNET_MESSENGER_ListTunnels
*tunnels,
* Tests linearly if the list of tunnels peer identities contains a specific
* <i>peer</i> identity and returns #GNUNET_YES on success, otherwise
#GNUNET_NO.
*
- * @param[in/out] tunnels List of peer identities
+ * @param[in,out] tunnels List of peer identities
* @param[in] peer Peer identity of tunnel
* @return #GNUNET_YES on success, otherwise #GNUNET_NO
*/
@@ -106,8 +106,8 @@ contains_list_tunnels (struct GNUNET_MESSENGER_ListTunnels
*tunnels,
* Removes a specific <i>element</i> from the list of tunnels peer identities
and returns
* the next element in the list.
*
- * @param[in/out] tunnels List of peer identities
- * @param[in/out] element Element of the list
+ * @param[in,out] tunnels List of peer identities
+ * @param[in,out] element Element of the list
* @return Next element in the list
*/
struct GNUNET_MESSENGER_ListTunnel*
@@ -117,7 +117,7 @@ remove_from_list_tunnels (struct
GNUNET_MESSENGER_ListTunnels *tunnels,
/**
* Loads the list of tunnels peer identities from a file under a given
<i>path</i>.
*
- * @param[out] messages List of hashes
+ * @param[out] tunnels List of hashes
* @param[in] path Path of file
*/
void
@@ -127,7 +127,7 @@ load_list_tunnels (struct GNUNET_MESSENGER_ListTunnels
*tunnels,
/**
* Saves the list of tunnels peer identities to a file under a given
<i>path</i>.
*
- * @param[in] messages List of hashes
+ * @param[in] tunnels List of hashes
* @param[in] path Path of file
*/
void
diff --git a/src/messenger/messenger_api_message.h
b/src/messenger/messenger_api_message.h
index 46c5cb024..209d80a4e 100644
--- a/src/messenger/messenger_api_message.h
+++ b/src/messenger/messenger_api_message.h
@@ -64,7 +64,7 @@ copy_message (const struct GNUNET_MESSENGER_Message *message);
/**
* Frees the messages body memory.
*
- * @param[in/out] message Message
+ * @param[in,out] message Message
*/
void
cleanup_message (struct GNUNET_MESSENGER_Message *message);
@@ -72,7 +72,7 @@ cleanup_message (struct GNUNET_MESSENGER_Message *message);
/**
* Destroys a message and frees its memory fully.
*
- * @param[in/out] message Message
+ * @param[in,out] message Message
*/
void
destroy_message (struct GNUNET_MESSENGER_Message *message);
@@ -163,7 +163,7 @@ hash_message (const struct GNUNET_MESSENGER_Message
*message,
* Signs the <i>hash</i> of a <i>message</i> with a given <i>ego</i> and
writes the signature
* into the <i>buffer</i> as well.
*
- * @param[in/out] message Message
+ * @param[in,out] message Message
* @param[in] length Length of buffer
* @param[out] buffer Buffer
* @param[in] hash Hash of message
@@ -196,7 +196,7 @@ verify_message (const struct GNUNET_MESSENGER_Message
*message,
* and kind with the now private encrypted <i>message</i>. The function returns
* #GNUNET_YES if the operation succeeded, otherwise #GNUNET_NO.
*
- * @param[in/out] message Message
+ * @param[in,out] message Message
* @param[in] key Public key of EGO
* @return #GNUNET_YES on success, otherwise #GNUNET_NO
*/
@@ -209,7 +209,7 @@ encrypt_message (struct GNUNET_MESSENGER_Message *message,
* and kind with the inner encrypted message. The function returns #GNUNET_YES
if the
* operation succeeded, otherwise #GNUNET_NO.
*
- * @param[in/out] message Message
+ * @param[in,out] message Message
* @param[in] key Private key of EGO
* @return #GNUNET_YES on success, otherwise #GNUNET_NO
*/
diff --git a/src/messenger/messenger_api_room.h
b/src/messenger/messenger_api_room.h
index 320312f0c..cf8ab782b 100644
--- a/src/messenger/messenger_api_room.h
+++ b/src/messenger/messenger_api_room.h
@@ -59,7 +59,7 @@ struct GNUNET_MESSENGER_Room
/**
* Creates and allocates a new room for a <i>handle</i> with a given
<i>key</i> for the client API.
*
- * @param[in/out] handle Handle
+ * @param[in,out] handle Handle
* @param[in] key Key of room
* @return New room
*/
@@ -70,7 +70,7 @@ create_room (struct GNUNET_MESSENGER_Handle *handle,
/**
* Destroys a room and frees its memory fully from the client API.
*
- * @param[in/out] room Room
+ * @param[in,out] room Room
*/
void
destroy_room (struct GNUNET_MESSENGER_Room *room);
@@ -106,8 +106,8 @@ get_room_sender (const struct GNUNET_MESSENGER_Room *room,
* The contact of the message's sender could be updated or even created. It
may not be freed or destroyed though!
* (The contact may still be in use for old messages...)
*
- * @param[in/out] room Room
- * @param[in/out] sender Contact of sender
+ * @param[in,out] room Room
+ * @param[in,out] sender Contact of sender
* @param[in] message Message
* @param[in] hash Hash of message
* @return Contact of sender
@@ -122,9 +122,9 @@ handle_room_message (struct GNUNET_MESSENGER_Room *room,
* Iterates through all members of a given <i>room</i> to forward each of them
to a selected
* <i>callback</i> with a custom closure.
*
- * @param[in/out] room Room
+ * @param[in,out] room Room
* @param[in] callback Function called for each member
- * @param[in/out] cls Closure
+ * @param[in,out] cls Closure
* @return Amount of members iterated
*/
int
diff --git a/src/messenger/messenger_api_util.h
b/src/messenger/messenger_api_util.h
index af64790b6..0597b94a8 100644
--- a/src/messenger/messenger_api_util.h
+++ b/src/messenger/messenger_api_util.h
@@ -37,7 +37,7 @@
/**
* Starts an urgent task to close a CADET channel asynchronously.
*
- * @param[in/out] channel Channel
+ * @param[in,out] channel Channel
*/
void
delayed_disconnect_channel (struct GNUNET_CADET_Channel *channel);
diff --git a/src/messenger/testing_messenger_barrier.h
b/src/messenger/testing_messenger_barrier.h
index 3062a393a..5ea0fe137 100644
--- a/src/messenger/testing_messenger_barrier.h
+++ b/src/messenger/testing_messenger_barrier.h
@@ -62,7 +62,7 @@ typedef void
* GNUNET_wait_barrier().
* @param cb the callback to call when the pseudo-barrier is reached or upon
* error. Can be NULL.
- * @param cls closure for the above callback
+ * @param cb_cls closure for the above callback
* @return pseudo-barrier handle; NULL upon error
*/
struct GNUNET_BarrierHandle*
@@ -108,7 +108,7 @@ typedef void
*
* @param barrier the pseudo-barrier handle
* @param cb the pseudo-barrier wait callback
- * @param cls the closure for the above callback
+ * @param cb_cls the closure for the above callback
* @return pseudo-barrier wait handle which can be used to cancel the waiting
* at anytime before the callback is called. NULL upon error.
*/
diff --git a/src/my/my_query_helper.c b/src/my/my_query_helper.c
index 97ea04fd1..e44caad91 100644
--- a/src/my/my_query_helper.c
+++ b/src/my/my_query_helper.c
@@ -48,7 +48,7 @@ my_clean_query (void *cls,
* Function called to convert input argument into SQL parameters.
*
* @param cls closure
- * @param pq data about the query
+ * @param qp data about the query
* @param qbind array of parameters to initialize
* @return -1 on error
*/
@@ -95,7 +95,7 @@ GNUNET_MY_query_param_fixed_size (const void *ptr,
* Function called to convert input argument into SQL parameters.
*
* @param cls closure
- * @param pq data about the query
+ * @param qp data about the query
* @param qbind array of parameters to initialize
* @return -1 on error
*/
@@ -138,7 +138,7 @@ GNUNET_MY_query_param_string (const char *ptr)
* Function called to convert input argument into SQL parameters
*
* @param cls closure
- * @param pq data about the query
+ * @param qp data about the query
* @param qbind array of parameters to initialize
* @return -1 on error
*/
@@ -182,7 +182,7 @@ GNUNET_MY_query_param_uint16 (const uint16_t *x)
* Function called to convert input argument into SQL parameters
*
* @param cls closure
- * @param pq data about the query
+ * @param qp data about the query
* @param qbind array of parameters to initialize
* @return -1 on error
*/
@@ -226,7 +226,7 @@ GNUNET_MY_query_param_uint32 (const uint32_t *x)
* Function called to convert input argument into SQL parameters
*
* @param cls closure
- * @param pq data about the query
+ * @param qp data about the query
* @param qbind array of parameters to initialize
* @return -1 on error
*/
@@ -270,7 +270,7 @@ GNUNET_MY_query_param_uint64 (const uint64_t *x)
* Function called to convert input argument into SQL parameters
*
* @param cls closure
- * @param pq data about the query
+ * @param qp data about the query
* @param qbind array of parameters to initialize
* @return -1 on error
*/
@@ -322,7 +322,7 @@ GNUNET_MY_query_param_rsa_public_key (const struct
* Function called to convert input argument into SQL parameters
*
*@param cls closure
- *@param pq data about the query
+ *@param qp data about the query
*@param qbind array of parameters to initialize
*@return -1 on error
*/
diff --git a/src/my/my_result_helper.c b/src/my/my_result_helper.c
index 99b4229a4..e500c0b27 100644
--- a/src/my/my_result_helper.c
+++ b/src/my/my_result_helper.c
@@ -129,13 +129,6 @@ cleanup_varsize_blob (void *cls,
}
-/**
- * Variable-size result expected
- *
- * @param[out] dst where to store the result, allocated
- * @param[out] ptr_size where to store the size of @a dst
- * @return array entru for the result specification to use
- */
struct GNUNET_MY_ResultSpec
GNUNET_MY_result_spec_variable_size (void **dst,
size_t *ptr_size)
@@ -531,7 +524,7 @@ pre_extract_string (void *cls,
/**
- * Check size of extracted fixed size data from a Mysql database @a
+ * Check size of extracted fixed size data from a Mysql database
*
* @param cls closure
* @param[in,out] rs
@@ -715,7 +708,6 @@ GNUNET_MY_result_spec_uint16 (uint16_t *u16)
* Extract data from a MYSQL database @a result at row @a row
*
* @param cls closure
- * @param cls closure
* @param[in,out] rs
* @param stmt the mysql statement that is being run
* @param column the column that is being processed
@@ -746,7 +738,6 @@ pre_extract_uint32 (void *cls,
* Extract data from a MYSQL database @a result at row @a row
*
* @param cls closure
- * @param cls closure
* @param[in,out] rs
* @param stmt the mysql statement that is being run
* @param column the column that is being processed
diff --git a/src/mysql/mysql.c b/src/mysql/mysql.c
index 738659864..4c701905c 100644
--- a/src/mysql/mysql.c
+++ b/src/mysql/mysql.c
@@ -430,7 +430,6 @@ GNUNET_MYSQL_statement_run (struct GNUNET_MYSQL_Context
*mc, const char *sql)
/**
* Prepare a statement for running.
*
- * @param mc mysql context
* @param sh statement handle to prepare
* @return #GNUNET_OK on success
*/
diff --git a/src/namecache/gnunet-service-namecache.c
b/src/namecache/gnunet-service-namecache.c
index 07bf30de9..0d95cddfb 100644
--- a/src/namecache/gnunet-service-namecache.c
+++ b/src/namecache/gnunet-service-namecache.c
@@ -211,7 +211,7 @@ handle_lookup_block_it (void *cls,
* Handles a #GNUNET_MESSAGE_TYPE_NAMECACHE_LOOKUP_BLOCK message
*
* @param cls a `struct NamecacheClient *`
- * @param the inbound message
+ * @param ln_msg the inbound message
*/
static void
handle_lookup_block (void *cls,
diff --git a/src/namecache/namecache_api.c b/src/namecache/namecache_api.c
index 70c848037..5e820f8cc 100644
--- a/src/namecache/namecache_api.c
+++ b/src/namecache/namecache_api.c
@@ -259,7 +259,6 @@ handle_lookup_block_response (void *cls,
*
* @param cls the `struct GNUNET_NAMECACHE_Handle`
* @param msg the message we received
- * @param size the message size
* @return #GNUNET_OK on success, #GNUNET_SYSERR on error and we did NOT
notify the client
*/
static void
diff --git a/src/namestore/gnunet-namestore-fcfsd.c
b/src/namestore/gnunet-namestore-fcfsd.c
index 7e96ffa43..4a9c6e874 100644
--- a/src/namestore/gnunet-namestore-fcfsd.c
+++ b/src/namestore/gnunet-namestore-fcfsd.c
@@ -1137,7 +1137,7 @@ run_service (void *cls,
* The main function of the fcfs daemon.
*
* @param argc number of arguments from the command line
- * @parsm argv the command line arguments
+ * @param argv the command line arguments
* @return 0 successful exit, a different value otherwise
*/
int
diff --git a/src/namestore/gnunet-namestore.c b/src/namestore/gnunet-namestore.c
index af40f2dbe..9ed8f400c 100644
--- a/src/namestore/gnunet-namestore.c
+++ b/src/namestore/gnunet-namestore.c
@@ -849,8 +849,8 @@ del_monitor (void *cls,
* Parse expiration time.
*
* @param expirationstring text to parse
- * @param etime_is_rel[out] set to #GNUNET_YES if time is relative
- * @param etime[out] set to expiration time (abs or rel)
+ * @param[out] etime_is_rel set to #GNUNET_YES if time is relative
+ * @param[out] etime set to expiration time (abs or rel)
* @return #GNUNET_OK on success
*/
static int
diff --git a/src/namestore/gnunet-service-namestore.c
b/src/namestore/gnunet-service-namestore.c
index 305fe79f0..9b6428872 100644
--- a/src/namestore/gnunet-service-namestore.c
+++ b/src/namestore/gnunet-service-namestore.c
@@ -604,8 +604,8 @@ get_nick_record (const struct GNUNET_IDENTITY_PrivateKey
*zone)
* @param nick_rd the nick record to integrate
* @param rd2_length length of the @a rd2 array
* @param rd2 array of records
- * @param rdc_res[out] length of the resulting @a rd_res array
- * @param rd_res[out] set to an array of records,
+ * @param[out] rdc_res length of the resulting @a rd_res array
+ * @param[out] rd_res set to an array of records,
* including @a nick_rd and @a rd2;
* all of the variable-size 'data' fields in @a rd2 are
* allocated in the same chunk of memory!
@@ -824,7 +824,7 @@ send_lookup_response (struct NamestoreClient *nc,
/**
* Send response to the store request to the client.
*
- * @param client client to talk to
+ * @param nc client to talk to
* @param res status of the operation
* @param rid client's request ID
*/
@@ -1195,7 +1195,7 @@ struct RecordLookupContext
*
* @param cls closure with a `struct RecordLookupContext`
* @param seq unique serial number of the record, MUST NOT BE ZERO
- * @param zone_key private key of the zone
+ * @param private_key private key of the zone
* @param label name that is being mapped (at most 255 characters long)
* @param rd_count number of entries in @a rd array
* @param rd array of records with data to store
@@ -2123,7 +2123,7 @@ handle_iteration_stop (void *cls,
* Handles a #GNUNET_MESSAGE_TYPE_NAMESTORE_ZONE_ITERATION_NEXT message
*
* @param cls the client sending the message
- * @param message message from the client
+ * @param zis_msg message from the client
*/
static void
handle_iteration_next (void *cls,
diff --git a/src/namestore/gnunet-zoneimport.c
b/src/namestore/gnunet-zoneimport.c
index 68b43a016..9ae0fb146 100644
--- a/src/namestore/gnunet-zoneimport.c
+++ b/src/namestore/gnunet-zoneimport.c
@@ -437,7 +437,7 @@ get_label (struct Request *req)
* Build DNS query for @a hostname.
*
* @param hostname host to build query for
- * @param raw_size[out] number of bytes in the query
+ * @param[out] raw_size number of bytes in the query
* @return NULL on error, otherwise pointer to statically (!)
* allocated query buffer
*/
diff --git a/src/namestore/plugin_namestore_flat.c
b/src/namestore/plugin_namestore_flat.c
new file mode 100644
index 000000000..3249d524a
--- /dev/null
+++ b/src/namestore/plugin_namestore_flat.c
@@ -0,0 +1,818 @@
+/*
+ * This file is part of GNUnet
+ * Copyright (C) 2009-2015, 2018, 2019 GNUnet e.V.
+ *
+ * GNUnet is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU Affero General Public License as published
+ * by the Free Software Foundation, either version 3 of the License,
+ * or (at your option) any later version.
+ *
+ * GNUnet is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+
+ SPDX-License-Identifier: AGPL3.0-or-later
+ */
+/**
+ * @file namestore/plugin_namestore_flat.c
+ * @brief file-based namestore backend
+ * @author Martin Schanzenbach
+ * @author Christian Grothoff
+ */
+
+#include "platform.h"
+#include "gnunet_namestore_plugin.h"
+#include "gnunet_namestore_service.h"
+#include "gnunet_gnsrecord_lib.h"
+#include "namestore.h"
+
+/**
+ * Context for all functions in this plugin.
+ */
+struct Plugin
+{
+ const struct GNUNET_CONFIGURATION_Handle *cfg;
+
+ /**
+ * Database filename.
+ */
+ char *fn;
+
+ /**
+ * HashMap
+ */
+ struct GNUNET_CONTAINER_MultiHashMap *hm;
+};
+
+
+struct FlatFileEntry
+{
+ /**
+ * Entry zone
+ */
+ struct GNUNET_IDENTITY_PrivateKey private_key;
+
+ /**
+ * Record count.
+ */
+ uint32_t record_count;
+
+ /**
+ * Rvalue
+ */
+ uint64_t rvalue;
+
+ /**
+ * Record data
+ */
+ struct GNUNET_GNSRECORD_Data *record_data;
+
+ /**
+ * Label
+ */
+ char *label;
+};
+
+
+/**
+ * Hash contactenation of @a pkey and @a label into @a h
+ *
+ * @param pkey a key
+ * @param label a label
+ * @param[out] h initialized hash
+ */
+static void
+hash_pkey_and_label (const struct GNUNET_IDENTITY_PrivateKey *pkey,
+ const char *label,
+ struct GNUNET_HashCode *h)
+{
+ char *key;
+ size_t label_len;
+ size_t key_len;
+
+ label_len = strlen (label);
+ key_len = label_len + sizeof(struct GNUNET_IDENTITY_PrivateKey);
+ key = GNUNET_malloc (key_len);
+ GNUNET_memcpy (key,
+ label,
+ label_len);
+ GNUNET_memcpy (key + label_len,
+ pkey,
+ sizeof(struct GNUNET_IDENTITY_PrivateKey));
+ GNUNET_CRYPTO_hash (key,
+ key_len,
+ h);
+ GNUNET_free (key);
+}
+
+
+/**
+ * Initialize the database connections and associated
+ * data structures (create tables and indices
+ * as needed as well).
+ *
+ * @param plugin the plugin context (state for this module)
+ * @return #GNUNET_OK on success
+ */
+static int
+database_setup (struct Plugin *plugin)
+{
+ char *flatdbfile;
+ char *record_data;
+ char *zone_private_key;
+ char *record_data_b64;
+ char *buffer;
+ char *line;
+ char *label;
+ char *rvalue;
+ char *record_count;
+ size_t record_data_size;
+ uint64_t size;
+ struct GNUNET_HashCode hkey;
+ struct GNUNET_DISK_FileHandle *fh;
+ struct FlatFileEntry *entry;
+ struct GNUNET_DISK_MapHandle *mh;
+
+ if (GNUNET_OK !=
+ GNUNET_CONFIGURATION_get_value_filename (plugin->cfg,
+ "namestore-flat",
+ "FILENAME",
+ &flatdbfile))
+ {
+ GNUNET_log_config_missing (GNUNET_ERROR_TYPE_ERROR,
+ "namestore-flat",
+ "FILENAME");
+ return GNUNET_SYSERR;
+ }
+ if (GNUNET_OK !=
+ GNUNET_DISK_file_test (flatdbfile))
+ {
+ if (GNUNET_OK !=
+ GNUNET_DISK_directory_create_for_file (flatdbfile))
+ {
+ GNUNET_break (0);
+ GNUNET_free (flatdbfile);
+ return GNUNET_SYSERR;
+ }
+ }
+ /* flatdbfile should be UTF-8-encoded. If it isn't, it's a bug */
+ plugin->fn = flatdbfile;
+
+ /* Load data from file into hashmap */
+ plugin->hm = GNUNET_CONTAINER_multihashmap_create (10,
+ GNUNET_NO);
+ fh = GNUNET_DISK_file_open (flatdbfile,
+ GNUNET_DISK_OPEN_CREATE
+ | GNUNET_DISK_OPEN_READWRITE,
+ GNUNET_DISK_PERM_USER_WRITE
+ | GNUNET_DISK_PERM_USER_READ);
+ if (NULL == fh)
+ {
+ GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
+ _ ("Unable to initialize file: %s.\n"),
+ flatdbfile);
+ return GNUNET_SYSERR;
+ }
+ if (GNUNET_SYSERR ==
+ GNUNET_DISK_file_size (flatdbfile,
+ &size,
+ GNUNET_YES,
+ GNUNET_YES))
+ {
+ GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
+ _ ("Unable to get filesize: %s.\n"),
+ flatdbfile);
+ GNUNET_DISK_file_close (fh);
+ return GNUNET_SYSERR;
+ }
+ if (size > SIZE_MAX)
+ {
+ GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
+ _ ("File too big to map: %llu bytes.\n"),
+ (unsigned long long) size);
+ GNUNET_DISK_file_close (fh);
+ return GNUNET_SYSERR;
+ }
+ if (0 == size)
+ {
+ GNUNET_DISK_file_close (fh);
+ return GNUNET_OK;
+ }
+ buffer = GNUNET_DISK_file_map (fh,
+ &mh,
+ GNUNET_DISK_MAP_TYPE_READ,
+ size);
+ if (NULL == buffer)
+ {
+ GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR,
+ "mmap");
+ GNUNET_DISK_file_close (fh);
+ return GNUNET_SYSERR;
+ }
+ if ('\0' != buffer[size - 1])
+ {
+ GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
+ _ ("Namestore database file `%s' malformed\n"),
+ flatdbfile);
+ GNUNET_DISK_file_unmap (mh);
+ GNUNET_DISK_file_close (fh);
+ return GNUNET_SYSERR;
+ }
+
+ line = strtok (buffer, "\n");
+ while (NULL != line)
+ {
+ zone_private_key = strtok (line, ",");
+ if (NULL == zone_private_key)
+ break;
+ rvalue = strtok (NULL, ",");
+ if (NULL == rvalue)
+ break;
+ record_count = strtok (NULL, ",");
+ if (NULL == record_count)
+ break;
+ record_data_b64 = strtok (NULL, ",");
+ if (NULL == record_data_b64)
+ break;
+ label = strtok (NULL, ",");
+ if (NULL == label)
+ break;
+ line = strtok (NULL, "\n");
+ entry = GNUNET_new (struct FlatFileEntry);
+ {
+ unsigned long long ll;
+
+ if (1 != sscanf (rvalue,
+ "%llu",
+ &ll))
+ {
+ GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
+ "Error parsing entry\n");
+ GNUNET_free (entry);
+ break;
+ }
+ entry->rvalue = (uint64_t) ll;
+ }
+ {
+ unsigned int ui;
+
+ if (1 != sscanf (record_count,
+ "%u",
+ &ui))
+ {
+ GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
+ "Error parsing entry\n");
+ GNUNET_free (entry);
+ break;
+ }
+ entry->record_count = (uint32_t) ui;
+ }
+ entry->label = GNUNET_strdup (label);
+ record_data_size
+ = GNUNET_STRINGS_base64_decode (record_data_b64,
+ strlen (record_data_b64),
+ (void **) &record_data);
+ entry->record_data =
+ GNUNET_new_array (entry->record_count,
+ struct GNUNET_GNSRECORD_Data);
+ if (GNUNET_OK !=
+ GNUNET_GNSRECORD_records_deserialize (record_data_size,
+ record_data,
+ entry->record_count,
+ entry->record_data))
+ {
+ GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
+ "Unable to deserialize record %s\n",
+ label);
+ GNUNET_free (entry->label);
+ GNUNET_free (entry);
+ GNUNET_free (record_data);
+ break;
+ }
+ GNUNET_free (record_data);
+
+ {
+ struct GNUNET_IDENTITY_PrivateKey *private_key;
+
+ GNUNET_STRINGS_base64_decode (zone_private_key,
+ strlen (zone_private_key),
+ (void **) &private_key);
+ entry->private_key = *private_key;
+ GNUNET_free (private_key);
+ }
+
+ hash_pkey_and_label (&entry->private_key,
+ label,
+ &hkey);
+ if (GNUNET_OK !=
+ GNUNET_CONTAINER_multihashmap_put (plugin->hm,
+ &hkey,
+ entry,
+
GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY))
+ {
+ GNUNET_free (entry);
+ GNUNET_break (0);
+ }
+ }
+ GNUNET_DISK_file_unmap (mh);
+ GNUNET_DISK_file_close (fh);
+ return GNUNET_OK;
+}
+
+
+/**
+ * Store values in hashmap in file and free data
+ *
+ * @param plugin the plugin context
+ * @param key key in the map
+ * @param value a `struct FlatFileEntry`
+ */
+static int
+store_and_free_entries (void *cls,
+ const struct GNUNET_HashCode *key,
+ void *value)
+{
+ struct GNUNET_DISK_FileHandle *fh = cls;
+ struct FlatFileEntry *entry = value;
+ char *line;
+ char *zone_private_key;
+ char *record_data_b64;
+ ssize_t data_size;
+
+ (void) key;
+ GNUNET_STRINGS_base64_encode (&entry->private_key,
+ sizeof(struct GNUNET_IDENTITY_PrivateKey),
+ &zone_private_key);
+ data_size = GNUNET_GNSRECORD_records_get_size (entry->record_count,
+ entry->record_data);
+ if (data_size < 0)
+ {
+ GNUNET_break (0);
+ GNUNET_free (zone_private_key);
+ return GNUNET_SYSERR;
+ }
+ if (data_size >= UINT16_MAX)
+ {
+ GNUNET_break (0);
+ GNUNET_free (zone_private_key);
+ return GNUNET_SYSERR;
+ }
+ {
+ char data[data_size];
+ ssize_t ret;
+
+ ret = GNUNET_GNSRECORD_records_serialize (entry->record_count,
+ entry->record_data,
+ data_size,
+ data);
+ if ((ret < 0) ||
+ (data_size != ret))
+ {
+ GNUNET_break (0);
+ GNUNET_free (zone_private_key);
+ return GNUNET_SYSERR;
+ }
+ GNUNET_STRINGS_base64_encode (data,
+ data_size,
+ &record_data_b64);
+ }
+ GNUNET_asprintf (&line,
+ "%s,%llu,%u,%s,%s\n",
+ zone_private_key,
+ (unsigned long long) entry->rvalue,
+ (unsigned int) entry->record_count,
+ record_data_b64,
+ entry->label);
+ GNUNET_free (record_data_b64);
+ GNUNET_free (zone_private_key);
+
+ GNUNET_DISK_file_write (fh,
+ line,
+ strlen (line));
+
+ GNUNET_free (line);
+ GNUNET_free (entry->label);
+ GNUNET_free (entry->record_data);
+ GNUNET_free (entry);
+ return GNUNET_YES;
+}
+
+
+/**
+ * Shutdown database connection and associate data
+ * structures.
+ * @param plugin the plugin context (state for this module)
+ */
+static void
+database_shutdown (struct Plugin *plugin)
+{
+ struct GNUNET_DISK_FileHandle *fh;
+
+ fh = GNUNET_DISK_file_open (plugin->fn,
+ GNUNET_DISK_OPEN_CREATE
+ | GNUNET_DISK_OPEN_TRUNCATE
+ | GNUNET_DISK_OPEN_READWRITE,
+ GNUNET_DISK_PERM_USER_WRITE
+ | GNUNET_DISK_PERM_USER_READ);
+ if (NULL == fh)
+ {
+ GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
+ _ ("Unable to initialize file: %s.\n"),
+ plugin->fn);
+ return;
+ }
+
+ GNUNET_CONTAINER_multihashmap_iterate (plugin->hm,
+ &store_and_free_entries,
+ fh);
+ GNUNET_CONTAINER_multihashmap_destroy (plugin->hm);
+ /* append 0-terminator */
+ GNUNET_DISK_file_write (fh,
+ "",
+ 1);
+ GNUNET_DISK_file_close (fh);
+}
+
+
+/**
+ * Store a record in the datastore. Removes any existing record in the
+ * same zone with the same name.
+ *
+ * @param cls closure (internal context for the plugin)
+ * @param zone_key private key of the zone
+ * @param label name that is being mapped (at most 255 characters long)
+ * @param rd_count number of entries in @a rd array
+ * @param rd array of records with data to store
+ * @return #GNUNET_OK on success, else #GNUNET_SYSERR
+ */
+static int
+namestore_flat_store_records (void *cls,
+ const struct
+ GNUNET_IDENTITY_PrivateKey *zone_key,
+ const char *label,
+ unsigned int rd_count,
+ const struct GNUNET_GNSRECORD_Data *rd)
+{
+ struct Plugin *plugin = cls;
+ uint64_t rvalue;
+ struct GNUNET_HashCode hkey;
+ struct FlatFileEntry *entry;
+
+ rvalue = GNUNET_CRYPTO_random_u64 (GNUNET_CRYPTO_QUALITY_WEAK,
+ UINT64_MAX);
+ hash_pkey_and_label (zone_key,
+ label,
+ &hkey);
+ GNUNET_CONTAINER_multihashmap_remove_all (plugin->hm,
+ &hkey);
+ if (0 == rd_count)
+ {
+ GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG,
+ "sqlite",
+ "Record deleted\n");
+ return GNUNET_OK;
+ }
+ entry = GNUNET_new (struct FlatFileEntry);
+ GNUNET_asprintf (&entry->label,
+ label,
+ strlen (label));
+ GNUNET_memcpy (&entry->private_key,
+ zone_key,
+ sizeof(struct GNUNET_IDENTITY_PrivateKey));
+ entry->rvalue = rvalue;
+ entry->record_count = rd_count;
+ entry->record_data = GNUNET_new_array (rd_count,
+ struct GNUNET_GNSRECORD_Data);
+ for (unsigned int i = 0; i < rd_count; i++)
+ {
+ entry->record_data[i].expiration_time = rd[i].expiration_time;
+ entry->record_data[i].record_type = rd[i].record_type;
+ entry->record_data[i].flags = rd[i].flags;
+ entry->record_data[i].data_size = rd[i].data_size;
+ entry->record_data[i].data = GNUNET_malloc (rd[i].data_size);
+ GNUNET_memcpy ((char *) entry->record_data[i].data,
+ rd[i].data,
+ rd[i].data_size);
+ }
+ return GNUNET_CONTAINER_multihashmap_put (plugin->hm,
+ &hkey,
+ entry,
+
GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY);
+}
+
+
+/**
+ * Lookup records in the datastore for which we are the authority.
+ *
+ * @param cls closure (internal context for the plugin)
+ * @param zone private key of the zone
+ * @param label name of the record in the zone
+ * @param iter function to call with the result
+ * @param iter_cls closure for @a iter
+ * @return #GNUNET_OK on success, #GNUNET_NO for no results, else
#GNUNET_SYSERR
+ */
+static int
+namestore_flat_lookup_records (void *cls,
+ const struct GNUNET_IDENTITY_PrivateKey *zone,
+ const char *label,
+ GNUNET_NAMESTORE_RecordIterator iter,
+ void *iter_cls)
+{
+ struct Plugin *plugin = cls;
+ struct FlatFileEntry *entry;
+ struct GNUNET_HashCode hkey;
+
+ if (NULL == zone)
+ {
+ GNUNET_break (0);
+ return GNUNET_SYSERR;
+ }
+ hash_pkey_and_label (zone,
+ label,
+ &hkey);
+ entry = GNUNET_CONTAINER_multihashmap_get (plugin->hm,
+ &hkey);
+
+ if (NULL == entry)
+ return GNUNET_NO;
+ if (NULL != iter)
+ iter (iter_cls,
+ 1, /* zero is illegal */
+ &entry->private_key,
+ entry->label,
+ entry->record_count,
+ entry->record_data);
+ return GNUNET_YES;
+}
+
+
+/**
+ * Closure for #iterate_zones.
+ */
+struct IterateContext
+{
+ /**
+ * How many more records should we skip before returning results?
+ */
+ uint64_t offset;
+
+ /**
+ * How many more records should we return?
+ */
+ uint64_t limit;
+
+ /**
+ * What is the position of the current entry, counting
+ * starts from 1.
+ */
+ uint64_t pos;
+
+ /**
+ * Target zone.
+ */
+ const struct GNUNET_IDENTITY_PrivateKey *zone;
+
+ /**
+ * Function to call on each record.
+ */
+ GNUNET_NAMESTORE_RecordIterator iter;
+
+ /**
+ * Closure for @e iter.
+ */
+ void *iter_cls;
+};
+
+
+/**
+ * Helper function for #namestore_flat_iterate_records().
+ *
+ * @param cls a `struct IterateContext`
+ * @param key unused
+ * @param value a `struct FlatFileEntry`
+ * @return #GNUNET_YES to continue the iteration
+ */
+static int
+iterate_zones (void *cls,
+ const struct GNUNET_HashCode *key,
+ void *value)
+{
+ struct IterateContext *ic = cls;
+ struct FlatFileEntry *entry = value;
+
+ (void) key;
+ if (0 == ic->limit)
+ return GNUNET_NO;
+ if ((NULL != ic->zone) &&
+ (0 != GNUNET_memcmp (&entry->private_key,
+ ic->zone)))
+ return GNUNET_YES;
+ ic->pos++;
+ if (ic->offset > 0)
+ {
+ ic->offset--;
+ return GNUNET_YES;
+ }
+ ic->iter (ic->iter_cls,
+ ic->pos,
+ (NULL == ic->zone)
+ ? &entry->private_key
+ : ic->zone,
+ entry->label,
+ entry->record_count,
+ entry->record_data);
+ ic->limit--;
+ if (0 == ic->limit)
+ return GNUNET_NO;
+ return GNUNET_YES;
+}
+
+
+/**
+ * Iterate over the results for a particular key and zone in the
+ * datastore. Will return at most one result to the iterator.
+ *
+ * @param cls closure (internal context for the plugin)
+ * @param zone hash of public key of the zone, NULL to iterate over all zones
+ * @param serial serial number to exclude in the list of all matching records
+ * @param limit maximum number of results to return to @a iter
+ * @param iter function to call with the result
+ * @param iter_cls closure for @a iter
+ * @return #GNUNET_OK on success, #GNUNET_NO if there were no more results,
#GNUNET_SYSERR on error
+ */
+static int
+namestore_flat_iterate_records (void *cls,
+ const struct
+ GNUNET_IDENTITY_PrivateKey *zone,
+ uint64_t serial,
+ uint64_t limit,
+ GNUNET_NAMESTORE_RecordIterator iter,
+ void *iter_cls)
+{
+ struct Plugin *plugin = cls;
+ struct IterateContext ic;
+
+ ic.offset = serial;
+ ic.pos = 0;
+ ic.limit = limit;
+ ic.iter = iter;
+ ic.iter_cls = iter_cls;
+ ic.zone = zone;
+ GNUNET_CONTAINER_multihashmap_iterate (plugin->hm,
+ &iterate_zones,
+ &ic);
+ return (0 == ic.limit) ? GNUNET_OK : GNUNET_NO;
+}
+
+
+/**
+ * Closure for #zone_to_name.
+ */
+struct ZoneToNameContext
+{
+ const struct GNUNET_IDENTITY_PrivateKey *zone;
+ const struct GNUNET_IDENTITY_PublicKey *value_zone;
+ GNUNET_NAMESTORE_RecordIterator iter;
+ void *iter_cls;
+
+ int result_found;
+};
+
+
+static int
+zone_to_name (void *cls,
+ const struct GNUNET_HashCode *key,
+ void *value)
+{
+ struct ZoneToNameContext *ztn = cls;
+ struct FlatFileEntry *entry = value;
+
+ (void) key;
+ if (0 != GNUNET_memcmp (&entry->private_key,
+ ztn->zone))
+ return GNUNET_YES;
+
+ for (unsigned int i = 0; i < entry->record_count; i++)
+ {
+ if (GNUNET_NO ==
+ GNUNET_GNSRECORD_is_zonekey_type (entry->record_data[i].record_type))
+ continue;
+ if (ztn->value_zone->type != entry->record_data[i].record_type)
+ continue;
+ if (0 == memcmp (ztn->value_zone,
+ entry->record_data[i].data,
+ entry->record_data[i].data_size))
+ {
+ ztn->iter (ztn->iter_cls,
+ i + 1, /* zero is illegal! */
+ &entry->private_key,
+ entry->label,
+ entry->record_count,
+ entry->record_data);
+ ztn->result_found = GNUNET_YES;
+ }
+ }
+ return GNUNET_YES;
+}
+
+
+/**
+ * Look for an existing PKEY delegation record for a given public key.
+ * Returns at most one result to the iterator.
+ *
+ * @param cls closure (internal context for the plugin)
+ * @param zone private key of the zone to look up in, never NULL
+ * @param value_zone public key of the target zone (value), never NULL
+ * @param iter function to call with the result
+ * @param iter_cls closure for @a iter
+ * @return #GNUNET_OK on success, #GNUNET_NO if there were no results,
#GNUNET_SYSERR on error
+ */
+static int
+namestore_flat_zone_to_name (void *cls,
+ const struct GNUNET_IDENTITY_PrivateKey *zone,
+ const struct
+ GNUNET_IDENTITY_PublicKey *value_zone,
+ GNUNET_NAMESTORE_RecordIterator iter,
+ void *iter_cls)
+{
+ struct Plugin *plugin = cls;
+ struct ZoneToNameContext ztn = {
+ .iter = iter,
+ .iter_cls = iter_cls,
+ .zone = zone,
+ .value_zone = value_zone,
+ .result_found = GNUNET_NO
+ };
+
+ GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
+ "Performing reverse lookup for `%s'\n",
+ GNUNET_GNSRECORD_z2s (value_zone));
+ GNUNET_CONTAINER_multihashmap_iterate (plugin->hm,
+ &zone_to_name,
+ &ztn);
+ return ztn.result_found;
+}
+
+
+/**
+ * Entry point for the plugin.
+ *
+ * @param cls the "struct GNUNET_NAMESTORE_PluginEnvironment*"
+ * @return NULL on error, otherwise the plugin context
+ */
+void *
+libgnunet_plugin_namestore_flat_init (void *cls)
+{
+ static struct Plugin plugin;
+ const struct GNUNET_CONFIGURATION_Handle *cfg = cls;
+ struct GNUNET_NAMESTORE_PluginFunctions *api;
+
+ if (NULL != plugin.cfg)
+ return NULL; /* can only initialize once! */
+ memset (&plugin,
+ 0,
+ sizeof(struct Plugin));
+ plugin.cfg = cfg;
+ if (GNUNET_OK != database_setup (&plugin))
+ {
+ database_shutdown (&plugin);
+ return NULL;
+ }
+ api = GNUNET_new (struct GNUNET_NAMESTORE_PluginFunctions);
+ api->cls = &plugin;
+ api->store_records = &namestore_flat_store_records;
+ api->iterate_records = &namestore_flat_iterate_records;
+ api->zone_to_name = &namestore_flat_zone_to_name;
+ api->lookup_records = &namestore_flat_lookup_records;
+ GNUNET_log (GNUNET_ERROR_TYPE_INFO,
+ _ ("Flat file database running\n"));
+ return api;
+}
+
+
+/**
+ * Exit point from the plugin.
+ *
+ * @param cls the plugin context (as returned by "init")
+ * @return always NULL
+ */
+void *
+libgnunet_plugin_namestore_flat_done (void *cls)
+{
+ struct GNUNET_NAMESTORE_PluginFunctions *api = cls;
+ struct Plugin *plugin = api->cls;
+
+ database_shutdown (plugin);
+ plugin->cfg = NULL;
+ GNUNET_free (api);
+ GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
+ "Flat file plugin is finished\n");
+ return NULL;
+}
+
+
+/* end of plugin_namestore_flat.c */
diff --git a/src/namestore/plugin_namestore_postgres.c
b/src/namestore/plugin_namestore_postgres.c
index 147dda0e6..240cc40ec 100644
--- a/src/namestore/plugin_namestore_postgres.c
+++ b/src/namestore/plugin_namestore_postgres.c
@@ -399,8 +399,8 @@ struct ParserContext
* call the @a iter in @a cls with the result.
*
* @param cls closure of type `struct ParserContext *`
- * @param result the postgres result
- * @param num_result the number of results in @a result
+ * @param res the postgres result
+ * @param num_results the number of results in @a result
*/
static void
parse_result_call_iterator (void *cls,
diff --git a/src/namestore/plugin_rest_namestore.c
b/src/namestore/plugin_rest_namestore.c
index 04ac95ee9..5a5fdb9a8 100644
--- a/src/namestore/plugin_rest_namestore.c
+++ b/src/namestore/plugin_rest_namestore.c
@@ -305,7 +305,7 @@ static struct RequestHandle *requests_tail;
/**
* Cleanup lookup handle
- * @param handle Handle to clean up
+ * @param cls Handle to clean up
*/
static void
cleanup_handle (void *cls)
diff --git a/src/nat-auto/gnunet-nat-server.c b/src/nat-auto/gnunet-nat-server.c
index e091ab3b0..0ff71ca8c 100644
--- a/src/nat-auto/gnunet-nat-server.c
+++ b/src/nat-auto/gnunet-nat-server.c
@@ -261,7 +261,7 @@ try_send_udp (uint32_t dst_ipv4,
* traversal. Do it.
*
* @param cls handle to client (we always close)
- * @param msg message with details about what to test
+ * @param tm message with details about what to test
*/
static void
handle_test (void *cls,
diff --git a/src/nat-auto/nat_auto_api_test.c b/src/nat-auto/nat_auto_api_test.c
index b62d08683..9067aafda 100644
--- a/src/nat-auto/nat_auto_api_test.c
+++ b/src/nat-auto/nat_auto_api_test.c
@@ -333,7 +333,7 @@ mq_error_handler (void *cls, enum GNUNET_MQ_Error error)
* Address-callback, used to send message to gnunet-nat-server.
*
* @param cls closure
- * @param app_ctx[in,out] location where the app can store stuff
+ * @param[in,out] app_ctx location where the app can store stuff
* on add and retrieve it on remove
* @param add_remove #GNUNET_YES to mean the new public IP address, #GNUNET_NO
to mean
* the previous (now invalid) one
diff --git a/src/nat/gnunet-nat.c b/src/nat/gnunet-nat.c
index 0743a478d..fd85549d6 100644
--- a/src/nat/gnunet-nat.c
+++ b/src/nat/gnunet-nat.c
@@ -110,7 +110,7 @@ test_finished ()
* a function to call whenever our set of 'valid' addresses changes.
*
* @param cls closure, NULL
- * @param app_ctx[in,out] location where the app can store stuff
+ * @param[in,out] app_ctx location where the app can store stuff
* on add and retrieve it on remove
* @param add_remove #GNUNET_YES to add a new public IP address,
* #GNUNET_NO to remove a previous (now invalid) one
diff --git a/src/nat/gnunet-service-nat.c b/src/nat/gnunet-service-nat.c
index 4dcc0312f..dde269819 100644
--- a/src/nat/gnunet-service-nat.c
+++ b/src/nat/gnunet-service-nat.c
@@ -1185,7 +1185,7 @@ upnp_addr_change_cb (void *cls,
* port number has already been parsed, this task is
* responsible for periodically doing a DNS lookup.
*
- * @param ch client handle to act upon
+ * @param cls client handle to act upon
*/
static void
dyndns_lookup (void *cls);
diff --git a/src/nat/gnunet-service-nat_helper.c
b/src/nat/gnunet-service-nat_helper.c
index bd1645d25..d92f5a99c 100644
--- a/src/nat/gnunet-service-nat_helper.c
+++ b/src/nat/gnunet-service-nat_helper.c
@@ -265,16 +265,6 @@ restart_nat_server (void *cls)
}
-/**
- * Start the gnunet-helper-nat-server and process incoming
- * requests.
- *
- * @param internal_address
- * @param cb function to call if we receive a request
- * @param cb_cls closure for @a cb
- * @param cfg Handle to the GNUnet configuration
- * @return NULL on error
- */
struct HelperContext *
GN_start_gnunet_nat_server_ (const struct in_addr *internal_address,
GN_ReversalCallback cb,
diff --git a/src/nat/gnunet-service-nat_mini.c
b/src/nat/gnunet-service-nat_mini.c
index ba43946cd..1e13e3814 100644
--- a/src/nat/gnunet-service-nat_mini.c
+++ b/src/nat/gnunet-service-nat_mini.c
@@ -639,14 +639,6 @@ process_unmap_output (void *cls, const char *line)
}
-/**
- * Remove a mapping created with (mini)upnpc. Calling
- * this function will give 'upnpc' 1s to remove tha mapping,
- * so while this function is non-blocking, a task will be
- * left with the scheduler for up to 1s past this call.
- *
- * @param mini the handle
- */
void
GNUNET_NAT_mini_map_stop (struct GNUNET_NAT_MiniHandle *mini)
{
diff --git a/src/nat/nat_api.c b/src/nat/nat_api.c
index 20e7b6ec6..7cf7e6bb3 100644
--- a/src/nat/nat_api.c
+++ b/src/nat/nat_api.c
@@ -362,26 +362,6 @@ do_connect (void *cls)
}
-/**
- * Attempt to enable port redirection and detect public IP address
- * contacting UPnP or NAT-PMP routers on the local network. Use @a
- * addr to specify to which of the local host's addresses should the
- * external port be mapped. The port is taken from the corresponding
- * sockaddr_in[6] field. The NAT module should call the given @a
- * address_callback for any 'plausible' external address.
- *
- * @param cfg configuration to use
- * @param config_section name of the configuration section for optionsx
- * @param proto protocol this is about, IPPROTO_TCP or IPPROTO_UDP
- * @param num_addrs number of addresses in @a addrs
- * @param addrs list of local addresses packets should be redirected to
- * @param addrlens actual lengths of the addresses in @a addrs
- * @param address_callback function to call every time the public IP address
changes
- * @param reversal_callback function to call if someone wants connection
reversal from us,
- * NULL if connection reversal is not supported
- * @param callback_cls closure for callbacks
- * @return NULL on error, otherwise handle that can be used to unregister
- */
struct GNUNET_NAT_Handle *
GNUNET_NAT_register (const struct GNUNET_CONFIGURATION_Handle *cfg,
const char *config_section,
diff --git a/src/nat/nat_api_stun.c b/src/nat/nat_api_stun.c
index 0bc2c5fbd..94adc3d6c 100644
--- a/src/nat/nat_api_stun.c
+++ b/src/nat/nat_api_stun.c
@@ -112,7 +112,7 @@ encode_message (enum StunClasses msg_class,
/**
* Fill the stun_header with a random request_id
*
- * @param req, stun header to be filled
+ * @param req stun header to be filled
*/
static void
generate_request_id (struct stun_header *req)
diff --git a/src/nse/gnunet-service-nse.c b/src/nse/gnunet-service-nse.c
index 56014752d..ee1cb025f 100644
--- a/src/nse/gnunet-service-nse.c
+++ b/src/nse/gnunet-service-nse.c
@@ -1199,7 +1199,7 @@ handle_core_connect (void *cls,
*
* @param cls closure
* @param peer peer identity this notification is about
- * @parma internal_cls the `struct NSEPeerEntry` for the @a peer
+ * @param internal_cls the `struct NSEPeerEntry` for the @a peer
*/
static void
handle_core_disconnect (void *cls,
diff --git a/src/nt/nt.c b/src/nt/nt.c
index 98653f641..8dfacb02b 100644
--- a/src/nt/nt.c
+++ b/src/nt/nt.c
@@ -34,12 +34,6 @@
GNUNET_TIME_UNIT_MINUTES, 2)
-/**
- * Convert a `enum GNUNET_NetworkType` to a string
- *
- * @param net the network type
- * @return a string or NULL if invalid
- */
const char *
GNUNET_NT_to_string (enum GNUNET_NetworkType net)
{
diff --git a/src/peerinfo/peerinfo_api.c b/src/peerinfo/peerinfo_api.c
index b73d9d927..65e429bef 100644
--- a/src/peerinfo/peerinfo_api.c
+++ b/src/peerinfo/peerinfo_api.c
@@ -119,13 +119,6 @@ static void
reconnect (struct GNUNET_PEERINFO_Handle *h);
-/**
- * Connect to the peerinfo service.
- *
- * @param cfg configuration to use
- * @return NULL on error (configuration related, actual connection
- * establishment may happen asynchronously).
- */
struct GNUNET_PEERINFO_Handle *
GNUNET_PEERINFO_connect (const struct GNUNET_CONFIGURATION_Handle *cfg)
{
@@ -467,22 +460,6 @@ reconnect (struct GNUNET_PEERINFO_Handle *h)
}
-/**
- * Call a method for each known matching host. The callback method
- * will be invoked once for each matching host and then finally once
- * with a NULL pointer. After that final invocation, the iterator
- * context must no longer be used.
- *
- * Instead of calling this function with `peer == NULL` it is often
- * better to use #GNUNET_PEERINFO_notify().
- *
- * @param h handle to the peerinfo service
- * @param include_friend_only include HELLO messages for friends only
- * @param peer restrict iteration to this peer only (can be NULL)
- * @param callback the method to call for each peer
- * @param callback_cls closure for @a callback
- * @return iterator context
- */
struct GNUNET_PEERINFO_IteratorContext *
GNUNET_PEERINFO_iterate (struct GNUNET_PEERINFO_Handle *h,
int include_friend_only,
diff --git a/src/peerstore/peerstore_api.c b/src/peerstore/peerstore_api.c
index d0c72acf1..b3e793d93 100644
--- a/src/peerstore/peerstore_api.c
+++ b/src/peerstore/peerstore_api.c
@@ -693,17 +693,6 @@ GNUNET_PEERSTORE_iterate_cancel (struct
GNUNET_PEERSTORE_IterateContext *ic)
}
-/**
- * Iterate over records matching supplied key information
- *
- * @param h handle to the PEERSTORE service
- * @param sub_system name of sub system
- * @param peer Peer identity (can be NULL)
- * @param key entry key string (can be NULL)
- * @param callback function called with each matching record, all NULL's on end
- * @param callback_cls closure for @a callback
- * @return Handle to iteration request
- */
struct GNUNET_PEERSTORE_IterateContext *
GNUNET_PEERSTORE_iterate (struct GNUNET_PEERSTORE_Handle *h,
const char *sub_system,
diff --git a/src/peerstore/peerstore_common.c b/src/peerstore/peerstore_common.c
index 0f6a73fa6..070a2a16e 100644
--- a/src/peerstore/peerstore_common.c
+++ b/src/peerstore/peerstore_common.c
@@ -118,12 +118,6 @@ PEERSTORE_create_record_mq_envelope (const char
*sub_system,
}
-/**
- * Parses a message carrying a record
- *
- * @param srm the actual message
- * @return Pointer to record or NULL if error
- */
struct GNUNET_PEERSTORE_Record *
PEERSTORE_parse_record_message (const struct StoreRecordMessage *srm)
{
diff --git a/src/pq/pq_event.c b/src/pq/pq_event.c
index aff52dd5c..0e56c8b70 100644
--- a/src/pq/pq_event.c
+++ b/src/pq/pq_event.c
@@ -384,7 +384,7 @@ manage_subscribe (struct GNUNET_PQ_Context *db,
*
* @param cls the DB context
* @param sh the short hash of the channel
- * @param eh the event handler
+ * @param value the event handler
* @return #GNUNET_OK to continue to iterate
*/
static int
diff --git a/src/pq/pq_exec.c b/src/pq/pq_exec.c
index 62dd577ad..33fe8733d 100644
--- a/src/pq/pq_exec.c
+++ b/src/pq/pq_exec.c
@@ -63,15 +63,6 @@ GNUNET_PQ_make_try_execute (const char *sql)
}
-/**
- * Request execution of an array of statements @a es from Postgres.
- *
- * @param db database to execute the statements with
- * @param es #GNUNET_PQ_PREPARED_STATEMENT_END-terminated array of prepared
- * statements.
- * @return #GNUNET_OK on success (modulo statements where errors can be
ignored)
- * #GNUNET_SYSERR on error
- */
enum GNUNET_GenericReturnValue
GNUNET_PQ_exec_statements (struct GNUNET_PQ_Context *db,
const struct GNUNET_PQ_ExecuteStatement *es)
diff --git a/src/pq/pq_result_helper.c b/src/pq/pq_result_helper.c
index f3d246c36..f945c5d2e 100644
--- a/src/pq/pq_result_helper.c
+++ b/src/pq/pq_result_helper.c
@@ -67,7 +67,7 @@ clean_varsize_blob (void *cls,
*
* @param cls closure
* @param result where to extract data from
- * @param int row to extract data from
+ * @param row row to extract data from
* @param fname name (or prefix) of the fields to extract from
* @param[in,out] dst_size where to store size of result, may be NULL
* @param[out] dst where to store the result
@@ -144,7 +144,7 @@ GNUNET_PQ_result_spec_variable_size (const char *name,
*
* @param cls closure
* @param result where to extract data from
- * @param int row to extract data from
+ * @param row row to extract data from
* @param fname name (or prefix) of the fields to extract from
* @param[in] dst_size desired size, never NULL
* @param[out] dst where to store the result
@@ -226,7 +226,7 @@ GNUNET_PQ_result_spec_fixed_size (const char *name,
*
* @param cls closure
* @param result where to extract data from
- * @param int row to extract data from
+ * @param row row to extract data from
* @param fname name (or prefix) of the fields to extract from
* @param[in,out] dst_size where to store size of result, may be NULL
* @param[out] dst where to store the result
@@ -322,7 +322,7 @@ GNUNET_PQ_result_spec_rsa_public_key (const char *name,
*
* @param cls closure
* @param result where to extract data from
- * @param int row to extract data from
+ * @param row row to extract data from
* @param fname name (or prefix) of the fields to extract from
* @param[in,out] dst_size where to store size of result, may be NULL
* @param[out] dst where to store the result
@@ -417,7 +417,7 @@ GNUNET_PQ_result_spec_rsa_signature (const char *name,
*
* @param cls closure
* @param result where to extract data from
- * @param int row to extract data from
+ * @param row row to extract data from
* @param fname name (or prefix) of the fields to extract from
* @param[in,out] dst_size where to store size of result, may be NULL
* @param[out] dst where to store the result
@@ -512,7 +512,7 @@ GNUNET_PQ_result_spec_string (const char *name,
*
* @param cls closure
* @param result where to extract data from
- * @param int row to extract data from
+ * @param row row to extract data from
* @param fname name (or prefix) of the fields to extract from
* @param[in,out] dst_size where to store size of result, may be NULL
* @param[out] dst where to store the result
@@ -582,7 +582,7 @@ GNUNET_PQ_result_spec_bool (const char *name,
*
* @param cls closure
* @param result where to extract data from
- * @param int row to extract data from
+ * @param row row to extract data from
* @param fname name (or prefix) of the fields to extract from
* @param[in,out] dst_size where to store size of result, may be NULL
* @param[out] dst where to store the result
@@ -659,7 +659,7 @@ GNUNET_PQ_result_spec_relative_time (const char *name,
*
* @param cls closure
* @param result where to extract data from
- * @param int row to extract data from
+ * @param row row to extract data from
* @param fname name (or prefix) of the fields to extract from
* @param[in,out] dst_size where to store size of result, may be NULL
* @param[out] dst where to store the result
@@ -748,7 +748,7 @@ GNUNET_PQ_result_spec_absolute_time_nbo (const char *name,
*
* @param cls closure
* @param result where to extract data from
- * @param int row to extract data from
+ * @param row row to extract data from
* @param fname name (or prefix) of the fields to extract from
* @param[in,out] dst_size where to store size of result, may be NULL
* @param[out] dst where to store the result
@@ -837,7 +837,7 @@ GNUNET_PQ_result_spec_timestamp (const char *name,
*
* @param cls closure
* @param result where to extract data from
- * @param int row to extract data from
+ * @param row row to extract data from
* @param fname name (or prefix) of the fields to extract from
* @param[in,out] dst_size where to store size of result, may be NULL
* @param[out] dst where to store the result
@@ -890,7 +890,7 @@ GNUNET_PQ_result_spec_timestamp_nbo (const char *name,
*
* @param cls closure
* @param result where to extract data from
- * @param int row to extract data from
+ * @param row row to extract data from
* @param fname name (or prefix) of the fields to extract from
* @param[in,out] dst_size where to store size of result, may be NULL
* @param[out] dst where to store the result
@@ -964,7 +964,7 @@ GNUNET_PQ_result_spec_uint16 (const char *name,
*
* @param cls closure
* @param result where to extract data from
- * @param int row to extract data from
+ * @param row row to extract data from
* @param fname name (or prefix) of the fields to extract from
* @param[in,out] dst_size where to store size of result, may be NULL
* @param[out] dst where to store the result
@@ -1038,7 +1038,7 @@ GNUNET_PQ_result_spec_uint32 (const char *name,
*
* @param cls closure
* @param result where to extract data from
- * @param int row to extract data from
+ * @param row row to extract data from
* @param fname name (or prefix) of the fields to extract from
* @param[in,out] dst_size where to store size of result, may be NULL
* @param[out] dst where to store the result
diff --git a/src/reclaim/did.h b/src/reclaim/did.h
index fc465da3b..42f65db26 100644
--- a/src/reclaim/did.h
+++ b/src/reclaim/did.h
@@ -25,7 +25,7 @@
/**
* Create a DID string from an ego in the format
- * did:gns:<pubkey>
+ * did:gns:\<pubkey\>
*
* @param ego the Ego to use
* @return the DID string
@@ -36,7 +36,7 @@ DID_ego_to_did (struct GNUNET_IDENTITY_Ego *ego);
/**
* Extract the public key from a DID
- * in the format did:gns:<pubkey>
+ * in the format did:gns:\<pubkey\>
*
* @param did the DID parse
* @param pk where to store the public key
diff --git a/src/reclaim/gnunet-service-reclaim.c
b/src/reclaim/gnunet-service-reclaim.c
index 84a98d1e4..5290621d6 100644
--- a/src/reclaim/gnunet-service-reclaim.c
+++ b/src/reclaim/gnunet-service-reclaim.c
@@ -522,7 +522,7 @@ cleanup_adh (struct AttributeDeleteHandle *adh)
/**
* Cleanup attribute store handle
*
- * @param handle handle to clean up
+ * @param ash handle to clean up
*/
static void
cleanup_as_handle (struct AttributeStoreHandle *ash)
@@ -723,8 +723,8 @@ issue_ticket_result_cb (void *cls,
/**
* Check issue ticket message
*
- * @cls unused
- * @im message to check
+ * @param cls unused
+ * @param im message to check
* @return GNUNET_OK if message is ok
*/
static int
@@ -937,7 +937,7 @@ check_consume_ticket_message (void *cls, const struct
ConsumeTicketMessage *cm)
* Handle a consume ticket message
*
* @param cls our client handle
- * @cm the message to handle
+ * @param cm the message to handle
*/
static void
handle_consume_ticket_message (void *cls, const struct ConsumeTicketMessage
*cm)
@@ -1686,8 +1686,8 @@ attr_delete_cont (void *cls, int32_t success, const char
*emsg)
/**
* Check attribute delete message format
*
- * @cls unused
- * @dam message to check
+ * @param cls unused
+ * @param dam message to check
*/
static int
check_attribute_delete_message (void *cls,
@@ -1777,8 +1777,8 @@ cred_delete_cont (void *cls, int32_t success, const char
*emsg)
/**
* Check credential delete message format
*
- * @cls unused
- * @dam message to check
+ * @param cls unused
+ * @param dam message to check
*/
static int
check_credential_delete_message (void *cls,
diff --git a/src/reclaim/gnunet-service-reclaim_tickets.c
b/src/reclaim/gnunet-service-reclaim_tickets.c
index 23b617a7f..a17dfb0e2 100644
--- a/src/reclaim/gnunet-service-reclaim_tickets.c
+++ b/src/reclaim/gnunet-service-reclaim_tickets.c
@@ -485,7 +485,7 @@ rvk_ticket_update_finished (void *cls)
* @param cls handle to the operation
* @param zone ticket issuer private key
* @param label ticket rnd
- * @param rd_cound size of record set
+ * @param rd_count size of record set
* @param rd record set
*/
static void
@@ -568,9 +568,8 @@ rvk_ns_err (void *cls)
* want to revoke.
* When we are done, we need to update any other ticket which
* included references to any of the changed attributes.
- * (Implementation further below)
*
- * @param rvk handle to the operation
+ * @param rh handle to the operation
*/
static void
move_attrs (struct RECLAIM_TICKETS_RevokeHandle *rh);
@@ -757,14 +756,6 @@ rvk_move_attr_cb (void *cls,
}
-/**
- * We change every attribute ID of the ticket attributes we
- * want to revoke.
- * When we are done, we need to update any other ticket which
- * included references to any of the changed attributes.
- *
- * @param rvk handle to the operation
- */
static void
move_attrs (struct RECLAIM_TICKETS_RevokeHandle *rvk)
{
@@ -844,7 +835,7 @@ remove_ticket_cont (void *cls, int32_t success, const char
*emsg)
* @param cls handle to the operation
* @param zone the issuer key
* @param label ticket rnd
- * @param rd_cound size of record set
+ * @param rd_count size of record set
* @param rd record set
*/
static void
@@ -995,7 +986,7 @@ cleanup_cth (struct RECLAIM_TICKETS_ConsumeHandle *cth)
* We found an attribute record.
*
* @param cls handle to the operation
- * @param rd_cound size of record set
+ * @param rd_count size of record set
* @param rd record set
*/
static void
@@ -1083,7 +1074,7 @@ abort_parallel_lookups (void *cls)
* attribute record under the referenced label.
*
* @param cls handle to the operation
- * @param rd_cound size of the record set
+ * @param rd_count size of the record set
* @param rd record set
*/
static void
@@ -1671,7 +1662,7 @@ cleanup_iter (struct RECLAIM_TICKETS_Iterator *iter)
/**
- * Return each record of type @GNUNET_GNSRECORD_TYPE_RECLAIM_TICKET
+ * Return each record of type #GNUNET_GNSRECORD_TYPE_RECLAIM_TICKET
* to the caller and proceed with the iteration.
* FIXME: Should we _not_ proceed automatically here?
*
diff --git a/src/reclaim/oidc_helper.c b/src/reclaim/oidc_helper.c
index 11963c345..90c33375f 100644
--- a/src/reclaim/oidc_helper.c
+++ b/src/reclaim/oidc_helper.c
@@ -423,17 +423,6 @@ generate_id_token_body (const struct
GNUNET_IDENTITY_PublicKey *aud_key,
}
-/**
- * Create a JWT using RSA256 algorithm from attributes
- *
- * @param aud_key the public of the audience
- * @param sub_key the public key of the subject
- * @param attrs the attribute list
- * @param presentations credential presentation list (may be empty)
- * @param expiration_time the validity of the token
- * @param secret_rsa_key the key used to sign the JWT
- * @return a new base64-encoded JWT string.
- */
char *
OIDC_generate_id_token_rsa (const struct GNUNET_IDENTITY_PublicKey *aud_key,
const struct GNUNET_IDENTITY_PublicKey *sub_key,
diff --git a/src/reclaim/oidc_helper.h b/src/reclaim/oidc_helper.h
index b134c71ad..81eadf2ed 100644
--- a/src/reclaim/oidc_helper.h
+++ b/src/reclaim/oidc_helper.h
@@ -50,14 +50,14 @@ enum OIDC_VerificationOptions
};
/**
- * Create a JWT using RSA256 from attributes
+ * Create a JWT using RSA256 algorithm from attributes
*
* @param aud_key the public of the audience
* @param sub_key the public key of the subject
* @param attrs the attribute list
* @param presentations credential presentation list (may be empty)
* @param expiration_time the validity of the token
- * @param secret_key the key used to sign the JWT
+ * @param secret_rsa_key the key used to sign the JWT
* @return a new base64-encoded JWT string.
*/
char *
@@ -162,7 +162,7 @@ OIDC_access_token_new (const struct GNUNET_RECLAIM_Ticket
*ticket);
* Parse an access token
*/
int
-OIDC_access_token_parse (const char*token,
+OIDC_access_token_parse (const char *token,
struct GNUNET_RECLAIM_Ticket **ticket);
diff --git a/src/reclaim/reclaim_api.c b/src/reclaim/reclaim_api.c
index bc6b835c9..6f55d62e4 100644
--- a/src/reclaim/reclaim_api.c
+++ b/src/reclaim/reclaim_api.c
@@ -1076,14 +1076,6 @@ GNUNET_RECLAIM_connect (const struct
GNUNET_CONFIGURATION_Handle *cfg)
}
-/**
- * Cancel an operation. Note that the operation MAY still
- * be executed; this merely cancels the continuation; if the request
- * was already transmitted, the service may still choose to complete
- * the operation.
- *
- * @param op operation to cancel
- */
void
GNUNET_RECLAIM_cancel (struct GNUNET_RECLAIM_Operation *op)
{
@@ -1210,23 +1202,11 @@ GNUNET_RECLAIM_attribute_delete (
}
-/**
- * Store an credential. If the credential is already present,
- * it is replaced with the new credential.
- *
- * @param h handle to the re:claimID service
- * @param pkey private key of the identity
- * @param attr the credential value
- * @param exp_interval the relative expiration interval for the credential
- * @param cont continuation to call when done
- * @param cont_cls closure for @a cont
- * @return handle to abort the request
- */
struct GNUNET_RECLAIM_Operation *
GNUNET_RECLAIM_credential_store (
struct GNUNET_RECLAIM_Handle *h,
const struct GNUNET_IDENTITY_PrivateKey *pkey,
- const struct GNUNET_RECLAIM_Credential *attr,
+ const struct GNUNET_RECLAIM_Credential *credential,
const struct GNUNET_TIME_Relative *exp_interval,
GNUNET_RECLAIM_ContinuationWithStatus cont,
void *cont_cls)
@@ -1241,7 +1221,7 @@ GNUNET_RECLAIM_credential_store (
op->cls = cont_cls;
op->r_id = h->r_id_gen++;
GNUNET_CONTAINER_DLL_insert_tail (h->op_head, h->op_tail, op);
- attr_len = GNUNET_RECLAIM_credential_serialize_get_size (attr);
+ attr_len = GNUNET_RECLAIM_credential_serialize_get_size (credential);
op->env = GNUNET_MQ_msg_extra (sam,
attr_len,
GNUNET_MESSAGE_TYPE_RECLAIM_CREDENTIAL_STORE);
@@ -1249,7 +1229,7 @@ GNUNET_RECLAIM_credential_store (
sam->id = htonl (op->r_id);
sam->exp = GNUNET_htonll (exp_interval->rel_value_us);
- GNUNET_RECLAIM_credential_serialize (attr, (char *) &sam[1]);
+ GNUNET_RECLAIM_credential_serialize (credential, (char *) &sam[1]);
sam->attr_len = htons (attr_len);
if (NULL != h->mq)
@@ -1258,17 +1238,6 @@ GNUNET_RECLAIM_credential_store (
}
-/**
- * Delete an credential. Tickets used to share this credential are updated
- * accordingly.
- *
- * @param h handle to the re:claimID service
- * @param pkey Private key of the identity to add an attribute to
- * @param attr The credential
- * @param cont Continuation to call when done
- * @param cont_cls Closure for @a cont
- * @return handle Used to to abort the request
- */
struct GNUNET_RECLAIM_Operation *
GNUNET_RECLAIM_credential_delete (
struct GNUNET_RECLAIM_Handle *h,
@@ -1366,12 +1335,6 @@ GNUNET_RECLAIM_get_attributes_start (
}
-/**
- * Calls the record processor specified in #GNUNET_RECLAIM_get_attributes_start
- * for the next record.
- *
- * @param it the iterator
- */
void
GNUNET_RECLAIM_get_attributes_next (struct GNUNET_RECLAIM_AttributeIterator
*it)
{
@@ -1476,12 +1439,6 @@ GNUNET_RECLAIM_get_credentials_start (
}
-/**
- * Calls the record processor specified in #GNUNET_RECLAIM_get_credential_start
- * for the next record.
- *
- * @param it the iterator
- */
void
GNUNET_RECLAIM_get_credentials_next (struct
GNUNET_RECLAIM_CredentialIterator *ait)
@@ -1497,13 +1454,6 @@ GNUNET_RECLAIM_get_credentials_next (struct
}
-/**
- * Stops iteration and releases the handle for further calls. Must
- * be called on any iteration that has not yet completed prior to calling
- * #GNUNET_RECLAIM_disconnect.
- *
- * @param it the iterator
- */
void
GNUNET_RECLAIM_get_credentials_stop (struct
GNUNET_RECLAIM_CredentialIterator *ait)
@@ -1524,19 +1474,6 @@ GNUNET_RECLAIM_get_credentials_stop (struct
}
-/**
- * Issues a ticket to another relying party. The identity may use
- * @GNUNET_RECLAIM_ticket_consume to consume the ticket
- * and retrieve the attributes specified in the attribute list.
- *
- * @param h the reclaim to use
- * @param iss the issuing identity (= the user)
- * @param rp the subject of the ticket (= the relying party)
- * @param attrs the attributes that the relying party is given access to
- * @param cb the callback
- * @param cb_cls the callback closure
- * @return handle to abort the operation
- */
struct GNUNET_RECLAIM_Operation *
GNUNET_RECLAIM_ticket_issue (
struct GNUNET_RECLAIM_Handle *h,
diff --git a/src/reclaim/reclaim_attribute.c b/src/reclaim/reclaim_attribute.c
index 560267578..b5c41b2d1 100644
--- a/src/reclaim/reclaim_attribute.c
+++ b/src/reclaim/reclaim_attribute.c
@@ -282,14 +282,6 @@ GNUNET_RECLAIM_attribute_new (const char *attr_name,
}
-/**
- * Add a new attribute to a claim list
- *
- * @param attr_name the name of the new attribute claim
- * @param type the type of the claim
- * @param data claim payload
- * @param data_size claim payload size
- */
void
GNUNET_RECLAIM_attribute_list_add (
struct GNUNET_RECLAIM_AttributeList *al,
@@ -333,16 +325,9 @@ GNUNET_RECLAIM_attribute_list_serialize_get_size (
}
-/**
- * Serialize an attribute list
- *
- * @param attrs the attribute list to serialize
- * @param result the serialized attribute
- * @return length of serialized data
- */
size_t
GNUNET_RECLAIM_attribute_list_serialize (
- const struct GNUNET_RECLAIM_AttributeList *al,
+ const struct GNUNET_RECLAIM_AttributeList *attrs,
char *result)
{
struct GNUNET_RECLAIM_AttributeListEntry *ale;
@@ -351,7 +336,7 @@ GNUNET_RECLAIM_attribute_list_serialize (
char *write_ptr;
write_ptr = result;
total_len = 0;
- for (ale = al->list_head; NULL != ale; ale = ale->next)
+ for (ale = attrs->list_head; NULL != ale; ale = ale->next)
{
GNUNET_assert (NULL != ale->attribute);
len = GNUNET_RECLAIM_attribute_serialize (ale->attribute, write_ptr);
@@ -404,21 +389,16 @@ GNUNET_RECLAIM_attribute_list_deserialize (const char
*data, size_t data_size)
}
-/**
- * Make a (deep) copy of a claim list
- * @param attrs claim list to copy
- * @return copied claim list
- */
struct GNUNET_RECLAIM_AttributeList *
GNUNET_RECLAIM_attribute_list_dup (
- const struct GNUNET_RECLAIM_AttributeList *al)
+ const struct GNUNET_RECLAIM_AttributeList *attrs)
{
struct GNUNET_RECLAIM_AttributeListEntry *ale;
struct GNUNET_RECLAIM_AttributeListEntry *result_ale;
struct GNUNET_RECLAIM_AttributeList *result;
result = GNUNET_new (struct GNUNET_RECLAIM_AttributeList);
- for (ale = al->list_head; NULL != ale; ale = ale->next)
+ for (ale = attrs->list_head; NULL != ale; ale = ale->next)
{
result_ale = GNUNET_new (struct GNUNET_RECLAIM_AttributeListEntry);
GNUNET_assert (NULL != ale->attribute);
@@ -441,11 +421,6 @@ GNUNET_RECLAIM_attribute_list_dup (
}
-/**
- * Destroy claim list
- *
- * @param attrs list to destroy
- */
void
GNUNET_RECLAIM_attribute_list_destroy (
struct GNUNET_RECLAIM_AttributeList *al)
diff --git a/src/reclaim/reclaim_credential.c b/src/reclaim/reclaim_credential.c
index b4aeedf29..6dc1a1fcf 100644
--- a/src/reclaim/reclaim_credential.c
+++ b/src/reclaim/reclaim_credential.c
@@ -250,15 +250,6 @@ GNUNET_RECLAIM_credential_value_to_string (uint32_t type,
}
-/**
- * Create a new credential.
- *
- * @param attr_name the credential name
- * @param type the credential type
- * @param data the credential value
- * @param data_size the credential value size
- * @return the new credential
- */
struct GNUNET_RECLAIM_Credential *
GNUNET_RECLAIM_credential_new (const char *attr_name,
uint32_t type,
@@ -310,13 +301,6 @@ GNUNET_RECLAIM_credential_list_serialize_get_size (
}
-/**
- * Serialize an attribute list
- *
- * @param attrs the attribute list to serialize
- * @param result the serialized attribute
- * @return length of serialized data
- */
size_t
GNUNET_RECLAIM_credential_list_serialize (
const struct GNUNET_RECLAIM_CredentialList *credentials,
@@ -339,13 +323,6 @@ GNUNET_RECLAIM_credential_list_serialize (
}
-/**
- * Deserialize an credential list
- *
- * @param data the serialized attribute list
- * @param data_size the length of the serialized data
- * @return a GNUNET_IDENTITY_PROVIDER_AttributeList, must be free'd by caller
- */
struct GNUNET_RECLAIM_CredentialList *
GNUNET_RECLAIM_credential_list_deserialize (const char *data, size_t data_size)
{
@@ -415,19 +392,14 @@ GNUNET_RECLAIM_credential_list_dup (
}
-/**
- * Destroy credential list
- *
- * @param attrs list to destroy
- */
void
GNUNET_RECLAIM_credential_list_destroy (
- struct GNUNET_RECLAIM_CredentialList *al)
+ struct GNUNET_RECLAIM_CredentialList *credentials)
{
struct GNUNET_RECLAIM_CredentialListEntry *ale;
struct GNUNET_RECLAIM_CredentialListEntry *tmp_ale;
- for (ale = al->list_head; NULL != ale;)
+ for (ale = credentials->list_head; NULL != ale;)
{
if (NULL != ale->credential)
GNUNET_free (ale->credential);
@@ -435,7 +407,7 @@ GNUNET_RECLAIM_credential_list_destroy (
ale = ale->next;
GNUNET_free (tmp_ale);
}
- GNUNET_free (al);
+ GNUNET_free (credentials);
}
@@ -454,13 +426,6 @@ GNUNET_RECLAIM_credential_serialize_get_size (
}
-/**
- * Serialize an credential
- *
- * @param attr the credential to serialize
- * @param result the serialized credential
- * @return length of serialized data
- */
size_t
GNUNET_RECLAIM_credential_serialize (
const struct GNUNET_RECLAIM_Credential *credential,
@@ -627,12 +592,6 @@ GNUNET_RECLAIM_presentation_typename_to_number (const char
*typename)
}
-/**
- * Convert an presentation type number to the corresponding presentation type
string
- *
- * @param type number of a type
- * @return corresponding typestring, NULL on error
- */
const char *
GNUNET_RECLAIM_presentation_number_to_typename (uint32_t type)
{
@@ -758,13 +717,6 @@ GNUNET_RECLAIM_presentation_list_serialize_get_size (
}
-/**
- * Serialize an attribute list
- *
- * @param attrs the attribute list to serialize
- * @param result the serialized attribute
- * @return length of serialized data
- */
size_t
GNUNET_RECLAIM_presentation_list_serialize (
const struct GNUNET_RECLAIM_PresentationList *presentations,
@@ -862,19 +814,14 @@ GNUNET_RECLAIM_presentation_list_dup (
}
-/**
- * Destroy presentation list
- *
- * @param attrs list to destroy
- */
void
GNUNET_RECLAIM_presentation_list_destroy (
- struct GNUNET_RECLAIM_PresentationList *al)
+ struct GNUNET_RECLAIM_PresentationList *presentations)
{
struct GNUNET_RECLAIM_PresentationListEntry *ale;
struct GNUNET_RECLAIM_PresentationListEntry *tmp_ale;
- for (ale = al->list_head; NULL != ale;)
+ for (ale = presentations->list_head; NULL != ale;)
{
if (NULL != ale->presentation)
GNUNET_free (ale->presentation);
@@ -882,7 +829,7 @@ GNUNET_RECLAIM_presentation_list_destroy (
ale = ale->next;
GNUNET_free (tmp_ale);
}
- GNUNET_free (al);
+ GNUNET_free (presentations);
}
@@ -900,13 +847,6 @@ GNUNET_RECLAIM_presentation_serialize_get_size (
}
-/**
- * Serialize an presentation
- *
- * @param attr the presentation to serialize
- * @param result the serialized presentation
- * @return length of serialized data
- */
size_t
GNUNET_RECLAIM_presentation_serialize (
const struct GNUNET_RECLAIM_Presentation *presentation,
diff --git a/src/regex/gnunet-regex-profiler.c
b/src/regex/gnunet-regex-profiler.c
index 721b77756..8238ad3df 100644
--- a/src/regex/gnunet-regex-profiler.c
+++ b/src/regex/gnunet-regex-profiler.c
@@ -963,7 +963,6 @@ daemon_started (void *cls,
* into the DHT.
*
* @param cls NULL
- * @param tc the task context
*/
static void
do_announce (void *cls)
diff --git a/src/regex/gnunet-service-regex.c b/src/regex/gnunet-service-regex.c
index deaa6112e..c25ef9eda 100644
--- a/src/regex/gnunet-service-regex.c
+++ b/src/regex/gnunet-service-regex.c
@@ -124,7 +124,7 @@ reannounce (void *cls)
*
* @param cls identification of the client
* @param am the actual message
- * @return #GNUNET_OK if @am is well-formed
+ * @return #GNUNET_OK if @a am is well-formed
*/
static int
check_announce (void *cls,
@@ -238,7 +238,7 @@ handle_search_result (void *cls,
* Check SEARCH message.
*
* @param cls identification of the client
- * @param message the actual message
+ * @param sm the actual message
*/
static int
check_search (void *cls,
@@ -269,7 +269,7 @@ check_search (void *cls,
* Handle SEARCH message.
*
* @param cls identification of the client
- * @param message the actual message
+ * @param sm the actual message
*/
static void
handle_search (void *cls,
diff --git a/src/regex/regex_api_announce.c b/src/regex/regex_api_announce.c
index ad8a4fab9..12f173476 100644
--- a/src/regex/regex_api_announce.c
+++ b/src/regex/regex_api_announce.c
@@ -169,11 +169,6 @@ GNUNET_REGEX_announce (const struct
GNUNET_CONFIGURATION_Handle *cfg,
}
-/**
- * Stop announcing the regex specified by the given handle.
- *
- * @param a handle returned by a previous #GNUNET_REGEX_announce() call.
- */
void
GNUNET_REGEX_announce_cancel (struct GNUNET_REGEX_Announcement *a)
{
diff --git a/src/regex/regex_api_search.c b/src/regex/regex_api_search.c
index 960719cbd..71219cbdd 100644
--- a/src/regex/regex_api_search.c
+++ b/src/regex/regex_api_search.c
@@ -185,18 +185,6 @@ search_reconnect (struct GNUNET_REGEX_Search *s)
}
-/**
- * Search for a peer offering a regex matching certain string in the DHT.
- * The search runs until #GNUNET_REGEX_search_cancel() is called, even if
results
- * are returned.
- *
- * @param cfg configuration to use
- * @param string String to match against the regexes in the DHT.
- * @param callback Callback for found peers.
- * @param callback_cls Closure for @c callback.
- * @return Handle to stop search and free resources.
- * Must be freed by calling #GNUNET_REGEX_search_cancel().
- */
struct GNUNET_REGEX_Search *
GNUNET_REGEX_search (const struct GNUNET_CONFIGURATION_Handle *cfg,
const char *string,
@@ -233,11 +221,6 @@ GNUNET_REGEX_search (const struct
GNUNET_CONFIGURATION_Handle *cfg,
}
-/**
- * Stop search and free all data used by a #GNUNET_REGEX_search() call.
- *
- * @param s Handle returned by a previous #GNUNET_REGEX_search() call.
- */
void
GNUNET_REGEX_search_cancel (struct GNUNET_REGEX_Search *s)
{
diff --git a/src/regex/regex_block_lib.c b/src/regex/regex_block_lib.c
index cbfb553ce..048d6d743 100644
--- a/src/regex/regex_block_lib.c
+++ b/src/regex/regex_block_lib.c
@@ -110,14 +110,6 @@ GNUNET_BLOCK_is_accepting (const struct RegexBlock *block,
}
-/**
- * Check if the given 'proof' matches the given 'key'.
- *
- * @param proof partial regex of a state
- * @param proof_len number of bytes in 'proof'
- * @param key hash of a state.
- * @return #GNUNET_OK if the proof is valid for the given key.
- */
int
REGEX_BLOCK_check_proof (const char *proof,
size_t proof_len,
@@ -187,18 +179,6 @@ check_edge (void *cls,
}
-/**
- * Check if the regex block is well formed, including all edges.
- *
- * @param block The start of the block.
- * @param size The size of the block.
- * @param query the query for the block
- * @param xquery String describing the edge we are looking for.
- * Can be NULL in case this is a put block.
- * @return #GNUNET_OK in case it's fine.
- * #GNUNET_NO in case the xquery exists and is not found (IRRELEVANT).
- * #GNUNET_SYSERR if the block is invalid.
- */
int
REGEX_BLOCK_check (const struct RegexBlock *block,
size_t size,
@@ -246,14 +226,6 @@ REGEX_BLOCK_check (const struct RegexBlock *block,
}
-/**
- * Obtain the key that a particular block is to be stored under.
- *
- * @param block block to get the key from
- * @param block_len number of bytes in block
- * @param key where to store the key
- * @return #GNUNET_OK on success, #GNUNET_SYSERR if the block is malformed
- */
int
REGEX_BLOCK_get_key (const struct RegexBlock *block,
size_t block_len,
@@ -289,21 +261,6 @@ REGEX_BLOCK_get_key (const struct RegexBlock *block,
}
-/**
- * Iterate over all edges of a block of a regex state.
- *
- * @param block Block to iterate over.
- * @param size Size of @a block.
- * @param iterator Function to call on each edge in the block.
- * @param iter_cls Closure for the @a iterator.
- * @return #GNUNET_SYSERR if an error has been encountered.
- * #GNUNET_OK if no error has been encountered.
- * Note that if the iterator stops the iteration by returning
- * #GNUNET_NO, the block will no longer be checked for further errors.
- * The return value will be GNUNET_OK meaning that no errors were
- * found until the edge last notified to the iterator, but there might
- * be errors in further edges.
- */
int
REGEX_BLOCK_iterate (const struct RegexBlock *block,
size_t size,
diff --git a/src/regex/regex_internal.c b/src/regex/regex_internal.c
index aa40851a9..c4fab6b56 100644
--- a/src/regex/regex_internal.c
+++ b/src/regex/regex_internal.c
@@ -501,19 +501,6 @@ automaton_state_traverse (struct REGEX_INTERNAL_State *s,
}
-/**
- * Traverses the given automaton using depth-first-search (DFS) from it's start
- * state, visiting all reachable states and calling 'action' on each one of
- * them.
- *
- * @param a automaton to be traversed.
- * @param start start state, pass a->start or NULL to traverse the whole
automaton.
- * @param check function that is checked before advancing on each transition
- * in the DFS.
- * @param check_cls closure for @a check.
- * @param action action to be performed on each state.
- * @param action_cls closure for @a action
- */
void
REGEX_INTERNAL_automaton_traverse (const struct REGEX_INTERNAL_Automaton *a,
struct REGEX_INTERNAL_State *start,
@@ -3041,23 +3028,6 @@ construct_dfa_states (struct REGEX_INTERNAL_Context *ctx,
}
-/**
- * Construct DFA for the given 'regex' of length 'len'.
- *
- * Path compression means, that for example a DFA o -> a -> b -> c -> o will be
- * compressed to o -> abc -> o. Note that this parameter influences the
- * non-determinism of states of the resulting NFA in the DHT (number of
outgoing
- * edges with the same label). For example for an application that stores IPv4
- * addresses as bitstrings it could make sense to limit the path compression to
- * 4 or 8.
- *
- * @param regex regular expression string.
- * @param len length of the regular expression.
- * @param max_path_len limit the path compression length to the
- * given value. If set to 1, no path compression is applied. Set to 0
for
- * maximal possible path compression (generally not desirable).
- * @return DFA, needs to be freed using REGEX_INTERNAL_automaton_destroy.
- */
struct REGEX_INTERNAL_Automaton *
REGEX_INTERNAL_construct_dfa (const char *regex,
const size_t len,
@@ -3118,12 +3088,6 @@ REGEX_INTERNAL_construct_dfa (const char *regex,
}
-/**
- * Free the memory allocated by constructing the REGEX_INTERNAL_Automaton data
- * structure.
- *
- * @param a automaton to be destroyed
- */
void
REGEX_INTERNAL_automaton_destroy (struct REGEX_INTERNAL_Automaton *a)
{
@@ -3251,13 +3215,6 @@ evaluate_nfa (struct REGEX_INTERNAL_Automaton *a, const
char *string)
}
-/**
- * Evaluates the given @a string against the given compiled regex @a a
- *
- * @param a automaton
- * @param string string to check
- * @return 0 if string matches, non-0 otherwise
- */
int
REGEX_INTERNAL_eval (struct REGEX_INTERNAL_Automaton *a, const char *string)
{
@@ -3284,17 +3241,6 @@ REGEX_INTERNAL_eval (struct REGEX_INTERNAL_Automaton *a,
const char *string)
}
-/**
- * Get the canonical regex of the given automaton.
- * When constructing the automaton a proof is computed for each state,
- * consisting of the regular expression leading to this state. A complete
- * regex for the automaton can be computed by combining these proofs.
- * As of now this function is only useful for testing.
- *
- * @param a automaton for which the canonical regex should be returned.
- *
- * @return
- */
const char *
REGEX_INTERNAL_get_canonical_regex (struct REGEX_INTERNAL_Automaton *a)
{
@@ -3685,16 +3631,6 @@ iterate_reachables (void *cls, const struct
GNUNET_HashCode *key, void *value)
}
-/**
- * Iterate over all edges of automaton 'a' that are reachable from a state with
- * a proof of at least GNUNET_REGEX_INITIAL_BYTES characters.
- *
- * Call the iterator for each such edge.
- *
- * @param a automaton.
- * @param iterator iterator called for each reachable edge.
- * @param iterator_cls closure.
- */
void
REGEX_INTERNAL_iterate_reachable_edges (struct REGEX_INTERNAL_Automaton *a,
REGEX_INTERNAL_KeyIterator iterator,
diff --git a/src/regex/regex_internal.h b/src/regex/regex_internal.h
index 5b434b30c..8d4526d1f 100644
--- a/src/regex/regex_internal.h
+++ b/src/regex/regex_internal.h
@@ -368,9 +368,9 @@ typedef void
* @param start start state, pass a->start or NULL to traverse the whole
automaton.
* @param check function that is checked before advancing on each transition
* in the DFS.
- * @param check_cls closure for check.
+ * @param check_cls closure for @a check.
* @param action action to be performed on each state.
- * @param action_cls closure for action
+ * @param action_cls closure for @a action
*/
void
REGEX_INTERNAL_automaton_traverse (const struct REGEX_INTERNAL_Automaton *a,
diff --git a/src/regex/regex_internal_dht.c b/src/regex/regex_internal_dht.c
index e578fba2c..bda979edb 100644
--- a/src/regex/regex_internal_dht.c
+++ b/src/regex/regex_internal_dht.c
@@ -216,12 +216,6 @@ REGEX_INTERNAL_announce (struct GNUNET_DHT_Handle *dht,
}
-/**
- * Announce again a regular expression previously announced.
- * Does use caching to speed up process.
- *
- * @param h Handle returned by a previous #REGEX_INTERNAL_announce call().
- */
void
REGEX_INTERNAL_reannounce (struct REGEX_INTERNAL_Announcement *h)
{
diff --git a/src/rest/gnunet-rest-server.c b/src/rest/gnunet-rest-server.c
index b3ca6382a..1ea4471d1 100644
--- a/src/rest/gnunet-rest-server.c
+++ b/src/rest/gnunet-rest-server.c
@@ -905,7 +905,6 @@ do_httpd (void *cls)
* Accept new incoming connections
*
* @param cls the closure with the lsock4 or lsock6
- * @param tc the scheduler context
*/
static void
do_accept (void *cls)
diff --git a/src/rest/plugin_rest_config.c b/src/rest/plugin_rest_config.c
index b0f18754c..826188702 100644
--- a/src/rest/plugin_rest_config.c
+++ b/src/rest/plugin_rest_config.c
@@ -113,7 +113,6 @@ cleanup_handle (struct RequestHandle *handle)
* Task run on shutdown. Cleans up everything.
*
* @param cls unused
- * @param tc scheduler context
*/
static void
do_error (void *cls)
diff --git a/src/rest/rest.c b/src/rest/rest.c
index 930f66243..757c0b979 100644
--- a/src/rest/rest.c
+++ b/src/rest/rest.c
@@ -33,13 +33,6 @@
* REST Utilities
*/
-/**
- * Check if namespace is in URL.
- *
- * @param url URL to check
- * @param namespace namespace to check against
- * @return GNUNET_YES if namespace matches
- */
int
GNUNET_REST_namespace_match (const char *url, const char *namespace)
{
@@ -47,12 +40,6 @@ GNUNET_REST_namespace_match (const char *url, const char
*namespace)
}
-/**
- * Create MHD response
- *
- * @param data result
- * @return MHD response
- */
struct MHD_Response*
GNUNET_REST_create_response (const char *data)
{
diff --git a/src/revocation/revocation_api.c b/src/revocation/revocation_api.c
index b8c458e4f..78b3c083a 100644
--- a/src/revocation/revocation_api.c
+++ b/src/revocation/revocation_api.c
@@ -371,11 +371,6 @@ GNUNET_REVOCATION_revoke (const struct
GNUNET_CONFIGURATION_Handle *cfg,
}
-/**
- * Cancel key revocation.
- *
- * @param h operation to cancel
- */
void
GNUNET_REVOCATION_revoke_cancel (struct GNUNET_REVOCATION_Handle *h)
{
@@ -623,15 +618,6 @@ GNUNET_REVOCATION_pow_init (const struct
GNUNET_IDENTITY_PrivateKey *key,
}
-/**
- * Starts a proof-of-work calculation given the pow object as well as
- * target epochs and difficulty.
- *
- * @param pow the PoW to based calculations on.
- * @param epochs the number of epochs for which the PoW must be valid.
- * @param difficulty the base difficulty of the PoW.
- * @return a handle for use in PoW rounds
- */
struct GNUNET_REVOCATION_PowCalculationHandle*
GNUNET_REVOCATION_pow_start (struct GNUNET_REVOCATION_PowP *pow,
int epochs,
diff --git a/src/rps/gnunet-rps-profiler.c b/src/rps/gnunet-rps-profiler.c
index 6d1236f08..df10ad5da 100644
--- a/src/rps/gnunet-rps-profiler.c
+++ b/src/rps/gnunet-rps-profiler.c
@@ -2206,7 +2206,7 @@ get_idx_of_pid (const struct GNUNET_PeerIdentity *pid)
* @brief Counts number of peers in view of a that have b in their view
*
* @param a
- * @param uint32_tb
+ * @param b
*
* @return
*/
diff --git a/src/rps/gnunet-rps.c b/src/rps/gnunet-rps.c
index 33c03f006..f90fc0d88 100644
--- a/src/rps/gnunet-rps.c
+++ b/src/rps/gnunet-rps.c
@@ -149,7 +149,7 @@ view_update_handle (void *cls,
/**
* Callback called on receipt of peer from biased stream
*
- * @param n number of peers
+ * @param num_peers number of peers
* @param recv_peers the received peers
*/
static void
diff --git a/src/rps/gnunet-service-rps.c b/src/rps/gnunet-service-rps.c
index f6fcf3ae7..be9324af9 100644
--- a/src/rps/gnunet-service-rps.c
+++ b/src/rps/gnunet-service-rps.c
@@ -1191,7 +1191,7 @@ check_operation_scheduled (const struct PeerContext
*peer_ctx,
/**
* @brief Callback for scheduler to destroy a channel
*
- * @param cls Context of the channel
+ * @param channel_ctx Context of the channel
*/
static void
destroy_channel (struct ChannelCtx *channel_ctx)
@@ -3324,7 +3324,7 @@ check_client_seed (void *cls, const struct
GNUNET_RPS_CS_SeedMessage *msg)
* Handle seed from the client.
*
* @param cls closure
- * @param message the actual message
+ * @param msg the actual message
*/
static void
handle_client_seed (void *cls,
@@ -3362,7 +3362,7 @@ handle_client_seed (void *cls,
* Handle RPS request from the client.
*
* @param cls Client context
- * @param message Message containing the number of updates the client wants to
+ * @param msg Message containing the number of updates the client wants to
* receive
*/
static void
@@ -3416,7 +3416,7 @@ handle_client_view_cancel (void *cls,
* Handle RPS request for biased stream from the client.
*
* @param cls Client context
- * @param message unused
+ * @param msg unused
*/
static void
handle_client_stream_request (void *cls,
@@ -4691,7 +4691,7 @@ valid_peers_iterator (void *cls,
* @param cls Closure - Sub
* @param peer id of the peer, NULL for last call
* @param hello hello message for the peer (can be NULL)
- * @param error message
+ * @param err_msg error message
*/
void
process_peerinfo_peers (void *cls,
@@ -4823,7 +4823,7 @@ client_connect_cb (void *cls,
* Callback called when a client disconnected from the service
*
* @param cls closure for the service
- * @param c the client that disconnected
+ * @param client the client that disconnected
* @param internal_cls should be equal to @a c
*/
static void
diff --git a/src/rps/gnunet-service-rps_sampler_elem.c
b/src/rps/gnunet-service-rps_sampler_elem.c
index aa8b72445..a6dc755a3 100644
--- a/src/rps/gnunet-service-rps_sampler_elem.c
+++ b/src/rps/gnunet-service-rps_sampler_elem.c
@@ -44,7 +44,7 @@
/**
* Reinitialise a previously initialised sampler element.
*
- * @param sampler_el The sampler element to (re-) initialise
+ * @param sampler_elem The sampler element to (re-) initialise
*/
void
RPS_sampler_elem_reinit (struct RPS_SamplerElement *sampler_elem)
diff --git a/src/rps/rps-sampler_common.c b/src/rps/rps-sampler_common.c
index a30ba06a1..e3fb79501 100644
--- a/src/rps/rps-sampler_common.c
+++ b/src/rps/rps-sampler_common.c
@@ -191,15 +191,6 @@ RPS_sampler_set_desired_probability (struct RPS_Sampler
*sampler,
}
-/**
- * @brief Set the deficiency factor.
- *
- * Only used/useful with the client sampler
- * (Maybe move to rps-sampler_client.{h|c} ?)
- *
- * @param sampler
- * @param desired_probability
- */
void
RPS_sampler_set_deficiency_factor (struct RPS_Sampler *sampler,
double deficiency_factor)
@@ -440,7 +431,6 @@ RPS_sampler_resize (struct RPS_Sampler *sampler, unsigned
int new_size)
* Empty the sampler.
*
* @param sampler the sampler to empty.
- * @param new_size the new size of the sampler
*/
static void
sampler_empty (struct RPS_Sampler *sampler)
@@ -555,18 +545,6 @@ check_peer_info_ready (void *cls,
}
-/**
- * Get n random peers out of the sampled peers.
- *
- * We might want to reinitialise this sampler after giving the
- * corrsponding peer to the client.
- * Random with or without consumption?
- *
- * @param sampler the sampler to get peers from.
- * @param cb callback that will be called once the ids are ready.
- * @param cls closure given to @a cb
- * @param num_peers the number of peers requested
- */
struct RPS_SamplerRequestHandle *
RPS_sampler_get_n_rand_peers (struct RPS_Sampler *sampler,
uint32_t num_peers,
diff --git a/src/rps/rps-sampler_common.h b/src/rps/rps-sampler_common.h
index c60d37217..94727028a 100644
--- a/src/rps/rps-sampler_common.h
+++ b/src/rps/rps-sampler_common.h
@@ -325,8 +325,6 @@ RPS_sampler_resize (struct RPS_Sampler *sampler, unsigned
int new_size);
* @param sampler the sampler to get peers from.
* @param cb callback that will be called once the ids are ready.
* @param cls closure given to @a cb
- * @param for_client #GNUNET_YES if result is used for client,
- * #GNUNET_NO if used internally
* @param num_peers the number of peers requested
*/
struct RPS_SamplerRequestHandle *
diff --git a/src/rps/rps_api.c b/src/rps/rps_api.c
index bb4c3597e..c4166745a 100644
--- a/src/rps/rps_api.c
+++ b/src/rps/rps_api.c
@@ -745,7 +745,7 @@ mq_error_handler (void *cls,
* (-group)
*
* @param share_val Share value
- * @param hash[out] Pointer to the location in which the hash will be stored.
+ * @param[out] hash Pointer to the location in which the hash will be stored.
*/
static void
hash_from_share_val (const char *share_val,
diff --git a/src/scalarproduct/gnunet-scalarproduct.c
b/src/scalarproduct/gnunet-scalarproduct.c
index 14495de05..07af916b1 100644
--- a/src/scalarproduct/gnunet-scalarproduct.c
+++ b/src/scalarproduct/gnunet-scalarproduct.c
@@ -190,7 +190,6 @@ requester_callback (void *cls,
* Task run during shutdown.
*
* @param cls unused
- * @param tc unused
*/
static void
shutdown_task (void *cls)
diff --git a/src/scalarproduct/gnunet-service-scalarproduct-ecc_alice.c
b/src/scalarproduct/gnunet-service-scalarproduct-ecc_alice.c
index dc43b5a54..c43a7e854 100644
--- a/src/scalarproduct/gnunet-service-scalarproduct-ecc_alice.c
+++ b/src/scalarproduct/gnunet-service-scalarproduct-ecc_alice.c
@@ -761,7 +761,7 @@ cb_intersection_request_alice (void *cls,
/**
* Our client has finished sending us its multipart message.
*
- * @param session the service session context
+ * @param s the service session context
*/
static void
client_request_complete_alice (struct AliceServiceSession *s)
diff --git a/src/scalarproduct/gnunet-service-scalarproduct-ecc_bob.c
b/src/scalarproduct/gnunet-service-scalarproduct-ecc_bob.c
index 02a62c164..1945f1937 100644
--- a/src/scalarproduct/gnunet-service-scalarproduct-ecc_bob.c
+++ b/src/scalarproduct/gnunet-service-scalarproduct-ecc_bob.c
@@ -208,7 +208,7 @@ free_element_cb (void *cls,
/**
* Destroy session state, we are done with it.
*
- * @param session the session to free elements from
+ * @param s the session to free elements from
*/
static void
destroy_service_session (struct BobServiceSession *s)
@@ -297,8 +297,6 @@ prepare_client_end_notification (struct BobServiceSession
*session)
*
* @param cls the `struct BobServiceSession`
* @param channel connection to the other end (henceforth invalid)
- * @param channel_ctx place where local state associated
- * with the channel is stored
*/
static void
cb_channel_destruction (void *cls,
diff --git a/src/scalarproduct/gnunet-service-scalarproduct_alice.c
b/src/scalarproduct/gnunet-service-scalarproduct_alice.c
index 665d2ad7f..59c3c6f6c 100644
--- a/src/scalarproduct/gnunet-service-scalarproduct_alice.c
+++ b/src/scalarproduct/gnunet-service-scalarproduct_alice.c
@@ -672,7 +672,7 @@ handle_bobs_cryptodata_multipart (
* calculate a scalarproduct with.
*
* @param cls our `struct AliceServiceSession`
- * @param message the actual message
+ * @param msg the actual message
* @return #GNUNET_OK to keep the connection open,
* #GNUNET_SYSERR to close it (we are done)
*/
diff --git a/src/scalarproduct/gnunet-service-scalarproduct_bob.c
b/src/scalarproduct/gnunet-service-scalarproduct_bob.c
index b0299779d..15ad3038e 100644
--- a/src/scalarproduct/gnunet-service-scalarproduct_bob.c
+++ b/src/scalarproduct/gnunet-service-scalarproduct_bob.c
@@ -563,7 +563,7 @@ compute_square_sum (const gcry_mpi_t *vector,
* S: $S := E_A(sum (r_i + b_i)^2)$
* S': $S' := E_A(sum r_i^2)$
*
- * @param request the requesting session + bob's requesting peer
+ * @param session the requesting session + bob's requesting peer
* @return #GNUNET_OK on success
*/
static int
diff --git a/src/scalarproduct/scalarproduct_api.c
b/src/scalarproduct/scalarproduct_api.c
index 44d6bd812..8c667a72e 100644
--- a/src/scalarproduct/scalarproduct_api.c
+++ b/src/scalarproduct/scalarproduct_api.c
@@ -140,7 +140,7 @@ process_status_message (struct
GNUNET_SCALARPRODUCT_ComputationHandle *h,
* handles the response to the client which used the API.
*
* @param cls Pointer to the Master Context
- * @param msg Pointer to the data received in response
+ * @param message Pointer to the data received in response
*/
static void
handle_response (void *cls,
@@ -210,17 +210,6 @@ mq_error_handler (void *cls,
}
-/**
- * Used by Bob's client to cooperate with Alice,
- *
- * @param cfg the gnunet configuration handle
- * @param key Session key unique to the requesting client
- * @param elements Array of elements of the vector
- * @param element_count Number of elements in the @a elements vector
- * @param cont Callback function
- * @param cont_cls Closure for @a cont
- * @return a new handle for this computation
- */
struct GNUNET_SCALARPRODUCT_ComputationHandle *
GNUNET_SCALARPRODUCT_accept_computation (
const struct GNUNET_CONFIGURATION_Handle *cfg,
@@ -368,18 +357,6 @@ process_result_message (struct
GNUNET_SCALARPRODUCT_ComputationHandle *h,
}
-/**
- * Request by Alice's client for computing a scalar product
- *
- * @param cfg the gnunet configuration handle
- * @param session_key Session key should be unique to the requesting client
- * @param peer PeerID of the other peer
- * @param elements Array of elements of the vector
- * @param element_count Number of elements in the @a elements vector
- * @param cont Callback function
- * @param cont_cls Closure for @a cont
- * @return a new handle for this computation
- */
struct GNUNET_SCALARPRODUCT_ComputationHandle *
GNUNET_SCALARPRODUCT_start_computation (
const struct GNUNET_CONFIGURATION_Handle *cfg,
diff --git a/src/secretsharing/gnunet-service-secretsharing.c
b/src/secretsharing/gnunet-service-secretsharing.c
index 939b7827d..84338bd11 100644
--- a/src/secretsharing/gnunet-service-secretsharing.c
+++ b/src/secretsharing/gnunet-service-secretsharing.c
@@ -653,7 +653,6 @@ keygen_session_destroy (struct KeygenSession *ks)
* Task run during shutdown.
*
* @param cls unused
- * @param tc unused
*/
static void
cleanup_task (void *cls)
diff --git a/src/secretsharing/secretsharing_api.c
b/src/secretsharing/secretsharing_api.c
index 98f800c95..595af751f 100644
--- a/src/secretsharing/secretsharing_api.c
+++ b/src/secretsharing/secretsharing_api.c
@@ -316,19 +316,6 @@ handle_decrypt_done (void *cls,
}
-/**
- * Publish the given ciphertext for decryption. Once a sufficient (>=k)
number of peers has
- * published the same value, it will be decrypted.
- *
- * When the operation is canceled, the decrypt_cb is not called anymore, but
the calling
- * peer may already have irrevocably contributed its share for the decryption
of the value.
- *
- * @param share our secret share to use for decryption
- * @param ciphertext ciphertext to publish in order to decrypt it (if enough
peers agree)
- * @param decrypt_cb callback called once the decryption succeeded
- * @param decrypt_cb_cls closure for @a decrypt_cb
- * @return handle to cancel the operation
- */
struct GNUNET_SECRETSHARING_DecryptionHandle *
GNUNET_SECRETSHARING_decrypt (const struct GNUNET_CONFIGURATION_Handle *cfg,
struct GNUNET_SECRETSHARING_Share *share,
@@ -431,19 +418,6 @@ GNUNET_SECRETSHARING_plaintext_generate_i (struct
}
-/**
- * Encrypt a value. This operation is executed locally, no communication is
- * necessary.
- *
- * This is a helper function, encryption can be done solely with a session's
public key
- * and the crypto system parameters.
- *
- * @param public_key public key to use for decryption
- * @param message message to encrypt
- * @param message_size number of bytes in @a message
- * @param result_ciphertext pointer to store the resulting ciphertext
- * @return #GNUNET_YES on success, #GNUNET_SYSERR if the message is invalid
(invalid range)
- */
int
GNUNET_SECRETSHARING_encrypt (const struct
GNUNET_SECRETSHARING_PublicKey *public_key,
diff --git a/src/secretsharing/secretsharing_protocol.h
b/src/secretsharing/secretsharing_protocol.h
index d4aaecb6c..e6f3ba286 100644
--- a/src/secretsharing/secretsharing_protocol.h
+++ b/src/secretsharing/secretsharing_protocol.h
@@ -108,22 +108,22 @@ struct GNUNET_SECRETSHARING_DecryptData
*/
struct GNUNET_PeerIdentity peer;
/**
- * Partial decryption, computed as c_1^{s_i}
+ * Partial decryption, computed as \f$c_1^{s_i}\f$
*/
struct GNUNET_SECRETSHARING_FieldElement partial_decryption;
/**
* Commitment for the non-interactive zero knowledge proof.
- * g^\beta, with \beta < q
+ * \f$g^\beta\f$, with \f$\beta < q\f$
*/
struct GNUNET_SECRETSHARING_FieldElement nizk_commit1;
/**
* Commitment for the non-interactive zero knowledge proof.
- * c_1^\beta, with \beta < q
+ * \f$c_1^\beta\f$, with \f$\beta < q\f$
*/
struct GNUNET_SECRETSHARING_FieldElement nizk_commit2;
/**
* Response to the challenge computed from the protocol transcript.
- * r = \beta + challenge \cdot share_i
+ * \f$r = \beta + challenge \cdot share_i\f$
*/
struct GNUNET_SECRETSHARING_FieldElement nizk_response;
};
diff --git a/src/set/gnunet-service-set.c b/src/set/gnunet-service-set.c
index 2b859d81a..208c63a1a 100644
--- a/src/set/gnunet-service-set.c
+++ b/src/set/gnunet-service-set.c
@@ -176,7 +176,6 @@ static uint32_t suggest_id;
/**
* Get the incoming socket associated with the given id.
*
- * @param listener the listener to look in
* @param id id to look for
* @return the incoming socket associated with the id,
* or NULL if there is none
@@ -1006,7 +1005,7 @@ handle_client_iterate (void *cls, const struct
GNUNET_MessageHeader *m)
* operation to be performed.
*
* @param cls client that sent the message
- * @param m message sent by the client
+ * @param msg message sent by the client
*/
static void
handle_client_create_set (void *cls, const struct GNUNET_SET_CreateMessage
*msg)
@@ -1066,7 +1065,6 @@ handle_client_create_set (void *cls, const struct
GNUNET_SET_CreateMessage *msg)
* - we got the channel from a peer but no
#GNUNET_MESSAGE_TYPE_SET_P2P_OPERATION_REQUEST
*
* @param cls channel context
- * @param tc context information (why was this task triggered now)
*/
static void
incoming_timeout_cb (void *cls)
diff --git a/src/set/gnunet-service-set_intersection.c
b/src/set/gnunet-service-set_intersection.c
index 9313483bb..51a8d0dbc 100644
--- a/src/set/gnunet-service-set_intersection.c
+++ b/src/set/gnunet-service-set_intersection.c
@@ -754,13 +754,6 @@ begin_bf_exchange (struct Operation *op)
}
-/**
- * Handle the initial `struct IntersectionElementInfoMessage` from a
- * remote peer.
- *
- * @param cls the intersection operation
- * @param mh the header of the message
- */
void
handle_intersection_p2p_element_info (void *cls,
const struct
@@ -1039,7 +1032,7 @@ filter_all (void *cls,
* Handle a done message from a remote peer
*
* @param cls the intersection operation
- * @param mh the message
+ * @param idm the message
*/
void
handle_intersection_p2p_done (void *cls,
diff --git a/src/set/gnunet-service-set_intersection.h
b/src/set/gnunet-service-set_intersection.h
index 200e8f5ff..d8884d0a7 100644
--- a/src/set/gnunet-service-set_intersection.h
+++ b/src/set/gnunet-service-set_intersection.h
@@ -57,7 +57,7 @@ handle_intersection_p2p_bf (void *cls,
* remote peer.
*
* @param cls the intersection operation
- * @param mh the header of the message
+ * @param msg the header of the message
*/
void
handle_intersection_p2p_element_info (void *cls,
diff --git a/src/set/gnunet-service-set_union.c
b/src/set/gnunet-service-set_union.c
index d762e4bba..3a2bc8bd7 100644
--- a/src/set/gnunet-service-set_union.c
+++ b/src/set/gnunet-service-set_union.c
@@ -2194,12 +2194,6 @@ handle_union_p2p_done (void *cls,
}
-/**
- * Handle a over message from a remote peer
- *
- * @param cls the union operation
- * @param mh the message
- */
void
handle_union_p2p_over (void *cls,
const struct GNUNET_MessageHeader *mh)
diff --git a/src/set/gnunet-service-set_union_strata_estimator.c
b/src/set/gnunet-service-set_union_strata_estimator.c
index 97b4a1f98..6de9fb5eb 100644
--- a/src/set/gnunet-service-set_union_strata_estimator.c
+++ b/src/set/gnunet-service-set_union_strata_estimator.c
@@ -155,12 +155,6 @@ strata_estimator_insert (struct StrataEstimator *se,
}
-/**
- * Remove a key from the strata estimator.
- *
- * @param se strata estimator to remove the key from
- * @param key key to remove
- */
void
strata_estimator_remove (struct StrataEstimator *se,
struct IBF_Key key)
diff --git a/src/set/set_api.c b/src/set/set_api.c
index 6b3dc940c..4f73ff06c 100644
--- a/src/set/set_api.c
+++ b/src/set/set_api.c
@@ -296,7 +296,7 @@ check_iter_element (void *cls,
* iterator and sends an acknowledgement to the service.
*
* @param cls the `struct GNUNET_SET_Handle *`
- * @param mh the message
+ * @param msg the message
*/
static void
handle_iter_element (void *cls,
@@ -669,19 +669,6 @@ GNUNET_SET_create (const struct
GNUNET_CONFIGURATION_Handle *cfg,
}
-/**
- * Add an element to the given set. After the element has been added
- * (in the sense of being transmitted to the set service), @a cont
- * will be called. Multiple calls to GNUNET_SET_add_element() can be
- * queued.
- *
- * @param set set to add element to
- * @param element element to add to the set
- * @param cont continuation called after the element has been added
- * @param cont_cls closure for @a cont
- * @return #GNUNET_OK on success, #GNUNET_SYSERR if the
- * set is invalid (e.g. the set service crashed)
- */
int
GNUNET_SET_add_element (struct GNUNET_SET_Handle *set,
const struct GNUNET_SET_Element *element,
@@ -716,19 +703,6 @@ GNUNET_SET_add_element (struct GNUNET_SET_Handle *set,
}
-/**
- * Remove an element to the given set. After the element has been
- * removed (in the sense of the request being transmitted to the set
- * service), @a cont will be called. Multiple calls to
- * GNUNET_SET_remove_element() can be queued
- *
- * @param set set to remove element from
- * @param element element to remove from the set
- * @param cont continuation called after the element has been removed
- * @param cont_cls closure for @a cont
- * @return #GNUNET_OK on success, #GNUNET_SYSERR if the
- * set is invalid (e.g. the set service crashed)
- */
int
GNUNET_SET_remove_element (struct GNUNET_SET_Handle *set,
const struct GNUNET_SET_Element *element,
@@ -794,20 +768,6 @@ GNUNET_SET_destroy (struct GNUNET_SET_Handle *set)
}
-/**
- * Prepare a set operation to be evaluated with another peer.
- * The evaluation will not start until the client provides
- * a local set with #GNUNET_SET_commit().
- *
- * @param other_peer peer with the other set
- * @param app_id hash for the application using the set
- * @param context_msg additional information for the request
- * @param result_mode specified how results will be returned,
- * see `enum GNUNET_SET_ResultMode`.
- * @param result_cb called on error or success
- * @param result_cls closure for @e result_cb
- * @return a handle to cancel the operation
- */
struct GNUNET_SET_OperationHandle *
GNUNET_SET_prepare (const struct GNUNET_PeerIdentity *other_peer,
const struct GNUNET_HashCode *app_id,
@@ -1066,20 +1026,6 @@ GNUNET_SET_listen_cancel (struct GNUNET_SET_ListenHandle
*lh)
}
-/**
- * Accept a request we got via #GNUNET_SET_listen. Must be called during
- * #GNUNET_SET_listen, as the 'struct GNUNET_SET_Request' becomes invalid
- * afterwards.
- * Call #GNUNET_SET_commit to provide the local set to use for the operation,
- * and to begin the exchange with the remote peer.
- *
- * @param request request to accept
- * @param result_mode specified how results will be returned,
- * see `enum GNUNET_SET_ResultMode`.
- * @param result_cb callback for the results
- * @param result_cls closure for @a result_cb
- * @return a handle to cancel the operation
- */
struct GNUNET_SET_OperationHandle *
GNUNET_SET_accept (struct GNUNET_SET_Request *request,
enum GNUNET_SET_ResultMode result_mode,
@@ -1234,13 +1180,6 @@ GNUNET_SET_element_dup (const struct GNUNET_SET_Element
*element)
}
-/**
- * Hash a set element.
- *
- * @param element the element that should be hashed
- * @param[out] ret_hash a pointer to where the hash of @a element
- * should be stored
- */
void
GNUNET_SET_element_hash (const struct GNUNET_SET_Element *element,
struct GNUNET_HashCode *ret_hash)
diff --git a/src/seti/seti_api.c b/src/seti/seti_api.c
index 933aec0e1..6522236c6 100644
--- a/src/seti/seti_api.c
+++ b/src/seti/seti_api.c
@@ -509,19 +509,6 @@ GNUNET_SETI_destroy (struct GNUNET_SETI_Handle *set)
}
-/**
- * Prepare a set operation to be evaluated with another peer.
- * The evaluation will not start until the client provides
- * a local set with #GNUNET_SETI_commit().
- *
- * @param other_peer peer with the other set
- * @param app_id hash for the application using the set
- * @param context_msg additional information for the request
- * @param options options to use when processing the request
- * @param result_cb called on error or success
- * @param result_cls closure for @e result_cb
- * @return a handle to cancel the operation
- */
struct GNUNET_SETI_OperationHandle *
GNUNET_SETI_prepare (const struct GNUNET_PeerIdentity *other_peer,
const struct GNUNET_HashCode *app_id,
@@ -763,19 +750,6 @@ GNUNET_SETI_listen_cancel (struct GNUNET_SETI_ListenHandle
*lh)
}
-/**
- * Accept a request we got via #GNUNET_SETI_listen. Must be called during
- * #GNUNET_SETI_listen, as the 'struct GNUNET_SETI_Request' becomes invalid
- * afterwards.
- * Call #GNUNET_SETI_commit to provide the local set to use for the operation,
- * and to begin the exchange with the remote peer.
- *
- * @param request request to accept
- * @param options options to use when processing the request
- * @param result_cb callback for the results
- * @param result_cls closure for @a result_cb
- * @return a handle to cancel the operation
- */
struct GNUNET_SETI_OperationHandle *
GNUNET_SETI_accept (struct GNUNET_SETI_Request *request,
const struct GNUNET_SETI_Option options[],
diff --git a/src/setu/ibf.c b/src/setu/ibf.c
index dbd23c320..3978aa3c6 100644
--- a/src/setu/ibf.c
+++ b/src/setu/ibf.c
@@ -216,18 +216,6 @@ ibf_is_empty (struct InvertibleBloomFilter *ibf)
}
-/**
- * Decode and remove an element from the IBF, if possible.
- *
- * @param ibf the invertible bloom filter to decode
- * @param ret_side sign of the cell's count where the decoded element came
from.
- * A negative sign indicates that the element was recovered
- * resides in an IBF that was previously subtracted from.
- * @param ret_id receives the hash code of the decoded element, if successful
- * @return #GNUNET_YES if decoding an element was successful,
- * #GNUNET_NO if the IBF is empty,
- * #GNUNET_SYSERR if the decoding has failed
- */
int
ibf_decode (struct InvertibleBloomFilter *ibf,
int *ret_side,
@@ -355,15 +343,6 @@ ibf_write_slice (const struct InvertibleBloomFilter *ibf,
}
-/**
- * Packs the counter to transmit only the smallest possible amount of bytes
and
- * preventing overflow of the counter
- * @param ibf the ibf to write
- * @param start with which bucket to start
- * @param count how many buckets to write
- * @param buf buffer to write the data to
- * @param max bit length of a counter for unpacking
- */
void
pack_counter (const struct InvertibleBloomFilter *ibf,
@@ -428,15 +407,6 @@ pack_counter (const struct InvertibleBloomFilter *ibf,
}
-/**
- * Unpacks the counter to transmit only the smallest possible amount of bytes
and
- * preventing overflow of the counter
- * @param ibf the ibf to write
- * @param start with which bucket to start
- * @param count how many buckets to write
- * @param buf buffer to write the data to
- * @param max bit length of a counter for unpacking
- */
void
unpack_counter (const struct InvertibleBloomFilter *ibf,
diff --git a/src/setu/setu_api.c b/src/setu/setu_api.c
index faa57aaba..7fa144590 100644
--- a/src/setu/setu_api.c
+++ b/src/setu/setu_api.c
@@ -493,18 +493,6 @@ GNUNET_SETU_destroy (struct GNUNET_SETU_Handle *set)
}
-/**
- * Prepare a set operation to be evaluated with another peer.
- * The evaluation will not start until the client provides
- * a local set with #GNUNET_SETU_commit().
- *
- * @param other_peer peer with the other set
- * @param app_id hash for the application using the set
- * @param context_msg additional information for the request
- * @param result_cb called on error or success
- * @param result_cls closure for @e result_cb
- * @return a handle to cancel the operation
- */
struct GNUNET_SETU_OperationHandle *
GNUNET_SETU_prepare (const struct GNUNET_PeerIdentity *other_peer,
const struct GNUNET_HashCode *app_id,
@@ -777,20 +765,6 @@ GNUNET_SETU_listen_cancel (struct GNUNET_SETU_ListenHandle
*lh)
}
-/**
- * Accept a request we got via #GNUNET_SETU_listen. Must be called during
- * #GNUNET_SETU_listen, as the 'struct GNUNET_SETU_Request' becomes invalid
- * afterwards.
- * Call #GNUNET_SETU_commit to provide the local set to use for the operation,
- * and to begin the exchange with the remote peer.
- *
- * @param request request to accept
- * @param result_mode specified how results will be returned,
- * see `enum GNUNET_SETU_ResultMode`.
- * @param result_cb callback for the results
- * @param result_cls closure for @a result_cb
- * @return a handle to cancel the operation
- */
struct GNUNET_SETU_OperationHandle *
GNUNET_SETU_accept (struct GNUNET_SETU_Request *request,
const struct GNUNET_SETU_Option options[],
diff --git a/src/sq/sq.c b/src/sq/sq.c
index 7641cbacd..777fb6311 100644
--- a/src/sq/sq.c
+++ b/src/sq/sq.c
@@ -26,13 +26,6 @@
#include "gnunet_sq_lib.h"
-/**
- * Execute a prepared statement.
- *
- * @param db_conn database connection
- * @param params parameters to the statement
- * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
- */
int
GNUNET_SQ_bind (sqlite3_stmt *stmt,
const struct GNUNET_SQ_QueryParam *params)
@@ -107,12 +100,6 @@ GNUNET_SQ_extract_result (sqlite3_stmt *result,
}
-/**
- * Free all memory that was allocated in @a rs during
- * #GNUNET_SQ_extract_result().
- *
- * @param rs reult specification to clean up
- */
void
GNUNET_SQ_cleanup_result (struct GNUNET_SQ_ResultSpec *rs)
{
diff --git a/src/sq/sq_prepare.c b/src/sq/sq_prepare.c
index e1e1834b7..b3825ee71 100644
--- a/src/sq/sq_prepare.c
+++ b/src/sq/sq_prepare.c
@@ -46,14 +46,6 @@ GNUNET_SQ_make_prepare (const char *sql,
}
-/**
- * Prepare all statements given in the (NULL,NULL)-terminated
- * array at @a ps
- *
- * @param dbh database to use
- * @param ps array of statements to prepare
- * @return #GNUNET_OK on success
- */
int
GNUNET_SQ_prepare (sqlite3 *dbh,
const struct GNUNET_SQ_PrepareStatement *ps)
diff --git a/src/sq/sq_query_helper.c b/src/sq/sq_query_helper.c
index 1f7662b95..ead1b5bdd 100644
--- a/src/sq/sq_query_helper.c
+++ b/src/sq/sq_query_helper.c
@@ -60,7 +60,7 @@ bind_fixed_blob (void *cls,
* @a ptr_size bytes.
*
* @param ptr pointer to the query parameter to pass
- * @oaran ptr_size number of bytes in @a ptr
+ * @param ptr_size number of bytes in @a ptr
*/
struct GNUNET_SQ_QueryParam
GNUNET_SQ_query_param_fixed_size (const void *ptr,
diff --git a/src/statistics/gnunet-service-statistics.c
b/src/statistics/gnunet-service-statistics.c
index 31c367e91..37cf524d0 100644
--- a/src/statistics/gnunet-service-statistics.c
+++ b/src/statistics/gnunet-service-statistics.c
@@ -327,7 +327,7 @@ save ()
/**
* Transmit the given stats value.
*
- * @param client receiver of the value
+ * @param ce receiver of the value
* @param e value to transmit
*/
static void
@@ -541,9 +541,9 @@ find_subsystem_entry (struct ClientEntry *ce, const char
*service)
/**
* Find the statistics entry of the given subsystem.
*
- * @param subsystem subsystem to look in
+ * @param se subsystem to look in
* @param name name of the entry to look for
- * @return statistis entry, or NULL if not found
+ * @return statistics entry, or NULL if not found
*/
static struct StatsEntry *
find_stat_entry (struct SubsystemEntry *se, const char *name)
@@ -561,7 +561,7 @@ find_stat_entry (struct SubsystemEntry *se, const char
*name)
* Check format of SET-message.
*
* @param cls the `struct ClientEntry`
- * @param message the actual message
+ * @param msg the actual message
* @return #GNUNET_OK if message is well-formed
*/
static int
@@ -589,7 +589,7 @@ check_set (void *cls, const struct
GNUNET_STATISTICS_SetMessage *msg)
* Handle SET-message.
*
* @param cls the `struct ClientEntry`
- * @param message the actual message
+ * @param msg the actual message
*/
static void
handle_set (void *cls, const struct GNUNET_STATISTICS_SetMessage *msg)
diff --git a/src/statistics/statistics_api.c b/src/statistics/statistics_api.c
index 6e6acb3e5..88f127da8 100644
--- a/src/statistics/statistics_api.c
+++ b/src/statistics/statistics_api.c
@@ -446,7 +446,7 @@ check_statistics_value (void *cls,
* Process a #GNUNET_MESSAGE_TYPE_STATISTICS_VALUE message.
*
* @param cls statistics handle
- * @param msg message received from the service, never NULL
+ * @param smsg message received from the service, never NULL
* @return #GNUNET_OK if the message was well-formed
*/
static void
@@ -492,7 +492,7 @@ handle_statistics_value (void *cls,
* We have received a watch value from the service. Process it.
*
* @param cls statistics handle
- * @param msg the watch value message
+ * @param wvm the watch value message
*/
static void
handle_statistics_watch_value (void *cls,
@@ -1061,18 +1061,6 @@ schedule_action (void *cls)
}
-/**
- * Get statistic from the peer.
- *
- * @param handle identification of the statistics service
- * @param subsystem limit to the specified subsystem, NULL for our subsystem
- * @param name name of the statistic value, NULL for all values
- * @param cont continuation to call when done (can be NULL)
- * This callback CANNOT destroy the statistics handle in the same call.
- * @param proc function to call on each value
- * @param cls closure for @a cont and @a proc
- * @return NULL on error
- */
struct GNUNET_STATISTICS_GetHandle *
GNUNET_STATISTICS_get (struct GNUNET_STATISTICS_Handle *handle,
const char *subsystem,
@@ -1114,12 +1102,6 @@ GNUNET_STATISTICS_get (struct GNUNET_STATISTICS_Handle
*handle,
}
-/**
- * Cancel a 'get' request. Must be called before the 'cont'
- * function is called.
- *
- * @param gh handle of the request to cancel
- */
void
GNUNET_STATISTICS_get_cancel (struct GNUNET_STATISTICS_GetHandle *gh)
{
@@ -1321,15 +1303,6 @@ add_setter_action (struct GNUNET_STATISTICS_Handle *h,
}
-/**
- * Set statistic value for the peer. Will always use our
- * subsystem (the argument used when "handle" was created).
- *
- * @param handle identification of the statistics service
- * @param name name of the statistic value
- * @param value new value to set
- * @param make_persistent should the value be kept across restarts?
- */
void
GNUNET_STATISTICS_set (struct GNUNET_STATISTICS_Handle *handle,
const char *name,
@@ -1347,15 +1320,6 @@ GNUNET_STATISTICS_set (struct GNUNET_STATISTICS_Handle
*handle,
}
-/**
- * Set statistic value for the peer. Will always use our
- * subsystem (the argument used when "handle" was created).
- *
- * @param handle identification of the statistics service
- * @param name name of the statistic value
- * @param delta change in value (added to existing value)
- * @param make_persistent should the value be kept across restarts?
- */
void
GNUNET_STATISTICS_update (struct GNUNET_STATISTICS_Handle *handle,
const char *name,
diff --git a/src/statistics/test_gnunet_statistics.py.in
b/src/statistics/test_gnunet_statistics.py.in
index ce277b13e..ad7e95bd1 100644
--- a/src/statistics/test_gnunet_statistics.py.in
+++ b/src/statistics/test_gnunet_statistics.py.in
@@ -7,6 +7,7 @@ import re
import subprocess
import time
+raw_tmp = True
if os.name == "nt":
tmp = os.getenv("TEMP")
elif None != os.environ.get("TMPDIR"):
@@ -14,7 +15,9 @@ elif None != os.environ.get("TMPDIR"):
elif None != os.environ.get("TMP"):
tmp = os.getenv("TMP")
else:
- tmp = "/tmp"
+ raw_tmp = False
+ tmp = subprocess.check_output("gnunet-config -f -s PATHS -o GNUNET_TMP",
+ text=True)
if os.name == 'nt':
st = './gnunet-statistics.exe'
@@ -30,8 +33,14 @@ if debug:
run_arm += [debug.split(' ')]
+if raw_tmp:
+ cleanup_path = "gnunet/test-gnunet-statistics"
+else:
+ cleanup_path = "test-gnunet-statistics"
+
+
def cleanup():
- shutil.rmtree(os.path.join(tmp, "gnunet/test-gnunet-statistics"), True)
+ shutil.rmtree(os.path.join(tmp, cleanup_path), True)
def sub_run(args, want_stdo=True, want_stde=False, nofail=False):
diff --git a/src/testbed-logger/testbed_logger_api.c
b/src/testbed-logger/testbed_logger_api.c
index 1d6074d13..d67bdba8b 100644
--- a/src/testbed-logger/testbed_logger_api.c
+++ b/src/testbed-logger/testbed_logger_api.c
@@ -297,13 +297,6 @@ GNUNET_TESTBED_LOGGER_write (struct
GNUNET_TESTBED_LOGGER_Handle *h,
}
-/**
- * Flush the buffered data to the logger service
- *
- * @param h the logger handle
- * @param cb the callback to call after the data is flushed
- * @param cb_cls the closure for the above callback
- */
void
GNUNET_TESTBED_LOGGER_flush (struct GNUNET_TESTBED_LOGGER_Handle *h,
GNUNET_TESTBED_LOGGER_FlushCompletion cb,
diff --git a/src/testbed/gnunet-service-testbed.c
b/src/testbed/gnunet-service-testbed.c
index 3ef99ae25..b2f04d5d8 100644
--- a/src/testbed/gnunet-service-testbed.c
+++ b/src/testbed/gnunet-service-testbed.c
@@ -295,11 +295,6 @@ GST_forwarded_operation_reply_relay (void *cls,
}
-/**
- * Task to free resources when forwarded operation has been timed out
- *
- * @param cls the ForwardedOperationContext
- */
void
GST_forwarded_operation_timeout (void *cls)
{
@@ -384,7 +379,7 @@ parse_shared_services (char *ss_str,
* Check #GNUNET_MESSAGE_TYPE_TESTBED_INIT messages
*
* @param cls identification of the client
- * @param message the actual message
+ * @param msg the actual message
* @return #GNUNET_OK if @a message is well-formed
*/
static int
@@ -409,7 +404,7 @@ check_init (void *cls,
* Message handler for #GNUNET_MESSAGE_TYPE_TESTBED_INIT messages
*
* @param cls identification of the client
- * @param message the actual message
+ * @param msg the actual message
*/
static void
handle_init (void *cls,
diff --git a/src/testbed/gnunet-service-testbed.h
b/src/testbed/gnunet-service-testbed.h
index 1c6aadb59..67dfbf253 100644
--- a/src/testbed/gnunet-service-testbed.h
+++ b/src/testbed/gnunet-service-testbed.h
@@ -570,10 +570,9 @@ GST_forwarded_operation_reply_relay (void *cls,
/**
- * Task to free resources when forwarded operation has been timedout
+ * Task to free resources when forwarded operation has been timed out.
*
* @param cls the ForwardedOperationContext
- * @param tc the task context from scheduler
*/
void
GST_forwarded_operation_timeout (void *cls);
@@ -669,7 +668,7 @@ check_peer_create (void *cls,
* Handler for #GNUNET_MESSAGE_TYPE_TESTBED_CREATEPEER messages
*
* @param cls identification of the client
- * @param message the actual message
+ * @param msg the actual message
*/
void
handle_peer_create (void *cls,
@@ -688,7 +687,7 @@ handle_peer_destroy (void *cls,
/**
- * Message handler for #GNUNET_MESSAGE_TYPE_TESTBED_DESTROYPEER messages
+ * Message handler for #GNUNET_MESSAGE_TYPE_TESTBED_START_PEER messages
*
* @param cls identification of the client
* @param msg the actual message
@@ -702,7 +701,7 @@ handle_peer_start (void *cls,
* Message handler for #GNUNET_MESSAGE_TYPE_TESTBED_DESTROYPEER messages
*
* @param cls identification of the client
- * @param message the actual message
+ * @param msg the actual message
*/
void
handle_peer_stop (void *cls,
@@ -746,7 +745,7 @@ check_manage_peer_service (void *cls,
/**
- * Handler for #GNUNET_MESSAGE_TYPE_TESTBED_MANAGE_PEER_SERVICE message
+ * Handler for #GNUNET_MESSAGE_TYPE_TESTBED_MANAGE_PEER_SERVICE messages
*
* @param cls identification of client
* @param msg the actual message
diff --git a/src/testbed/gnunet-service-testbed_barriers.c
b/src/testbed/gnunet-service-testbed_barriers.c
index be33bd131..bc6148087 100644
--- a/src/testbed/gnunet-service-testbed_barriers.c
+++ b/src/testbed/gnunet-service-testbed_barriers.c
@@ -328,7 +328,7 @@ send_barrier_status_msg (struct Barrier *barrier,
* Check #GNUNET_MESSAGE_TYPE_TESTBED_BARRIER_WAIT messages.
*
* @param cls identification of the client
- * @param message the actual message
+ * @param msg the actual message
*/
static int
check_barrier_wait (void *cls,
@@ -347,7 +347,7 @@ check_barrier_wait (void *cls,
* either from the testbed driver or from a high level controller
*
* @param cls identification of the client
- * @param message the actual message
+ * @param msg the actual message
*/
static void
handle_barrier_wait (void *cls,
diff --git a/src/testbed/gnunet-service-testbed_peers.c
b/src/testbed/gnunet-service-testbed_peers.c
index 0bfeb4583..154a6d4ec 100644
--- a/src/testbed/gnunet-service-testbed_peers.c
+++ b/src/testbed/gnunet-service-testbed_peers.c
@@ -428,12 +428,6 @@ check_peer_create (void *cls,
}
-/**
- * Handler for #GNUNET_MESSAGE_TYPE_TESTBED_CREATEPEER messages
- *
- * @param cls identification of the client
- * @param msg the actual message
- */
void
handle_peer_create (void *cls,
const struct GNUNET_TESTBED_PeerCreateMessage *msg)
@@ -644,12 +638,6 @@ start_peer (struct Peer *peer)
}
-/**
- * Message handler for #GNUNET_MESSAGE_TYPE_TESTBED_START_PEER messages
- *
- * @param cls identification of the client
- * @param msg the actual message
- */
void
handle_peer_start (void *cls,
const struct GNUNET_TESTBED_PeerStartMessage *msg)
@@ -1301,12 +1289,6 @@ check_manage_peer_service (void *cls,
}
-/**
- * Handler for #GNUNET_MESSAGE_TYPE_TESTBED_MANAGE_PEER_SERVICE messages
- *
- * @param cls identification of client
- * @param msg the actual message
- */
void
handle_manage_peer_service (void *cls,
const struct
diff --git a/src/testbed/testbed_api.c b/src/testbed/testbed_api.c
index 18bb0c3f6..2ae0a1703 100644
--- a/src/testbed/testbed_api.c
+++ b/src/testbed/testbed_api.c
@@ -407,7 +407,7 @@ handle_add_host_confirm (void *cls,
/**
* Handler for forwarded operations
*
- * @param c the controller handle
+ * @param cls the controller handle
* @param opc the operation context
* @param msg the message
*/
@@ -432,7 +432,7 @@ handle_forwarded_operation_msg (void *cls,
* Handler for #GNUNET_MESSAGE_TYPE_TESTBED_ADD_HOST_SUCCESS message from
* controller (testbed service)
*
- * @param c the controller handler
+ * @param cls the controller handler
* @param msg message received
*/
static void
@@ -536,7 +536,7 @@ handle_opsuccess (
* Handler for #GNUNET_MESSAGE_TYPE_TESTBED_CREATE_PEER_SUCCESS message from
* controller (testbed service)
*
- * @param c the controller handle
+ * @param cls the controller handle
* @param msg message received
*/
static void
@@ -594,7 +594,7 @@ handle_peer_create_success (
* Handler for #GNUNET_MESSAGE_TYPE_TESTBED_PEER_EVENT message from
* controller (testbed service)
*
- * @param c the controller handler
+ * @param cls the controller handler
* @param msg message received
*/
static void
@@ -675,7 +675,7 @@ handle_peer_event (void *cls, const struct
GNUNET_TESTBED_PeerEventMessage *msg)
* Handler for #GNUNET_MESSAGE_TYPE_TESTBED_PEER_CONNECT_EVENT message from
* controller (testbed service)
*
- * @param c the controller handler
+ * @param cls the controller handler
* @param msg message received
*/
static void
@@ -751,7 +751,7 @@ handle_peer_conevent (void *cls,
* Validate #GNUNET_MESSAGE_TYPE_TESTBED_PEER_INFORMATION message from
* controller (testbed service)
*
- * @param c the controller handler
+ * @param cls the controller handler
* @param msg message received
*/
static int
@@ -768,7 +768,7 @@ check_peer_config (
* Handler for #GNUNET_MESSAGE_TYPE_TESTBED_PEER_INFORMATION message from
* controller (testbed service)
*
- * @param c the controller handler
+ * @param cls the controller handler
* @param msg message received
*/
static void
@@ -840,7 +840,7 @@ handle_peer_config (
* Validate #GNUNET_MESSAGE_TYPE_TESTBED_OPERATION_FAIL_EVENT message from
* controller (testbed service)
*
- * @param c the controller handler
+ * @param cls the controller handler
* @param msg message received
* @return #GNUNET_OK if message is well-formed
*/
@@ -858,7 +858,7 @@ check_op_fail_event (
* Handler for #GNUNET_MESSAGE_TYPE_TESTBED_OPERATION_FAIL_EVENT message from
* controller (testbed service)
*
- * @param c the controller handler
+ * @param cls the controller handler
* @param msg message received
*/
static void
@@ -1037,7 +1037,7 @@ check_slave_config (void *cls,
* Handler for #GNUNET_MESSAGE_TYPE_TESTBED_SLAVE_CONFIGURATION message from
controller
* (testbed service)
*
- * @param c the controller handler
+ * @param cls the controller handler
* @param msg message received
*/
static void
@@ -1099,7 +1099,7 @@ check_link_controllers_result (
* Handler for #GNUNET_MESSAGE_TYPE_TESTBED_LINK_CONTROLLERS_RESULT message
from controller
* (testbed service)
*
- * @param c the controller handler
+ * @param cls the controller handler
* @param msg message received
*/
static void
@@ -1917,21 +1917,6 @@ GNUNET_TESTBED_get_slave_config_ (void *op_cls,
}
-/**
- * Function to acquire the configuration of a running slave controller. The
- * completion of the operation is signalled through the controller_cb from
- * GNUNET_TESTBED_controller_connect(). If the operation is successful the
- * handle to the configuration is available in the generic pointer of
- * operation_finished field of struct GNUNET_TESTBED_EventInformation.
- *
- * @param op_cls the closure for the operation
- * @param master the handle to master controller
- * @param slave_host the host where the slave controller is running; the handle
- * to the slave_host should remain valid until this operation is
- * cancelled or marked as finished
- * @return the operation handle; NULL if the slave_host is not registered at
- * master
- */
struct GNUNET_TESTBED_Operation *
GNUNET_TESTBED_get_slave_config (void *op_cls,
struct GNUNET_TESTBED_Controller *master,
@@ -1946,15 +1931,6 @@ GNUNET_TESTBED_get_slave_config (void *op_cls,
}
-/**
- * Ask the testbed controller to write the current overlay topology to
- * a file. Naturally, the file will only contain a snapshot as the
- * topology may evolve all the time.
- *
- * @param controller overlay controller to inspect
- * @param filename name of the file the topology should
- * be written to.
- */
void
GNUNET_TESTBED_overlay_write_topology_to_file (
struct GNUNET_TESTBED_Controller *controller,
@@ -2170,13 +2146,6 @@ GNUNET_TESTBED_extract_config_ (const struct
GNUNET_MessageHeader *msg)
}
-/**
- * Checks the integrity of the OperationFailureEventMessage and if good returns
- * the error message it contains.
- *
- * @param msg the OperationFailureEventMessage
- * @return the error message
- */
const char *
GNUNET_TESTBED_parse_error_string_ (
const struct GNUNET_TESTBED_OperationFailureEventMessage *msg)
@@ -2351,22 +2320,6 @@ GNUNET_TESTBED_barrier_remove_ (struct
GNUNET_TESTBED_Barrier *barrier)
}
-/**
- * Initialise a barrier and call the given callback when the required
percentage
- * of peers (quorum) reach the barrier OR upon error.
- *
- * @param controller the handle to the controller
- * @param name identification name of the barrier
- * @param quorum the percentage of peers that is required to reach the barrier.
- * Peers signal reaching a barrier by calling
- * GNUNET_TESTBED_barrier_reached().
- * @param cb the callback to call when the barrier is reached or upon error.
- * Cannot be NULL.
- * @param cls closure for the above callback
- * @param echo GNUNET_YES to echo the barrier crossed status message back to
the
- * controller
- * @return barrier handle; NULL upon error
- */
struct GNUNET_TESTBED_Barrier *
GNUNET_TESTBED_barrier_init_ (struct GNUNET_TESTBED_Controller *controller,
const char *name,
@@ -2431,7 +2384,7 @@ GNUNET_TESTBED_barrier_init_ (struct
GNUNET_TESTBED_Controller *controller,
* GNUNET_TESTBED_barrier_reached().
* @param cb the callback to call when the barrier is reached or upon error.
* Cannot be NULL.
- * @param cls closure for the above callback
+ * @param cb_cls closure for the above callback
* @return barrier handle; NULL upon error
*/
struct GNUNET_TESTBED_Barrier *
@@ -2439,13 +2392,13 @@ GNUNET_TESTBED_barrier_init (struct
GNUNET_TESTBED_Controller *controller,
const char *name,
unsigned int quorum,
GNUNET_TESTBED_barrier_status_cb cb,
- void *cls)
+ void *cb_cls)
{
return GNUNET_TESTBED_barrier_init_ (controller,
name,
quorum,
cb,
- cls,
+ cb_cls,
GNUNET_YES);
}
diff --git a/src/testbed/testbed_api_barriers.c
b/src/testbed/testbed_api_barriers.c
index 61578c1e6..6074beb12 100644
--- a/src/testbed/testbed_api_barriers.c
+++ b/src/testbed/testbed_api_barriers.c
@@ -160,17 +160,6 @@ mq_error_handler (void *cls,
}
-/**
- * Wait for a barrier to be crossed. This function should be called by the
- * peers which have been started by the testbed. If the peer is not started by
- * testbed this function may return error
- *
- * @param name the name of the barrier
- * @param cb the barrier wait callback
- * @param cb_cls the closure for @a cb
- * @return barrier wait handle which can be used to cancel the waiting at
- * anytime before the callback is called. NULL upon error.
- */
struct GNUNET_TESTBED_BarrierWaitHandle *
GNUNET_TESTBED_barrier_wait (const char *name,
GNUNET_TESTBED_barrier_wait_cb cb,
diff --git a/src/testbed/testbed_api_hosts.c b/src/testbed/testbed_api_hosts.c
index 8dd0a4893..824bd0187 100644
--- a/src/testbed/testbed_api_hosts.c
+++ b/src/testbed/testbed_api_hosts.c
@@ -215,13 +215,6 @@ GNUNET_TESTBED_host_create_by_id_ (
}
-/**
- * Obtain the host's unique global ID.
- *
- * @param host handle to the host, NULL means 'localhost'
- * @return id global host ID assigned to the host (0 is
- * 'localhost', but then obviously not globally unique)
- */
uint32_t
GNUNET_TESTBED_host_get_id_ (const struct GNUNET_TESTBED_Host *host)
{
@@ -393,17 +386,6 @@ GNUNET_TESTBED_host_create (const char *hostname,
}
-/**
- * Load a set of hosts from a configuration file.
- *
- * @param filename file with the host specification
- * @param cfg the configuration to use as a template while starting a
controller
- * on any of the loaded hosts. Operation queue sizes specific to a
host
- * are also read from this configuration handle
- * @param hosts set to the hosts found in the file; caller must free this if
- * number of hosts returned is greater than 0
- * @return number of hosts returned in 'hosts', 0 on error
- */
unsigned int
GNUNET_TESTBED_hosts_load_from_file (
const char *filename,
@@ -936,7 +918,6 @@ gen_rsh_suffix_args (const char *const *append_args)
* Do not call GNUNET_SERVER_mst_destroy in callback
*
* @param cls closure
- * @param client identification of the client
* @param message the actual message
*
* @return #GNUNET_OK on success, #GNUNET_SYSERR to stop further processing
diff --git a/src/testbed/testbed_api_operations.c
b/src/testbed/testbed_api_operations.c
index a23f8c666..ea7e71496 100644
--- a/src/testbed/testbed_api_operations.c
+++ b/src/testbed/testbed_api_operations.c
@@ -1039,14 +1039,6 @@ GNUNET_TESTBED_operation_create_ (void *cls,
OperationStart start,
}
-/**
- * Create an operation queue.
- *
- * @param type the type of operation queue
- * @param max_active maximum number of operations in this
- * queue that can be active in parallel at the same time
- * @return handle to the queue
- */
struct OperationQueue *
GNUNET_TESTBED_operation_queue_create_ (enum OperationQueueType type,
unsigned int max_active)
diff --git a/src/testbed/testbed_api_operations.h
b/src/testbed/testbed_api_operations.h
index d9de5c011..2dba9c14d 100644
--- a/src/testbed/testbed_api_operations.h
+++ b/src/testbed/testbed_api_operations.h
@@ -60,8 +60,8 @@ enum OperationQueueType
* Create an operation queue.
*
* @param type the type of operation queue
- * @param max_active maximum number of operations in this queue that can be
- * active in parallel at the same time.
+ * @param max_active maximum number of operations in this
+ * queue that can be active in parallel at the same time.
* @return handle to the queue
*/
struct OperationQueue *
diff --git a/src/testbed/testbed_api_peers.c b/src/testbed/testbed_api_peers.c
index 99d30e85b..b8e428441 100644
--- a/src/testbed/testbed_api_peers.c
+++ b/src/testbed/testbed_api_peers.c
@@ -661,18 +661,6 @@ GNUNET_TESTBED_peer_start (void *op_cls, struct
GNUNET_TESTBED_Peer *peer,
}
-/**
- * Stop the given peer. The handle remains valid (use
- * "GNUNET_TESTBED_peer_destroy" to fully clean up the
- * state of the peer).
- *
- * @param op_cls the closure for this operation; will be set in the event
- * information
- * @param peer peer to stop
- * @param pcc function to call upon completion
- * @param pcc_cls closure for 'pcc'
- * @return handle to the operation
- */
struct GNUNET_TESTBED_Operation *
GNUNET_TESTBED_peer_stop (void *op_cls,
struct GNUNET_TESTBED_Peer *peer,
@@ -701,20 +689,6 @@ GNUNET_TESTBED_peer_stop (void *op_cls,
}
-/**
- * Request information about a peer. The controller callback will not be called
- * with event type GNUNET_TESTBED_ET_OPERATION_FINISHED when result for this
- * operation is available. Instead, the GNUNET_TESTBED_PeerInfoCallback() will
- * be called.
- * The peer information in the callback is valid until the operation is
canceled.
- *
- * @param peer peer to request information about
- * @param pit desired information
- * @param cb the convenience callback to be called when results for this
- * operation are available
- * @param cb_cls the closure for the above callback
- * @return handle to the operation
- */
struct GNUNET_TESTBED_Operation *
GNUNET_TESTBED_peer_get_information (struct GNUNET_TESTBED_Peer *peer,
enum GNUNET_TESTBED_PeerInformationType
@@ -847,20 +821,6 @@ GNUNET_TESTBED_underlay_configure_link (void *op_cls,
}
-/**
- * Both peers must have been started before calling this function.
- * This function then obtains a HELLO from 'p1', gives it to 'p2'
- * and asks 'p2' to connect to 'p1'.
- *
- * @param op_cls closure argument to give with the operation event
- * @param cb the callback to call when this operation has finished
- * @param cb_cls the closure for the above callback
- * @param p1 first peer
- * @param p2 second peer
- * @return handle to the operation, NULL if connecting these two
- * peers is fundamentally not possible at this time (peers
- * not running or underlay disallows)
- */
struct GNUNET_TESTBED_Operation *
GNUNET_TESTBED_overlay_connect (void *op_cls,
GNUNET_TESTBED_OperationCompletionCallback cb,
@@ -957,21 +917,6 @@ oprelease_manage_service (void *cls)
}
-/**
- * Start or stop given service at a peer. This should not be called to
- * start/stop the peer's ARM service. Use GNUNET_TESTBED_peer_start(),
- * GNUNET_TESTBED_peer_stop() for starting/stopping peer's ARM service.
Success
- * or failure of the generated operation is signalled through the controller
- * event callback and/or operation completion callback.
- *
- * @param op_cls the closure for the operation
- * @param peer the peer whose service is to be started/stopped
- * @param service_name the name of the service
- * @param cb the operation completion callback
- * @param cb_cls the closure for the operation completion callback
- * @param start 1 to start the service; 0 to stop the service
- * @return an operation handle; NULL upon error (peer not running)
- */
struct GNUNET_TESTBED_Operation *
GNUNET_TESTBED_peer_manage_service (void *op_cls,
struct GNUNET_TESTBED_Peer *peer,
diff --git a/src/testbed/testbed_api_testbed.c
b/src/testbed/testbed_api_testbed.c
index e0b76ad78..8e75daae3 100644
--- a/src/testbed/testbed_api_testbed.c
+++ b/src/testbed/testbed_api_testbed.c
@@ -1005,11 +1005,6 @@ host_registration_completion (void *cls, const char
*emsg)
}
-/**
- * Task to register all hosts available in the global host list
- *
- * @param cls RunContext
- */
static void
register_hosts (void *cls)
{
diff --git a/src/testbed/testbed_api_topology.c
b/src/testbed/testbed_api_topology.c
index e68e449ad..f73be378e 100644
--- a/src/testbed/testbed_api_topology.c
+++ b/src/testbed/testbed_api_topology.c
@@ -637,18 +637,6 @@ gen_topo_ring (struct TopologyContext *tc)
}
-/**
- * Returns the number of links that are required to generate a 2d torus for the
- * given number of peers. Also returns the arrangement (number of rows and the
- * length of each row)
- *
- * @param num_peers number of peers
- * @param rows number of rows in the 2d torus. Can be NULL
- * @param rows_len the length of each row. This array will be allocated
- * fresh. The caller should free it. Can be NULL
- * @return the number of links that are required to generate a 2d torus for the
- * given number of peers
- */
unsigned int
GNUNET_TESTBED_2dtorus_calc_links (unsigned int num_peers, unsigned int *rows,
unsigned int **rows_len)
@@ -1250,17 +1238,6 @@ gen_topo_clique (struct TopologyContext *tc)
}
-/**
- * Configure overall network topology to have a particular shape.
- *
- * @param op_cls closure argument to give with the operation event
- * @param num_peers number of peers in @a peers
- * @param peers array of @a num_peers with the peers to configure
- * @param topo desired underlay topology to use
- * @param ap topology-specific options
- * @return handle to the operation, NULL if configuring the topology
- * is not allowed at this time
- */
struct GNUNET_TESTBED_Operation *
GNUNET_TESTBED_underlay_configure_topology_va (void *op_cls,
unsigned int num_peers,
@@ -1275,17 +1252,6 @@ GNUNET_TESTBED_underlay_configure_topology_va (void
*op_cls,
}
-/**
- * Configure overall network topology to have a particular shape.
- *
- * @param op_cls closure argument to give with the operation event
- * @param num_peers number of peers in @a peers
- * @param peers array of @a num_peers with the peers to configure
- * @param topo desired underlay topology to use
- * @param ... topology-specific options
- * @return handle to the operation, NULL if configuring the topology
- * is not allowed at this time
- */
struct GNUNET_TESTBED_Operation *
GNUNET_TESTBED_underlay_configure_topology (void *op_cls,
unsigned int num_peers,
@@ -1298,26 +1264,6 @@ GNUNET_TESTBED_underlay_configure_topology (void *op_cls,
}
-/**
- * All peers must have been started before calling this function.
- * This function then connects the given peers in the P2P overlay
- * using the given topology.
- *
- * @param op_cls closure argument to give with the peer connect operation
events
- * generated through this function
- * @param num_peers number of peers in @a peers
- * @param peers array of @a num_peers with the peers to configure
- * @param max_connections the maximums number of overlay connections that will
- * be made to achieve the given topology
- * @param comp_cb the completion callback to call when the topology generation
- * is completed
- * @param comp_cb_cls closure for the above completion callback
- * @param topo desired underlay topology to use
- * @param va topology-specific options
- * @return handle to the operation, NULL if connecting these
- * peers is fundamentally not possible at this time (peers
- * not running or underlay disallows) or if num_peers is less than 2
- */
struct GNUNET_TESTBED_Operation *
GNUNET_TESTBED_overlay_configure_topology_va (void *op_cls,
unsigned int num_peers,
@@ -1496,15 +1442,6 @@ GNUNET_TESTBED_overlay_configure_topology (void *op_cls,
}
-/**
- * Get a topology from a string input.
- *
- * @param topology where to write the retrieved topology
- * @param topology_string The string to attempt to
- * get a configuration value from
- * @return #GNUNET_YES if topology string matched a
- * known topology, #GNUNET_NO if not
- */
int
GNUNET_TESTBED_topology_get_ (enum GNUNET_TESTBED_TopologyOption *topology,
const char *topology_string)
diff --git a/src/testbed/testbed_api_topology.h
b/src/testbed/testbed_api_topology.h
index 564fa421f..ffa32dfa5 100644
--- a/src/testbed/testbed_api_topology.h
+++ b/src/testbed/testbed_api_topology.h
@@ -36,6 +36,8 @@
* @param rows number of rows in the 2d torus. Can be NULL.
* @param rows_len the length of each row. This array will be allocated
* fresh. The caller should free it. Can be NULL.
+ * @return the number of links that are required to generate a 2d torus for the
+ * given number of peers
*/
unsigned int
GNUNET_TESTBED_2dtorus_calc_links (unsigned int num_peers, unsigned int *rows,
@@ -48,8 +50,8 @@ GNUNET_TESTBED_2dtorus_calc_links (unsigned int num_peers,
unsigned int *rows,
* @param topology where to write the retrieved topology
* @param topology_string The string to attempt to
* get a configuration value from
- * @return GNUNET_YES if topology string matched a
- * known topology, GNUNET_NO if not
+ * @return #GNUNET_YES if topology string matched a
+ * known topology, #GNUNET_NO if not
*/
int
GNUNET_TESTBED_topology_get_ (enum GNUNET_TESTBED_TopologyOption *topology,
diff --git a/src/testing/testing.c b/src/testing/testing.c
index 95651830f..22375bc98 100644
--- a/src/testing/testing.c
+++ b/src/testing/testing.c
@@ -1503,17 +1503,6 @@ disconn_status (void *cls, int connected)
}
-/**
- * Stop a peer asynchronously using ARM API. Peer's shutdown is signaled
- * through the GNUNET_TESTING_PeerStopCallback().
- *
- * @param peer the peer to stop
- * @param cb the callback to signal peer shutdown
- * @param cb_cls closure for the above callback
- * @return #GNUNET_OK upon successfully giving the request to the ARM API (this
- * does not mean that the peer is successfully stopped);
#GNUNET_SYSERR
- * upon any error.
- */
int
GNUNET_TESTING_peer_stop_async (struct GNUNET_TESTING_Peer *peer,
GNUNET_TESTING_PeerStopCallback cb,
@@ -1581,22 +1570,6 @@ GNUNET_TESTING_peer_destroy (struct GNUNET_TESTING_Peer
*peer)
}
-/**
- * Start a single peer and run a test using the testing library.
- * Starts a peer using the given configuration and then invokes the
- * given callback. This function ALSO initializes the scheduler loop
- * and should thus be called directly from "main". The testcase
- * should self-terminate by invoking #GNUNET_SCHEDULER_shutdown().
- *
- * @param testdir only the directory name without any path. This is used for
- * all service homes; the directory will be created in a temporary
- * location depending on the underlying OS
- * @param cfgfilename name of the configuration file to use;
- * use NULL to only run with defaults
- * @param tm main function of the testcase
- * @param tm_cls closure for @a tm
- * @return 0 on success, 1 on error
- */
int
GNUNET_TESTING_peer_run (const char *testdir,
const char *cfgfilename,
@@ -1648,27 +1621,6 @@ service_run_main (void *cls)
}
-/**
- * Start a single service (no ARM, except of course if the given
- * service name is 'arm') and run a test using the testing library.
- * Starts a service using the given configuration and then invokes the
- * given callback. This function ALSO initializes the scheduler loop
- * and should thus be called directly from "main". The testcase
- * should self-terminate by invoking #GNUNET_SCHEDULER_shutdown().
- *
- * This function is useful if the testcase is for a single service
- * and if that service doesn't itself depend on other services.
- *
- * @param testdir only the directory name without any path. This is used for
- * all service homes; the directory will be created in a temporary
- * location depending on the underlying OS
- * @param service_name name of the service to run
- * @param cfgfilename name of the configuration file to use;
- * use NULL to only run with defaults
- * @param tm main function of the testcase
- * @param tm_cls closure for @a tm
- * @return 0 on success, 1 on error
- */
int
GNUNET_TESTING_service_run (const char *testdir,
const char *service_name,
@@ -2208,13 +2160,6 @@ GNUNET_TESTING_get_connections (unsigned int num,
}
-/**
- * Retrieve the public key from the test system with the unique node id.
- *
- * @param num The unique node id.
- * @param tl_system The test system.
- * @return The peer identity wrapping the public key.
- */
struct GNUNET_PeerIdentity *
GNUNET_TESTING_get_pub_key (unsigned int num,
const struct GNUNET_TESTING_System *tl_system)
@@ -2418,11 +2363,6 @@ GNUNET_TESTING_get_additional_connects (unsigned int num,
}
-/**
- * Create a GNUNET_CMDS_LOCAL_FINISHED message.
- *
- * @return The GNUNET_CMDS_LOCAL_FINISHED message.
-*/
struct GNUNET_MessageHeader *
GNUNET_TESTING_send_local_test_finished_msg ()
{
diff --git a/src/testing/testing_api_cmd_local_test_prepared.c
b/src/testing/testing_api_cmd_local_test_prepared.c
index 1f470a6c1..e71d3ef45 100644
--- a/src/testing/testing_api_cmd_local_test_prepared.c
+++ b/src/testing/testing_api_cmd_local_test_prepared.c
@@ -92,14 +92,6 @@ local_test_prepared_run (void *cls,
}
-/**
- * Create command.
- *
- * @param label name for command.
- * @param write_message Callback to write messages to the master loop.
- * @param all_local_tests_prepared Flag which will be set from outside.
- * @return command.
- */
struct GNUNET_TESTING_Command
GNUNET_TESTING_cmd_local_test_prepared (const char *label,
TESTING_CMD_HELPER_write_cb
diff --git a/src/testing/testing_api_loop.c b/src/testing/testing_api_loop.c
index 283284f26..90713e45e 100644
--- a/src/testing/testing_api_loop.c
+++ b/src/testing/testing_api_loop.c
@@ -429,12 +429,6 @@ do_timeout (void *cls)
}
-/**
- * Check if the command is running.
- *
- * @param cmd The command to check.
- * @return GNUNET_NO if the command is not running, GNUNET_YES if it is
running.
- */
enum GNUNET_GenericReturnValue
GNUNET_TESTING_running (const struct GNUNET_TESTING_Command *command)
{
@@ -443,12 +437,6 @@ GNUNET_TESTING_running (const struct
GNUNET_TESTING_Command *command)
}
-/**
- * Check if a command is finished.
- *
- * @param cmd The command to check.
- * @return GNUNET_NO if the command is not finished, GNUNET_YES if it is
finished.
- */
enum GNUNET_GenericReturnValue
GNUNET_TESTING_finished (struct GNUNET_TESTING_Command *command)
{
diff --git a/src/transport/gnunet-communicator-tcp.c
b/src/transport/gnunet-communicator-tcp.c
index 2a5290bf9..4820caf70 100644
--- a/src/transport/gnunet-communicator-tcp.c
+++ b/src/transport/gnunet-communicator-tcp.c
@@ -981,7 +981,7 @@ queue_destroy (struct Queue *queue)
* @param[in,out] hmac_secret secret for HMAC calculation
* @param buf buffer to MAC
* @param buf_size number of bytes in @a buf
- * @param smac[out] where to write the HMAC
+ * @param[out] smac where to write the HMAC
*/
static void
calculate_hmac (struct GNUNET_HashCode *hmac_secret,
@@ -1155,8 +1155,8 @@ pass_plaintext_to_core (struct Queue *queue,
*
* @param dh shared secret
* @param pid decrypting peer's identity
- * @param cipher[out] cipher to initialize
- * @param hmac_key[out] HMAC key to initialize
+ * @param[out] cipher cipher to initialize
+ * @param[out] hmac_key HMAC key to initialize
*/
static void
setup_cipher (const struct GNUNET_HashCode *dh,
@@ -1287,7 +1287,7 @@ rekey_monotime_cb (void *cls,
* Setup cipher of @a queue for decryption.
*
* @param ephemeral ephemeral key we received from the other peer
- * @param queue[in,out] queue to initialize decryption cipher for
+ * @param[in,out] queue queue to initialize decryption cipher for
*/
static void
setup_in_cipher (const struct GNUNET_CRYPTO_EcdhePublicKey *ephemeral,
@@ -1448,8 +1448,8 @@ handshake_ack_monotime_cb (void *cls,
* @param queue The queue context.
*/
static void
-send_challenge (struct GNUNET_CRYPTO_ChallengeNonceP challenge, struct
- Queue *queue)
+send_challenge (struct GNUNET_CRYPTO_ChallengeNonceP challenge,
+ struct Queue *queue)
{
struct TCPConfirmationAck tca;
struct TcpHandshakeAckSignature thas;
@@ -2613,7 +2613,7 @@ handshake_monotime_cb (void *cls,
* Note that #setup_in_cipher() must have already been called.
*
* @param queue queue to decrypt initial bytes from other peer for
- * @param tc[out] where to store the result
+ * @param[out] tc where to store the result
* @param ibuf incoming data, of size
* `INITIAL_KX_SIZE`
* @return #GNUNET_OK if the signature was OK, #GNUNET_SYSERR if not
@@ -3179,7 +3179,7 @@ enc_notify_cb (void *cls,
* a function to call whenever our set of 'valid' addresses changes.
*
* @param cls closure
- * @param app_ctx[in,out] location where the app can store stuff
+ * @param[in,out] app_ctx location where the app can store stuff
* on add and retrieve it on remove
* @param add_remove #GNUNET_YES to add a new public IP address,
* #GNUNET_NO to remove a previous (now invalid) one
diff --git a/src/transport/gnunet-communicator-udp.c
b/src/transport/gnunet-communicator-udp.c
index 07beeac38..2748a6594 100644
--- a/src/transport/gnunet-communicator-udp.c
+++ b/src/transport/gnunet-communicator-udp.c
@@ -998,7 +998,7 @@ kce_destroy (struct KeyCacheEntry *kce)
*
* @param msec master secret for HMAC calculation
* @param serial number for the @a smac calculation
- * @param kid[out] where to write the key ID
+ * @param[out] kid where to write the key ID
*/
static void
get_kid (const struct GNUNET_HashCode *msec,
@@ -1130,8 +1130,8 @@ sender_destroy (struct SenderAddress *sender)
*
* @param msec master secret for calculation
* @param serial number for the @a smac calculation
- * @param key[out] where to write the decryption key
- * @param iv[out] where to write the IV
+ * @param[out] key where to write the decryption key
+ * @param[out] iv where to write the IV
*/
static void
get_iv_key (const struct GNUNET_HashCode *msec,
@@ -1237,7 +1237,7 @@ check_timeouts (void *cls)
/**
* Calculate cmac from master in @a ss.
*
- * @param ss[in,out] data structure to complete
+ * @param[in,out] ss data structure to complete
*/
static void
calculate_cmac (struct SharedSecret *ss)
@@ -1397,7 +1397,7 @@ setup_shared_secret_dec (const struct
GNUNET_CRYPTO_EcdhePublicKey *ephemeral)
* Setup shared secret for encryption.
*
* @param ephemeral ephemeral key we are sending to the other peer
- * @param receiver[in,out] queue to initialize encryption key for
+ * @param[in,out] receiver queue to initialize encryption key for
* @return new shared secret
*/
static struct SharedSecret *
@@ -2198,7 +2198,7 @@ setup_sender (const struct GNUNET_PeerIdentity *target,
/**
* Check signature from @a uc against @a ephemeral.
*
- * @param ephermal key that is signed
+ * @param ephemeral key that is signed
* @param uc signature of claimant
* @return #GNUNET_OK if signature is valid
*/
diff --git a/src/transport/gnunet-service-tng.c
b/src/transport/gnunet-service-tng.c
index ae4d65bcf..5976bd5b1 100644
--- a/src/transport/gnunet-service-tng.c
+++ b/src/transport/gnunet-service-tng.c
@@ -3296,7 +3296,7 @@ struct MonitorEvent
/**
- * Free a @dvh. Callers MAY want to check if this was the last path to the
+ * Free a @a dvh. Callers MAY want to check if this was the last path to the
* `target`, and if so call #free_dv_route to also free the associated DV
* entry in #dv_routes (if not, the associated scheduler job should eventually
* take care of it).
@@ -4136,7 +4136,7 @@ client_send_response (struct PendingMessage *pm)
*
* @param dv data structure to pick paths from
* @param options constraints to satisfy
- * @param hops_array[out] set to the result
+ * @param[out] hops_array set to the result
* @param hops_array_length length of the @a hops_array
* @return number of entries set in @a hops_array
*/
@@ -4404,7 +4404,7 @@ check_communicator_backchannel (
* Ensure ephemeral keys in our @a dv are current. If no current one exists,
* set it up.
*
- * @param dv[in,out] virtual link to update ephemeral for
+ * @param[in,out] dv virtual link to update ephemeral for
*/
static void
update_ephemeral (struct DistanceVector *dv)
@@ -4637,7 +4637,7 @@ struct DVKeyState
*
* @param km raw master secret
* @param iv initialization vector
- * @param key[out] symmetric cipher and HMAC state to generate
+ * @param[out] key symmetric cipher and HMAC state to generate
*/
static void
dv_setup_key_state_from_km (const struct GNUNET_HashCode *km,
@@ -4679,7 +4679,7 @@ dv_setup_key_state_from_km (const struct GNUNET_HashCode
*km,
* @param priv_ephemeral ephemeral private key to use
* @param target the target peer to encrypt to
* @param iv unique IV to use
- * @param key[out] set to the key material
+ * @param[out] key set to the key material
*/
static void
dh_key_derive_eph_pid (
@@ -4704,7 +4704,7 @@ dh_key_derive_eph_pid (
* @param priv_ephemeral ephemeral private key to use
* @param target the target peer to encrypt to
* @param iv unique IV to use
- * @param key[out] set to the key material
+ * @param[out] key set to the key material
*/
static void
dh_key_derive_eph_pub (const struct GNUNET_CRYPTO_EcdhePublicKey
*pub_ephemeral,
@@ -4725,7 +4725,7 @@ dh_key_derive_eph_pub (const struct
GNUNET_CRYPTO_EcdhePublicKey *pub_ephemeral,
* material from @a key.
*
* @param key key material (from DH)
- * @param hmac[out] set to the HMAC
+ * @param[out] hmac set to the HMAC
* @param data data to perform HMAC calculation over
* @param data_size number of bytes in @a data
*/
@@ -4743,7 +4743,7 @@ dv_hmac (const struct DVKeyState *key,
* Perform backchannel encryption using symmetric secret in @a key
* to encrypt data from @a in to @a dst.
*
- * @param key[in,out] key material to use
+ * @param[in,out] key key material to use
* @param dst where to write the result
* @param in input data to encrypt (plaintext)
* @param in_size number of bytes of input in @a in and available at @a dst
@@ -4760,9 +4760,9 @@ dv_encrypt (struct DVKeyState *key, const void *in, void
*dst, size_t in_size)
* Perform backchannel encryption using symmetric secret in @a key
* to encrypt data from @a in to @a dst.
*
- * @param key[in,out] key material to use
+ * @param[in,out] key key material to use
* @param ciph cipher text to decrypt
- * @param out[out] output data to generate (plaintext)
+ * @param[out] out output data to generate (plaintext)
* @param out_size number of bytes of input in @a ciph and available in @a out
*/
static void
@@ -4815,7 +4815,7 @@ typedef void (*DVMessageHandler) (void *cls,
* @param use function to call with the encapsulated message
* @param use_cls closure for @a use
* @param options whether path must be confirmed or not, to be passed to @a use
- * @param shall this TransportDVBoxMessage be forwarded without flow control.
+ * @param without_fc shall this TransportDVBoxMessage be forwarded without
flow control.
* @return expected RTT for transmission, #GNUNET_TIME_UNIT_FOREVER_REL if
sending failed
*/
static struct GNUNET_TIME_Relative
@@ -6274,7 +6274,7 @@ handle_reliability_box (void *cls,
* so, purge ancient statistics (more than GOODPUT_AGING_SLOTS before
* the current age)
*
- * @param pd[in,out] data to update
+ * @param[in,out] pd data to update
* @param age current age
*/
static void
@@ -6300,7 +6300,7 @@ update_pd_age (struct PerformanceData *pd, unsigned int
age)
* Update @a pd based on the latest @a rtt and the number of bytes
* that were confirmed to be successfully transmitted.
*
- * @param pd[in,out] data to update
+ * @param[in,out] pd data to update
* @param rtt latest round-trip time
* @param bytes_transmitted_ok number of bytes receiver confirmed as received
*/
@@ -7817,7 +7817,7 @@ check_dv_box (void *cls, const struct
TransportDVBoxMessage *dvb)
/**
* Create a DV Box message and queue it for transmission to
- * @ea next_hop.
+ * @a next_hop.
*
* @param next_hop peer to receive the message next
* @param total_hops how many hops did the message take so far
@@ -8371,7 +8371,7 @@ handle_dv_box (void *cls, const struct
TransportDVBoxMessage *dvb)
* Client notified us about transmission from a peer. Process the request.
*
* @param cls a `struct TransportClient` which sent us the message
- * @param obm the send message that was sent
+ * @param im the send message that was sent
* @return #GNUNET_YES if message is well-formed
*/
static int
@@ -9597,7 +9597,7 @@ struct PendingMessageScoreContext
* Select the best pending message from @a vl for transmission
* via @a queue.
*
- * @param sc[in,out] best message so far (NULL for none), plus scoring data
+ * @param[in,out] sc best message so far (NULL for none), plus scoring data
* @param queue the queue that will be used for transmission
* @param vl the virtual link providing the messages
* @param dvh path we are currently considering, or NULL for none
diff --git a/src/transport/gnunet-service-transport.c
b/src/transport/gnunet-service-transport.c
index 345a0d949..93790e293 100644
--- a/src/transport/gnunet-service-transport.c
+++ b/src/transport/gnunet-service-transport.c
@@ -2120,7 +2120,7 @@ free_blacklist_entry (void *cls,
* Set traffic metric to manipulate
*
* @param cls closure
- * @param message containing information
+ * @param tm message containing information
*/
static void
handle_client_set_metric (void *cls, const struct TrafficMetricMessage *tm)
@@ -2486,11 +2486,6 @@ GST_blacklist_test_allowed (const struct
GNUNET_PeerIdentity *peer,
}
-/**
- * Cancel a blacklist check.
- *
- * @param bc check to cancel
- */
void
GST_blacklist_test_cancel (struct GST_BlacklistCheck *bc)
{
diff --git a/src/transport/gnunet-service-transport_ats.c
b/src/transport/gnunet-service-transport_ats.c
index 130311e15..2438a0a48 100644
--- a/src/transport/gnunet-service-transport_ats.c
+++ b/src/transport/gnunet-service-transport_ats.c
@@ -477,13 +477,6 @@ GST_ats_add_inbound_address (const struct
GNUNET_HELLO_Address *address,
}
-/**
- * Notify ATS about the new address including the network this address is
- * located in. The address must NOT be inbound and must be new to ATS.
- *
- * @param address the address
- * @param prop performance information
- */
void
GST_ats_add_address (const struct GNUNET_HELLO_Address *address,
const struct GNUNET_ATS_Properties *prop)
@@ -755,13 +748,6 @@ GST_ats_update_distance (const struct GNUNET_HELLO_Address
*address,
}
-/**
- * Notify ATS about @a delay changes to properties of an @a address.
- * Does nothing if the @a address is not known to us.
- *
- * @param address the address
- * @param delay new delay value
- */
void
GST_ats_update_delay (const struct GNUNET_HELLO_Address *address,
struct GNUNET_TIME_Relative delay)
diff --git a/src/transport/gnunet-service-transport_ats.h
b/src/transport/gnunet-service-transport_ats.h
index d536714ec..ca972d1cc 100644
--- a/src/transport/gnunet-service-transport_ats.h
+++ b/src/transport/gnunet-service-transport_ats.h
@@ -110,7 +110,7 @@ GST_ats_add_inbound_address (const struct
GNUNET_HELLO_Address *address,
/**
- * Notify ATS about a new address including the network this address is
+ * Notify ATS about a new address including the network the address is
* located in. The address must NOT be inbound and must be new to ATS.
*
* @param address the address
@@ -154,7 +154,6 @@ GST_ats_update_utilization (const struct
GNUNET_HELLO_Address *address,
* Does nothing if the @a address is not known to us.
*
* @param address the address
- * @param session the session
* @param delay new delay value
*/
void
diff --git a/src/transport/gnunet-service-transport_hello.c
b/src/transport/gnunet-service-transport_hello.c
index 472c77c27..1e5e8a225 100644
--- a/src/transport/gnunet-service-transport_hello.c
+++ b/src/transport/gnunet-service-transport_hello.c
@@ -334,16 +334,6 @@ GST_hello_modify_addresses (int addremove,
}
-/**
- * Test if a particular address is one of ours.
- *
- * @param address address to test
- * @param sig location where to cache PONG signatures for this address [set]
- * @param sig_expiration how long until the current 'sig' expires?
- * (ZERO if sig was never created) [set]
- * @return #GNUNET_YES if this is one of our addresses,
- * #GNUNET_NO if not
- */
int
GST_hello_test_address (const struct GNUNET_HELLO_Address *address,
struct GNUNET_CRYPTO_EddsaSignature **sig,
diff --git a/src/transport/gnunet-service-transport_manipulation.c
b/src/transport/gnunet-service-transport_manipulation.c
index 04d1774c0..9f39b2dca 100644
--- a/src/transport/gnunet-service-transport_manipulation.c
+++ b/src/transport/gnunet-service-transport_manipulation.c
@@ -168,7 +168,7 @@ static struct GNUNET_SCHEDULER_Task
*generic_send_delay_task;
/**
* Set traffic metric to manipulate
*
- * @param message containing information
+ * @param tm message containing information
*/
void
GST_manipulation_set_metric (const struct TrafficMetricMessage *tm)
@@ -349,7 +349,7 @@ GST_manipulation_send (const struct GNUNET_PeerIdentity
*target,
*
* @param address binary address
* @param session the session
- * @param prop[IN|OUT] metrics to modify
+ * @param[in,out] prop metrics to modify
*/
void
GST_manipulation_manipulate_metrics (const struct GNUNET_HELLO_Address
*address,
diff --git a/src/transport/gnunet-service-transport_neighbours.c
b/src/transport/gnunet-service-transport_neighbours.c
index ca1b4d1da..e61441d9f 100644
--- a/src/transport/gnunet-service-transport_neighbours.c
+++ b/src/transport/gnunet-service-transport_neighbours.c
@@ -1768,16 +1768,6 @@ GST_neighbours_calculate_receive_delay (const struct
}
-/**
- * Transmit a message to the given target using the active connection.
- *
- * @param target destination
- * @param msg message to send
- * @param msg_size number of bytes in msg
- * @param timeout when to fail with timeout
- * @param cont function to call when done
- * @param cont_cls closure for @a cont
- */
void
GST_neighbours_send (const struct GNUNET_PeerIdentity *target,
const void *msg,
@@ -3019,13 +3009,6 @@ GST_neighbours_notify_data_sent (const struct
GNUNET_HELLO_Address *address,
}
-/**
- * Master task run for every neighbour. Performs all of the time-related
- * activities (keep alive, send next message, disconnect if idle, finish
- * clean up after disconnect).
- *
- * @param cls the 'struct NeighbourMapEntry' for which we are running
- */
static void
master_task (void *cls)
{
@@ -3646,13 +3629,6 @@ delayed_disconnect (void *cls)
}
-/**
- * We received a quota message from the given peer,
- * validate and process.
- *
- * @param peer sender of the message
- * @param msg the quota message
- */
void
GST_neighbours_handle_quota_message (const struct GNUNET_PeerIdentity *peer,
const struct GNUNET_MessageHeader *msg)
diff --git a/src/transport/gnunet-service-transport_neighbours.h
b/src/transport/gnunet-service-transport_neighbours.h
index 13aeab4e6..7ce911aa1 100644
--- a/src/transport/gnunet-service-transport_neighbours.h
+++ b/src/transport/gnunet-service-transport_neighbours.h
@@ -292,7 +292,7 @@ GST_neighbour_get_current_address (const struct
GNUNET_PeerIdentity *peer);
/**
- * We received a quoat message from the given peer,
+ * We received a quota message from the given peer,
* validate and process.
*
* @param peer sender of the message
diff --git a/src/transport/gnunet-service-transport_plugins.c
b/src/transport/gnunet-service-transport_plugins.c
index c88532806..218ef80ab 100644
--- a/src/transport/gnunet-service-transport_plugins.c
+++ b/src/transport/gnunet-service-transport_plugins.c
@@ -83,7 +83,6 @@ static struct TransportPlugin *plugins_tail;
*
* @param cls closure
* @param address address to update metrics for
- * @param session the session
* @param distance new distance
*/
static void
@@ -121,18 +120,6 @@ plugin_env_address_to_type (void *cls,
}
-/**
- * Load and initialize all plugins. The respective functions will be
- * invoked by the plugins when the respective events happen. The
- * closure will be set to a 'const char*' containing the name of the
- * plugin that caused the call.
- *
- * @param recv_cb function to call when data is received
- * @param address_cb function to call when our public addresses changed
- * @param session_start_cb function to call when a session was created
- * @param session_end_cb function to call when a session was terminated
- * @param address_type_cb function to call when a address type is requested
- */
void
GST_plugins_load (GNUNET_TRANSPORT_PluginReceiveCallback recv_cb,
GNUNET_TRANSPORT_AddressNotification address_cb,
@@ -431,12 +418,6 @@ GST_plugins_a2s (const struct GNUNET_HELLO_Address
*address)
}
-/**
- * Register callback with all plugins to monitor their status.
- *
- * @param cb callback to register, NULL to unsubscribe
- * @param cb_cls closure for @a cb
- */
void
GST_plugins_monitor_subscribe (GNUNET_TRANSPORT_SessionInfoCallback cb,
void *cb_cls)
diff --git a/src/transport/gnunet-service-transport_plugins.h
b/src/transport/gnunet-service-transport_plugins.h
index 0e69da074..fdd819fc5 100644
--- a/src/transport/gnunet-service-transport_plugins.h
+++ b/src/transport/gnunet-service-transport_plugins.h
@@ -40,13 +40,9 @@
* plugin that caused the call.
*
* @param recv_cb function to call when data is received
- * @param register_quota_cb function to call to register a quota callback
- * @param unregister_quota_cb function to call to unregister a quota callback
* @param address_cb function to call when our public addresses changed
* @param session_start_cb function to call when a session was created
* @param session_end_cb function to call when a session was terminated
- * @param address_type_cb function to call when a address type is requested
- * @param metric_update_cb function to call when address metrics change
*/
void
GST_plugins_load (GNUNET_TRANSPORT_PluginReceiveCallback recv_cb,
diff --git a/src/transport/plugin_transport_http_client.c
b/src/transport/plugin_transport_http_client.c
index 476a3cd52..82468992b 100644
--- a/src/transport/plugin_transport_http_client.c
+++ b/src/transport/plugin_transport_http_client.c
@@ -556,7 +556,6 @@ client_reschedule_session_timeout (struct
GNUNET_ATS_Session *s)
* Task performing curl operations
*
* @param cls plugin as closure
- * @param tc gnunet scheduler task context
*/
static void
client_run (void *cls);
@@ -1289,11 +1288,6 @@ client_receive (void *stream,
}
-/**
- * Task performing curl operations
- *
- * @param cls plugin as closure
- */
static void
client_run (void *cls)
{
diff --git a/src/transport/plugin_transport_http_common.c
b/src/transport/plugin_transport_http_common.c
index 75bf8b74a..40353daeb 100644
--- a/src/transport/plugin_transport_http_common.c
+++ b/src/transport/plugin_transport_http_common.c
@@ -407,20 +407,6 @@ http_common_dns_ip_lookup (const char *name,
}
-/**
- * Convert the transports address to a nice, human-readable
- * format.
- *
- * @param cls closure
- * @param type name of the transport that generated the address
- * @param addr one of the addresses of the host, NULL for the last address
- * the specific address format depends on the transport
- * @param addrlen length of the @a addr
- * @param numeric should (IP) addresses be displayed in numeric form?
- * @param timeout after how long should we give up?
- * @param asc function to call on each string
- * @param asc_cls closure for @a asc
- */
void
http_common_plugin_address_pretty_printer (void *cls, const char *type,
const void *addr,
@@ -597,17 +583,6 @@ http_common_plugin_address_to_url (void *cls,
}
-/**
- * Function called for a quick conversion of the binary address to
- * a numeric address. Note that the caller must not free the
- * address and that the next call to this function is allowed
- * to override the address again.
- *
- * @param plugin the name of the plugin
- * @param addr binary address
- * @param addrlen length of the address
- * @return string representing the same address
- */
const char *
http_common_plugin_address_to_string (const char *plugin,
const void *addr,
@@ -642,18 +617,6 @@ http_common_plugin_address_to_string (const char *plugin,
}
-/**
- * Function called to convert a string address to
- * a binary address.
- *
- * @param cls closure ('struct Plugin*')
- * @param addr string address
- * @param addrlen length of the @a addr
- * @param buf location to store the buffer
- * If the function returns #GNUNET_SYSERR, its contents are undefined.
- * @param added length of created address
- * @return #GNUNET_OK on success, #GNUNET_SYSERR on failure
- */
int
http_common_plugin_string_to_address (void *cls,
const char *addr,
@@ -721,14 +684,6 @@ http_common_plugin_string_to_address (void *cls,
}
-/**
- * Create a HTTP address from a socketaddr
- *
- * @param protocol protocol
- * @param addr sockaddr * address
- * @param addrlen length of the address
- * @return the HttpAddress
- */
struct HttpAddress *
http_common_address_from_socket (const char *protocol,
const struct sockaddr *addr,
diff --git a/src/transport/plugin_transport_http_common.h
b/src/transport/plugin_transport_http_common.h
index 299dc0e68..7a532249d 100644
--- a/src/transport/plugin_transport_http_common.h
+++ b/src/transport/plugin_transport_http_common.h
@@ -137,7 +137,7 @@ http_split_address (const char *addr);
* @param type name of the transport that generated the address
* @param addr one of the addresses of the host, NULL for the last address
* the specific address format depends on the transport
- * @param addrlen length of the address
+ * @param addrlen length of @a addr
* @param numeric should (IP) addresses be displayed in numeric form?
* @param timeout after how long should we give up?
* @param asc function to call on each string
@@ -178,7 +178,7 @@ http_common_plugin_address_to_string (const char *plugin,
*
* @param cls closure (`struct Plugin*`)
* @param addr string address
- * @param addrlen length of the address
+ * @param addrlen length of @a addr
* @param buf location to store the buffer
* If the function returns #GNUNET_SYSERR, its contents are undefined.
* @param added length of created address
@@ -198,7 +198,7 @@ http_common_plugin_string_to_address (void *cls,
* @param protocol protocol
* @param addr `sockaddr *` address
* @param addrlen length of the @a addr
- * @return the string
+ * @return A pointer to a `struct HttpAddress` derived from @a addr
*/
struct HttpAddress *
http_common_address_from_socket (const char *protocol,
diff --git a/src/transport/plugin_transport_http_server.c
b/src/transport/plugin_transport_http_server.c
index 78b030e9a..3ad2356b0 100644
--- a/src/transport/plugin_transport_http_server.c
+++ b/src/transport/plugin_transport_http_server.c
@@ -2563,7 +2563,7 @@ server_remove_address (void *cls,
* Our external IP address/port mapping has changed.
*
* @param cls closure, the 'struct LocalAddrList'
- * @param app_ctx[in,out] location where the app can store stuff
+ * @param[in,out] app_ctx location where the app can store stuff
* on add and retrieve it on remove
* @param add_remove #GNUNET_YES to mean the new public IP address, #GNUNET_NO
to mean
* the previous (now invalid) one
diff --git a/src/transport/plugin_transport_tcp.c
b/src/transport/plugin_transport_tcp.c
index ac4cc672f..ceae64709 100644
--- a/src/transport/plugin_transport_tcp.c
+++ b/src/transport/plugin_transport_tcp.c
@@ -1418,7 +1418,7 @@ notify_session_monitor (struct Plugin *plugin,
* Our external IP address/port mapping has changed.
*
* @param cls closure, the `struct Plugin`
- * @param app_ctx[in,out] location where the app can store stuff
+ * @param[in,out] app_ctx location where the app can store stuff
* on add and retrieve it on remove
* @param add_remove #GNUNET_YES to mean the new public IP address, #GNUNET_NO
to mean
* the previous (now invalid) one
diff --git a/src/transport/plugin_transport_udp.c
b/src/transport/plugin_transport_udp.c
index 2db31caa3..0d3ca449d 100644
--- a/src/transport/plugin_transport_udp.c
+++ b/src/transport/plugin_transport_udp.c
@@ -1254,7 +1254,7 @@ udp_plugin_check_address (void *cls, const void *addr,
size_t addrlen)
* Our external IP address/port mapping has changed.
*
* @param cls closure, the `struct Plugin`
- * @param app_ctx[in,out] location where the app can store stuff
+ * @param[in,out] app_ctx location where the app can store stuff
* on add and retrieve it on remove
* @param add_remove #GNUNET_YES to mean the new public IP address,
* #GNUNET_NO to mean the previous (now invalid) one
diff --git a/src/transport/tcp_server_legacy.c
b/src/transport/tcp_server_legacy.c
index f4d48d4f6..bb572c843 100644
--- a/src/transport/tcp_server_legacy.c
+++ b/src/transport/tcp_server_legacy.c
@@ -699,11 +699,6 @@ GNUNET_SERVER_suspend (struct GNUNET_SERVER_Handle *server)
}
-/**
- * Resume accepting connections from the listen socket.
- *
- * @param server server to stop accepting connections.
- */
void
GNUNET_SERVER_resume (struct GNUNET_SERVER_Handle *server)
{
@@ -1620,21 +1615,6 @@ transmit_ready_callback_wrapper (void *cls, size_t size,
void *buf)
}
-/**
- * Notify us when the server has enough space to transmit
- * a message of the given size to the given client.
- *
- * @param client client to transmit message to
- * @param size requested amount of buffer space
- * @param timeout after how long should we give up (and call
- * notify with buf NULL and size 0)?
- * @param callback function to call when space is available
- * @param callback_cls closure for @a callback
- * @return non-NULL if the notify callback was queued; can be used
- * to cancel the request using
- * #GNUNET_SERVER_notify_transmit_ready_cancel().
- * NULL if we are already going to notify someone else (busy)
- */
struct GNUNET_SERVER_TransmitHandle *
GNUNET_SERVER_notify_transmit_ready (struct GNUNET_SERVER_Client *client,
size_t size,
diff --git a/src/transport/test_transport_api2_tcp_node1.conf
b/src/transport/test_transport_api2_tcp_node1.conf
index b8a743a3b..d396f43d7 100644
--- a/src/transport/test_transport_api2_tcp_node1.conf
+++ b/src/transport/test_transport_api2_tcp_node1.conf
@@ -5,7 +5,7 @@ GNUNET_TEST_HOME = $GNUNET_TMP/test-transport/api-tcp-p1/
[transport]
BINARY = gnunet-service-tng
PLUGINS = tcp
-#PREFIX = valgrind --leak-check=full --track-origins=yes --trace-children=yes
--log-file=/tmp/vg_peer1-%p
+#PREFIX = valgrind --leak-check=full --track-origins=yes --trace-children=yes
--log-file=$GNUNET_TEST_HOME/vg_peer1-%p
UNIXPATH = $GNUNET_RUNTIME_DIR/tng-p1.sock
[communicator-tcp]
@@ -14,11 +14,11 @@ BINDTO = 192.168.15.1:60002
DISABLE_V6 = YES
IMMEDIATE_START = YES
UNIXPATH = $GNUNET_RUNTIME_DIR/tcp-comm-p1.sock
-#PREFIX = valgrind --leak-check=full --track-origins=yes --trace-children=yes
--log-file=/tmp/vg_ctpeer1-%p
+#PREFIX = valgrind --leak-check=full --track-origins=yes --trace-children=yes
--log-file=$GNUNET_TEST_HOME/vg_ctpeer1-%p
#PREFIX = xterm -geometry 100x85 -T peer1 -e gdb --args
[communicator-udp]
-#PREFIX = valgrind --leak-check=full --track-origins=yes --trace-children=yes
--log-file=/tmp/vg_cupeer1-%p
+#PREFIX = valgrind --leak-check=full --track-origins=yes --trace-children=yes
--log-file=$GNUNET_TEST_HOME/vg_cupeer1-%p
BINARY = gnunet-communicator-udp
BINDTO = 192.168.15.1:60002
DISABLE_V6 = YES
diff --git a/src/transport/test_transport_api2_tcp_node2.conf
b/src/transport/test_transport_api2_tcp_node2.conf
index f94368b3f..a4557e7ea 100644
--- a/src/transport/test_transport_api2_tcp_node2.conf
+++ b/src/transport/test_transport_api2_tcp_node2.conf
@@ -4,7 +4,7 @@ GNUNET_TEST_HOME = $GNUNET_TMP/test-transport/api-tcp-p2/
[transport]
BINARY = gnunet-service-tng
-#PREFIX = valgrind --log-file=/tmp/vg_peer2-%p
+#PREFIX = valgrind --log-file=$GNUNET_TEST_HOME/vg_peer2-%p
UNIXPATH = $GNUNET_RUNTIME_DIR/tng-p2.sock
[communicator-tcp]
@@ -12,7 +12,7 @@ BINARY = gnunet-communicator-tcp
BINDTO = 192.168.15.2:60003
DISABLE_V6 = YES
IMMEDIATE_START = YES
-#PREFIX = valgrind --log-file=/tmp/vg_comm2-%p
+#PREFIX = valgrind --log-file=$GNUNET_TEST_HOME/vg_comm2-%p
UNIXPATH = $GNUNET_RUNTIME_DIR/tcp-comm-p2.sock
[peerstore]
diff --git a/src/transport/test_transport_api2_tcp_peer1.conf
b/src/transport/test_transport_api2_tcp_peer1.conf
index 745ed6887..5a21b2adb 100644
--- a/src/transport/test_transport_api2_tcp_peer1.conf
+++ b/src/transport/test_transport_api2_tcp_peer1.conf
@@ -5,7 +5,7 @@ GNUNET_TEST_HOME = $GNUNET_TMP/test-transport/api-tcp-p1/
[transport]
BINARY = gnunet-service-tng
PLUGINS = tcp
-#PREFIX = valgrind --log-file=/tmp/vg_peer1-%p
+#PREFIX = valgrind --log-file=$GNUNET_TEST_HOME/vg_peer1-%p
UNIXPATH = $GNUNET_RUNTIME_DIR/tng-p1.sock
[communicator-tcp]
@@ -14,7 +14,7 @@ BINDTO = 60002
DISABLE_V6 = YES
IMMEDIATE_START = YES
UNIXPATH = $GNUNET_RUNTIME_DIR/tcp-comm-p1.sock
-#PREFIX = valgrind --log-file=/tmp/vg_cpeer1-%p
+#PREFIX = valgrind --log-file=$GNUNET_TEST_HOME/vg_cpeer1-%p
[peerstore]
IMMEDIATE_START = YES
diff --git a/src/transport/test_transport_api2_tcp_peer2.conf
b/src/transport/test_transport_api2_tcp_peer2.conf
index 022468bcd..e42704100 100644
--- a/src/transport/test_transport_api2_tcp_peer2.conf
+++ b/src/transport/test_transport_api2_tcp_peer2.conf
@@ -4,7 +4,7 @@ GNUNET_TEST_HOME = $GNUNET_TMP/test-transport/api-tcp-p2/
[transport]
BINARY = gnunet-service-tng
-#PREFIX = valgrind --log-file=/tmp/vg_peer2-%p
+#PREFIX = valgrind --log-file=$GNUNET_TEST_HOME/vg_peer2-%p
UNIXPATH = $GNUNET_RUNTIME_DIR/tng-p2.sock
[communicator-tcp]
@@ -12,7 +12,7 @@ BINARY = gnunet-communicator-tcp
BINDTO = 60003
DISABLE_V6 = YES
IMMEDIATE_START = YES
-#PREFIX = valgrind --log-file=/tmp/vg_comm2-%p
+#PREFIX = valgrind --log-file=$GNUNET_TEST_HOME/vg_comm2-%p
UNIXPATH = $GNUNET_RUNTIME_DIR/tcp-comm-p2.sock
[peerstore]
diff --git a/src/transport/transport-testing-cmds.h
b/src/transport/transport-testing-cmds.h
index 5a3fb22d6..c577feb34 100644
--- a/src/transport/transport-testing-cmds.h
+++ b/src/transport/transport-testing-cmds.h
@@ -227,9 +227,9 @@ GNUNET_TRANSPORT_cmd_stop_peer (const char *label,
*
* @param label name for command
* @param start_peer_label Label of the cmd to start a peer.
- * @param create_peer_label Label of the cmd which started the test system.
+ * @param create_label Label of the cmd which started the test system.
* @param num Number globally identifying the node.
- * @param The topology for the test setup.
+ * @param topology The topology for the test setup.
* @param additional_connects Number of additional connects this cmd will wait
for not triggered by this cmd.
* @return command.
*/
@@ -248,9 +248,9 @@ GNUNET_TRANSPORT_cmd_connect_peers (
*
* @param label name for command.
* @param start_peer_label Label of the cmd to start a peer.
- * @param create_peer_label Label of the cmd which started the test system.
+ * @param create_label Label of the cmd which started the test system.
* @param num Number globally identifying the node.
- * @param The topology for the test setup.
+ * @param topology The topology for the test setup.
* @return command.
*/
struct GNUNET_TESTING_Command
@@ -271,7 +271,7 @@ GNUNET_TRANSPORT_cmd_send_simple (const char *label,
* @param num Number globally identifying the node.
* @param node_n The number of the node in a network namespace.
* @param namespace_n The number of the network namespace.
- * @param The topology for the test setup.
+ * @param topology The topology for the test setup.
* @return command.
*/
struct GNUNET_TESTING_Command
diff --git a/src/transport/transport-testing-communicator.c
b/src/transport/transport-testing-communicator.c
index ce4af01f2..1bf88bb3d 100644
--- a/src/transport/transport-testing-communicator.c
+++ b/src/transport/transport-testing-communicator.c
@@ -232,7 +232,7 @@ check_communicator_backchannel (void *cls,
* Pass the message to the client.
*
* @param cls Closure - communicator handle
- * @param msg Message
+ * @param bc_msg Message
*/
static void
handle_communicator_backchannel (void *cls,
@@ -283,7 +283,7 @@ handle_communicator_backchannel (void *cls,
* Address of our peer added. Test message is well-formed.
*
* @param cls the client
- * @param aam the send message that was sent
+ * @param msg the send message that was sent
* @return #GNUNET_OK if message is well-formed
*/
static int
@@ -365,7 +365,7 @@ check_incoming_msg (void *cls,
* Pass the message to the client.
*
* @param cls Closure - communicator handle
- * @param msg Message
+ * @param inc_msg Message
*/
static void
handle_incoming_msg (void *cls,
@@ -1146,15 +1146,6 @@
GNUNET_TRANSPORT_TESTING_transport_communicator_open_queue (
}
-/**
- * @brief Instruct communicator to send data
- *
- * @param tc_queue The queue to use for sending
- * @param cont function to call when done sending
- * @param cont_cls closure for @a cont
- * @param payload Data to send
- * @param payload_size Size of the @a payload
- */
void
GNUNET_TRANSPORT_TESTING_transport_communicator_send
(struct GNUNET_TRANSPORT_TESTING_TransportCommunicatorHandle *tc_h,
diff --git a/src/transport/transport-testing-filenames.c
b/src/transport/transport-testing-filenames.c
index 7c136b690..70c1ee55a 100644
--- a/src/transport/transport-testing-filenames.c
+++ b/src/transport/transport-testing-filenames.c
@@ -61,13 +61,6 @@ extract_filename (const char *file)
}
-/**
- * Extracts the test filename from an absolute file name and removes
- * the extension
- *
- * @param file absolute file name
- * @return the result
- */
char *
GNUNET_TRANSPORT_TESTING_get_test_name (const char *file)
{
@@ -96,12 +89,6 @@ GNUNET_TRANSPORT_TESTING_get_test_name (const char *file)
}
-/**
- * Extracts the filename from an absolute file name and removes the extension
- *
- * @param file absolute file name
- * @return the result
- */
char *
GNUNET_TRANSPORT_TESTING_get_test_source_name (const char *file)
{
@@ -115,13 +102,6 @@ GNUNET_TRANSPORT_TESTING_get_test_source_name (const char
*file)
}
-/**
- * Extracts the plugin name from an absolute file name and the test name
- *
- * @param file absolute file name
- * @param test test name
- * @return the result
- */
char *
GNUNET_TRANSPORT_TESTING_get_test_plugin_name (const char *file,
const char *test)
@@ -161,14 +141,6 @@ suc:
}
-/**
- * This function takes the filename (e.g. argv[0), removes a "lt-"-prefix and
- * if existing ".exe"-prefix and adds the peer-number
- *
- * @param file filename of the test, e.g. argv[0]
- * @param count peer number
- * @return the result
- */
char *
GNUNET_TRANSPORT_TESTING_get_config_name (const char *file,
int count)
diff --git a/src/transport/transport-testing-main.c
b/src/transport/transport-testing-main.c
index 20c58eeee..8d1727d77 100644
--- a/src/transport/transport-testing-main.c
+++ b/src/transport/transport-testing-main.c
@@ -253,7 +253,7 @@ my_nc (void *cls,
*
* @param cls our `struct GNUNET_TRANSPORT_TESTING_InternalPeerContext *`
* @param peer peer we got disconnected from
- * @param custom_cls return value from @my_nc
+ * @param custom_cls return value from @a my_nc
*/
static void
my_nd (void *cls,
diff --git a/src/transport/transport-testing-main2.c
b/src/transport/transport-testing-main2.c
index 62aa3ceb7..de0b7f4cd 100644
--- a/src/transport/transport-testing-main2.c
+++ b/src/transport/transport-testing-main2.c
@@ -253,7 +253,7 @@ my_nc (void *cls,
*
* @param cls our `struct GNUNET_TRANSPORT_TESTING_InternalPeerContext *`
* @param peer peer we got disconnected from
- * @param custom_cls return value from @my_nc
+ * @param custom_cls return value from @a my_nc
*/
static void
my_nd (void *cls,
diff --git a/src/transport/transport-testing2.c
b/src/transport/transport-testing2.c
index 6d41ec098..f0dee7388 100644
--- a/src/transport/transport-testing2.c
+++ b/src/transport/transport-testing2.c
@@ -379,19 +379,6 @@ retrieve_hello (void *cls)
}
-/**
- * Start a peer with the given configuration
- * @param tth the testing handle
- * @param cfgname configuration file
- * @param peer_id a unique number to identify the peer
- * @param handlers functions for receiving messages
- * @param nc connect callback
- * @param nd disconnect callback
- * @param cb_cls closure for callback
- * @param start_cb start callback
- * @param start_cb_cls closure for callback
- * @return the peer context
- */
struct GNUNET_TRANSPORT_TESTING_PeerContext *
GNUNET_TRANSPORT_TESTING_start_peer (struct
GNUNET_TRANSPORT_TESTING_Handle *tth,
@@ -545,14 +532,6 @@ GNUNET_TRANSPORT_TESTING_start_peer (struct
}
-/**
- * Stops and restarts the given peer, sleeping (!) for 5s in between.
- *
- * @param p the peer
- * @param restart_cb callback to call when restarted
- * @param restart_cb_cls callback closure
- * @return #GNUNET_OK in success otherwise #GNUNET_SYSERR
- */
int
GNUNET_TRANSPORT_TESTING_restart_peer (struct
GNUNET_TRANSPORT_TESTING_PeerContext *p,
@@ -751,11 +730,6 @@ GNUNET_TRANSPORT_TESTING_stop_peer (struct
}*/
-/**
- * Offer the current HELLO of P2 to P1.
- *
- * @param cls our `struct GNUNET_TRANSPORT_TESTING_ConnectRequest`
- */
static void
offer_hello (void *cls)
{
@@ -859,13 +833,6 @@ GNUNET_TRANSPORT_TESTING_connect_peers (struct
}
-/**
- * Cancel the request to connect two peers
- * Tou MUST cancel the request if you stop the peers before the peers
connected successfully
- *
- * @param tth transport testing handle
- * @param cc a connect request handle
- */
void
GNUNET_TRANSPORT_TESTING_connect_peers_cancel (struct
GNUNET_TRANSPORT_TESTING_ConnectRequest
diff --git a/src/transport/transport-testing2.h
b/src/transport/transport-testing2.h
index e2167ca7e..b5db28500 100644
--- a/src/transport/transport-testing2.h
+++ b/src/transport/transport-testing2.h
@@ -288,7 +288,7 @@ GNUNET_TRANSPORT_TESTING_done (struct
GNUNET_TRANSPORT_TESTING_Handle *tth);
*
* @param tth the testing handle
* @param cfgname configuration file
- * @param peer_id the peer_id
+ * @param peer_id an identification number for the peer
* @param handlers functions for receiving messages
* @param nc connect callback
* @param nd disconnect callback
diff --git a/src/transport/transport_api2_communication.c
b/src/transport/transport_api2_communication.c
index 5bcfb30c7..b79f0d8bf 100644
--- a/src/transport/transport_api2_communication.c
+++ b/src/transport/transport_api2_communication.c
@@ -802,24 +802,6 @@ reconnect (struct GNUNET_TRANSPORT_CommunicatorHandle *ch)
}
-/**
- * Connect to the transport service.
- *
- * @param cfg configuration to use
- * @param config_section section of the configuration to use for options
- * @param addr_prefix address prefix for addresses supported by this
- * communicator, could be NULL for incoming-only communicators
- * @param cc what characteristics does the communicator have?
- * @param mtu maximum message size supported by communicator, 0 if
- * sending is not supported, SIZE_MAX for no MTU
- * @param mq_init function to call to initialize a message queue given
- * the address of another peer, can be NULL if the
- * communicator only supports receiving messages
- * @param mq_init_cls closure for @a mq_init
- * @param notify_cb function to pass backchannel messages to communicator
- * @param notify_cb_cls closure for @a notify_cb
- * @return NULL on error
- */
struct GNUNET_TRANSPORT_CommunicatorHandle *
GNUNET_TRANSPORT_communicator_connect (
const struct GNUNET_CONFIGURATION_Handle *cfg,
@@ -880,26 +862,6 @@ GNUNET_TRANSPORT_communicator_disconnect (
/* ************************* Receiving *************************** */
-/**
- * Notify transport service that the communicator has received
- * a message.
- *
- * @param ch connection to transport service
- * @param sender presumed sender of the message (details to be checked
- * by higher layers)
- * @param msg the message
- * @param expected_addr_validity how long does the communicator believe it
- * will continue to be able to receive messages from the same address
- * on which it received this message?
- * @param cb function to call once handling the message is done, NULL if
- * flow control is not supported by this communicator
- * @param cb_cls closure for @a cb
- * @return #GNUNET_OK if all is well, #GNUNET_NO if the message was
- * immediately dropped due to memory limitations (communicator
- * should try to apply back pressure),
- * #GNUNET_SYSERR if the message could not be delivered because
- * the transport service is not yet up
- */
int
GNUNET_TRANSPORT_communicator_receive (
struct GNUNET_TRANSPORT_CommunicatorHandle *ch,
@@ -970,25 +932,6 @@ GNUNET_TRANSPORT_communicator_receive (
/* ************************* Discovery *************************** */
-/**
- * Notify transport service that an MQ became available due to an
- * "inbound" connection or because the communicator discovered the
- * presence of another peer.
- *
- * @param ch connection to transport service
- * @param peer peer with which we can now communicate
- * @param address address in human-readable format, 0-terminated, UTF-8
- * @param mtu maximum message size supported by queue, 0 if
- * sending is not supported, SIZE_MAX for no MTU
- * @param q_len number of messages that can be send through this queue
- * @param priority queue priority. Queues with highest priority should be
- * used
- * @param nt which network type does the @a address belong to?
- * @param cc what characteristics does the communicator have?
- * @param cs what is the connection status of the queue?
- * @param mq message queue of the @a peer
- * @return API handle identifying the new MQ
- */
struct GNUNET_TRANSPORT_QueueHandle *
GNUNET_TRANSPORT_communicator_mq_add (
struct GNUNET_TRANSPORT_CommunicatorHandle *ch,
@@ -1023,15 +966,6 @@ GNUNET_TRANSPORT_communicator_mq_add (
}
-/**
- * Notify transport service that an MQ was updated
- *
- * @param ch connection to transport service
- * @param qh the queue to update
- * @param q_len number of messages that can be send through this queue
- * @param priority queue priority. Queues with highest priority should be
- * used
- */
void
GNUNET_TRANSPORT_communicator_mq_update (
struct GNUNET_TRANSPORT_CommunicatorHandle *ch,
@@ -1149,20 +1083,6 @@ GNUNET_TRANSPORT_communicator_address_remove_all (
/* ************************* Backchannel *************************** */
-/**
- * The communicator asks the transport service to route a message via
- * a different path to another communicator service at another peer.
- * This must only be done for special control traffic (as there is no
- * flow control for this API), such as acknowledgements, and generally
- * only be done if the communicator is uni-directional (i.e. cannot
- * send the message back itself).
- *
- * @param ch handle of this communicator
- * @param pid peer to send the message to
- * @param comm name of the communicator to send the message to
- * @param header header of the message to transmit and pass via the
- * notify-API to @a pid's communicator @a comm
- */
void
GNUNET_TRANSPORT_communicator_notify (
struct GNUNET_TRANSPORT_CommunicatorHandle *ch,
diff --git a/src/transport/transport_api_address_to_string.c
b/src/transport/transport_api_address_to_string.c
index c7de39ea8..5b234f802 100644
--- a/src/transport/transport_api_address_to_string.c
+++ b/src/transport/transport_api_address_to_string.c
@@ -56,7 +56,7 @@ struct GNUNET_TRANSPORT_AddressToStringContext
* Function called with responses from the service.
*
* @param cls our `struct GNUNET_TRANSPORT_AddressToStringContext *`
- * @param msg message with the human-readable address
+ * @param atsm message with the human-readable address
* @return #GNUNET_OK if message is well-formed
*/
static int
@@ -97,7 +97,7 @@ check_reply (void *cls,
* Function called with responses from the service.
*
* @param cls our `struct GNUNET_TRANSPORT_AddressToStringContext *`
- * @param msg message with the human-readable address
+ * @param atsm message with the human-readable address
*/
static void
handle_reply (void *cls,
diff --git a/src/transport/transport_api_cmd_backchannel_check.c
b/src/transport/transport_api_cmd_backchannel_check.c
index b285d7abf..1edd6cb7e 100644
--- a/src/transport/transport_api_cmd_backchannel_check.c
+++ b/src/transport/transport_api_cmd_backchannel_check.c
@@ -522,18 +522,6 @@ backchannel_check_cleanup (void *cls)
}
-/**
- * Create command.
- *
- * @param label name for command.
- * @param start_peer_label Label of the cmd to start a peer.
- * @param create_label Label of the cmd to create the testing system.
- * @param num Number globally identifying the node.
- * @param node_n The number of the node in a network namespace.
- * @param namespace_n The number of the network namespace.
- * @param The topology for the test setup.
- * @return command.
- */
struct GNUNET_TESTING_Command
GNUNET_TRANSPORT_cmd_backchannel_check (const char *label,
const char *start_peer_label,
diff --git a/src/transport/transport_api_cmd_connecting_peers.c
b/src/transport/transport_api_cmd_connecting_peers.c
index 4d9e9c3ab..a6006f698 100644
--- a/src/transport/transport_api_cmd_connecting_peers.c
+++ b/src/transport/transport_api_cmd_connecting_peers.c
@@ -220,17 +220,6 @@ connect_peers_traits (void *cls,
}
-/**
- * Create command
- *
- * @param label name for command
- * @param start_peer_label Label of the cmd to start a peer.
- * @param create_peer_label Label of the cmd which started the test system.
- * @param num Number globally identifying the node.
- * @param The topology for the test setup.
- * @param additional_connects Number of additional connects this cmd will wait
for not triggered by this cmd.
- * @return command.
- */
struct GNUNET_TESTING_Command
GNUNET_TRANSPORT_cmd_connect_peers (const char *label,
const char *start_peer_label,
diff --git a/src/transport/transport_api_cmd_send_simple.c
b/src/transport/transport_api_cmd_send_simple.c
index a00e1b922..c71c952aa 100644
--- a/src/transport/transport_api_cmd_send_simple.c
+++ b/src/transport/transport_api_cmd_send_simple.c
@@ -137,16 +137,6 @@ send_simple_run (void *cls,
}
-/**
- * Create command.
- *
- * @param label name for command.
- * @param start_peer_label Label of the cmd to start a peer.
- * @param start_peer_label Label of the cmd which started the test system.
- * @param num Number globally identifying the node.
- * @param The topology for the test setup.
- * @return command.
- */
struct GNUNET_TESTING_Command
GNUNET_TRANSPORT_cmd_send_simple (const char *label,
const char *start_peer_label,
diff --git a/src/transport/transport_api_core.c
b/src/transport/transport_api_core.c
index 0ffaeb444..12612de09 100644
--- a/src/transport/transport_api_core.c
+++ b/src/transport/transport_api_core.c
@@ -713,7 +713,7 @@ handle_recv (void *cls, const struct InboundMessage *im)
* Function we use for handling incoming set quota messages.
*
* @param cls closure, a `struct GNUNET_TRANSPORT_CoreHandle *`
- * @param msg message received
+ * @param qm message received
*/
static void
handle_set_quota (void *cls, const struct QuotaSetMessage *qm)
diff --git a/src/transport/transport_api_monitor_peers.c
b/src/transport/transport_api_monitor_peers.c
index 2f0f07f23..ef1dc6087 100644
--- a/src/transport/transport_api_monitor_peers.c
+++ b/src/transport/transport_api_monitor_peers.c
@@ -389,32 +389,6 @@ do_peer_connect (void *cls)
}
-/**
- * Return information about a specific peer or all peers currently known to
- * transport service once or in monitoring mode. To obtain information about
- * a specific peer, a peer identity can be passed. To obtain information about
- * all peers currently known to transport service, NULL can be passed as peer
- * identity.
- *
- * For each peer, the callback is called with information about the address
used
- * to communicate with this peer, the state this peer is currently in and the
- * the current timeout for this state.
- *
- * Upon completion, the 'GNUNET_TRANSPORT_PeerIterateCallback' is called one
- * more time with 'NULL'. After this, the operation must no longer be
- * explicitly canceled.
- *
- * The #GNUNET_TRANSPORT_monitor_peers_cancel call MUST not be called in the
- * the peer_callback!
- *
- * @param cfg configuration to use
- * @param peer a specific peer identity to obtain information for,
- * NULL for all peers
- * @param one_shot #GNUNET_YES to return the current state and then end (with
NULL+NULL),
- * #GNUNET_NO to monitor peers continuously
- * @param peer_callback function to call with the results
- * @param peer_callback_cls closure for @a peer_address_callback
- */
struct GNUNET_TRANSPORT_PeerMonitoringContext *
GNUNET_TRANSPORT_monitor_peers (const struct GNUNET_CONFIGURATION_Handle *cfg,
const struct GNUNET_PeerIdentity *peer,
diff --git a/src/transport/transport_api_monitor_plugins.c
b/src/transport/transport_api_monitor_plugins.c
index d8eddddaa..43a11442b 100644
--- a/src/transport/transport_api_monitor_plugins.c
+++ b/src/transport/transport_api_monitor_plugins.c
@@ -211,7 +211,7 @@ locate_by_id (void *cls,
* Function called with responses from the service.
*
* @param cls our `struct GNUNET_TRANSPORT_PluginMonitor *`
- * @paramm tpmm message with event data
+ * @param tpmm message with event data
* @return #GNUNET_Ok if message is well-formed
*/
static int
@@ -243,7 +243,7 @@ check_event (void *cls,
* Function called with responses from the service.
*
* @param cls our `struct GNUNET_TRANSPORT_PluginMonitor *`
- * @paramm tpmm message with event data
+ * @param tpmm message with event data
*/
static void
handle_event (void *cls,
diff --git a/src/transport/transport_api_offer_hello.c
b/src/transport/transport_api_offer_hello.c
index eb342f57c..1b611aa6b 100644
--- a/src/transport/transport_api_offer_hello.c
+++ b/src/transport/transport_api_offer_hello.c
@@ -125,11 +125,6 @@ GNUNET_TRANSPORT_offer_hello (const struct
GNUNET_CONFIGURATION_Handle *cfg,
}
-/**
- * Cancel the request to transport to offer the HELLO message
- *
- * @param ohh the handle for the operation to cancel
- */
void
GNUNET_TRANSPORT_offer_hello_cancel (struct
GNUNET_TRANSPORT_OfferHelloHandle *ohh)
diff --git a/src/util/child_management.c b/src/util/child_management.c
index 832e05ece..8c413a8b5 100644
--- a/src/util/child_management.c
+++ b/src/util/child_management.c
@@ -197,7 +197,7 @@ child_management_done (void)
* Adding a child process to be monitored by the child management.
*
* @param proc The child process to be monitored.
- * @param cp The callback to be called, when the child process completed.
+ * @param cb The callback to be called, when the child process completed.
* @param cb_cls The closure for the callback.
* @return An handle for the the child being monitored.
*/
diff --git a/src/util/common_logging.c b/src/util/common_logging.c
index 27d9ca3ce..9fa848224 100644
--- a/src/util/common_logging.c
+++ b/src/util/common_logging.c
@@ -1154,15 +1154,6 @@ GNUNET_h2s2 (const struct GNUNET_HashCode *hc)
}
-/**
- * @ingroup logging
- * Convert a public key value to a string (for printing debug messages).
- * This is one of the very few calls in the entire API that is
- * NOT reentrant!
- *
- * @param hc the hash code
- * @return string
- */
const char *
GNUNET_p2s (const struct GNUNET_CRYPTO_EddsaPublicKey *p)
{
@@ -1176,15 +1167,6 @@ GNUNET_p2s (const struct GNUNET_CRYPTO_EddsaPublicKey *p)
}
-/**
- * @ingroup logging
- * Convert a public key value to a string (for printing debug messages).
- * This is one of the very few calls in the entire API that is
- * NOT reentrant!
- *
- * @param hc the hash code
- * @return string
- */
const char *
GNUNET_p2s2 (const struct GNUNET_CRYPTO_EddsaPublicKey *p)
{
@@ -1198,15 +1180,6 @@ GNUNET_p2s2 (const struct GNUNET_CRYPTO_EddsaPublicKey
*p)
}
-/**
- * @ingroup logging
- * Convert a public key value to a string (for printing debug messages).
- * This is one of the very few calls in the entire API that is
- * NOT reentrant!
- *
- * @param hc the hash code
- * @return string
- */
const char *
GNUNET_e2s (const struct GNUNET_CRYPTO_EcdhePublicKey *p)
{
@@ -1220,15 +1193,6 @@ GNUNET_e2s (const struct GNUNET_CRYPTO_EcdhePublicKey *p)
}
-/**
- * @ingroup logging
- * Convert a public key value to a string (for printing debug messages).
- * This is one of the very few calls in the entire API that is
- * NOT reentrant!
- *
- * @param hc the hash code
- * @return string
- */
const char *
GNUNET_e2s2 (const struct GNUNET_CRYPTO_EcdhePublicKey *p)
{
@@ -1476,7 +1440,7 @@ GNUNET_log_config_invalid (enum GNUNET_ErrorType kind,
* Set the async scope for the current thread.
*
* @param aid the async scope identifier
- * @param old_scope[out] location to save the old scope
+ * @param[out] old_scope location to save the old scope
*/
void
GNUNET_async_scope_enter (const struct GNUNET_AsyncScopeId *aid,
diff --git a/src/util/configuration.c b/src/util/configuration.c
index 27e6cf612..5c415aff7 100644
--- a/src/util/configuration.c
+++ b/src/util/configuration.c
@@ -91,7 +91,7 @@ struct ConfigSection
/**
* Is the configuration section marked as inaccessible?
*
- * This can happen if the section name is used in an @inline-secret@
+ * This can happen if the section name is used in an \@inline-secret\@
* directive, but the referenced file can't be found or accessed.
*/
bool inaccessible;
@@ -135,7 +135,7 @@ struct ConfigFile
/**
* Was this configuration file parsed via
- * @inline-secret@?
+ * \@inline-secret\@?
*/
char *hint_restrict_section;
diff --git a/src/util/container_multihashmap32.c
b/src/util/container_multihashmap32.c
index ccedd1bbb..2416c40f2 100644
--- a/src/util/container_multihashmap32.c
+++ b/src/util/container_multihashmap32.c
@@ -259,11 +259,11 @@ GNUNET_CONTAINER_multihashmap32_iterate (
/**
- * We are about to free() the @a bme, make sure it is not in
+ * We are about to free() the @a me, make sure it is not in
* the list of next values for any iterator in the @a map's next_cache.
*
* @param map the map to check
- * @param bme the entry that is about to be free'd
+ * @param me the entry that is about to be free'd
*/
static void
update_next_cache (struct GNUNET_CONTAINER_MultiHashMap32 *map,
diff --git a/src/util/crypto_rsa.c b/src/util/crypto_rsa.c
index 4b8e5a5ce..325a1fe86 100644
--- a/src/util/crypto_rsa.c
+++ b/src/util/crypto_rsa.c
@@ -709,7 +709,7 @@ rsa_blinding_key_free (struct RsaBlindingKey *bkey)
* Print an MPI to a newly created buffer
*
* @param v MPI to print.
- * @param[out] newly allocated buffer containing the result
+ * @param[out] buffer newly allocated buffer containing the result
* @return number of bytes stored in @a buffer
*/
static size_t
diff --git a/src/util/dnsstub.c b/src/util/dnsstub.c
index c2f2a441f..9763f6501 100644
--- a/src/util/dnsstub.c
+++ b/src/util/dnsstub.c
@@ -387,7 +387,7 @@ do_dns_read (struct GNUNET_DNSSTUB_RequestSocket *rs,
/**
* Read a DNS response from the (unhindered) UDP-Socket
*
- * @param cls socket to read from
+ * @param cls `struct GNUNET_DNSSTUB_RequestSocket` to read from
*/
static void
read_response (void *cls);
@@ -421,11 +421,6 @@ schedule_read (struct GNUNET_DNSSTUB_RequestSocket *rs)
}
-/**
- * Read a DNS response from the (unhindered) UDP-Socket
- *
- * @param cls `struct GNUNET_DNSSTUB_RequestSocket` to read from
- */
static void
read_response (void *cls)
{
@@ -692,13 +687,6 @@ GNUNET_DNSSTUB_add_dns_sa (struct GNUNET_DNSSTUB_Context
*ctx,
}
-/**
- * How long should we try requests before timing out?
- * Only effective for requests issued after this call.
- *
- * @param ctx resolver context to modify
- * @param retry_freq how long to wait between retries
- */
void
GNUNET_DNSSTUB_set_retry (struct GNUNET_DNSSTUB_Context *ctx,
struct GNUNET_TIME_Relative retry_freq)
diff --git a/src/util/gnunet-scrypt.c b/src/util/gnunet-scrypt.c
index ad46e3f39..3c219ef4f 100644
--- a/src/util/gnunet-scrypt.c
+++ b/src/util/gnunet-scrypt.c
@@ -81,7 +81,6 @@ shutdown_task (void *cls)
* Find our proof of work.
*
* @param cls closure (unused)
- * @param tc task context
*/
static void
find_proof (void *cls)
diff --git a/src/util/gnunet-service-resolver.c
b/src/util/gnunet-service-resolver.c
index 9bde04117..bb70ac3bd 100644
--- a/src/util/gnunet-service-resolver.c
+++ b/src/util/gnunet-service-resolver.c
@@ -313,8 +313,8 @@ extract_search_domain (const char *line, size_t line_len)
/**
* Reads the list of nameservers from /etc/resolve.conf
*
- * @param server_addrs[out] a list of null-terminated server address strings
- * @return the number of server addresses in @server_addrs, -1 on error
+ * @param[out] server_addrs a list of null-terminated server address strings
+ * @return the number of server addresses in @a server_addrs, -1 on error
*/
static int
lookup_dns_servers (char ***server_addrs)
@@ -670,8 +670,8 @@ try_cache (const char *hostname,
* @param hostname DNS name to query
* @param type requested DNS record type
* @param dns_id what should be the DNS request ID
- * @param packet_buf[out] where to write the request packet
- * @param packet_size[out] set to size of @a packet_buf on success
+ * @param[out] packet_buf where to write the request packet
+ * @param[out] packet_size set to size of @a packet_buf on success
* @return #GNUNET_OK on success
*/
static int
diff --git a/src/util/helper.c b/src/util/helper.c
index 0809c1f17..09d3fffab 100644
--- a/src/util/helper.c
+++ b/src/util/helper.c
@@ -164,15 +164,6 @@ struct GNUNET_HELPER_Handle
};
-/**
- * Sends termination signal to the helper process. The helper process is not
- * reaped; call GNUNET_HELPER_wait() for reaping the dead helper process.
- *
- * @param h the helper handle
- * @param soft_kill if GNUNET_YES, signals termination by closing the helper's
- * stdin; GNUNET_NO to signal termination by sending SIGTERM to helper
- * @return #GNUNET_OK on success; #GNUNET_SYSERR on error
- */
int
GNUNET_HELPER_kill (struct GNUNET_HELPER_Handle *h, int soft_kill)
{
@@ -213,14 +204,6 @@ GNUNET_HELPER_kill (struct GNUNET_HELPER_Handle *h, int
soft_kill)
}
-/**
- * Reap the helper process. This call is blocking(!). The helper process
- * should either be sent a termination signal before or should be dead before
- * calling this function
- *
- * @param h the helper handle
- * @return #GNUNET_OK on success; #GNUNET_SYSERR on error
- */
int
GNUNET_HELPER_wait (struct GNUNET_HELPER_Handle *h)
{
@@ -475,22 +458,6 @@ restart_task (void *cls)
}
-/**
- * Starts a helper and begins reading from it. The helper process is
- * restarted when it dies except when it is stopped using GNUNET_HELPER_stop()
- * or when the exp_cb callback is not NULL.
- *
- * @param with_control_pipe does the helper support the use of a control pipe
for signalling?
- * @param binary_name name of the binary to run
- * @param binary_argv NULL-terminated list of arguments to give when starting
the binary (this
- * argument must not be modified by the client for
- * the lifetime of the helper handle)
- * @param cb function to call if we get messages from the helper
- * @param exp_cb the exception callback to call. Set this to NULL if the helper
- * process has to be restarted automatically when it dies/crashes
- * @param cb_cls closure for the above callback
- * @return the new Handle, NULL on error
- */
struct GNUNET_HELPER_Handle *
GNUNET_HELPER_start (int with_control_pipe,
const char *binary_name,
@@ -644,19 +611,6 @@ helper_write (void *cls)
}
-/**
- * Send an message to the helper.
- *
- * @param h helper to send message to
- * @param msg message to send
- * @param can_drop can the message be dropped if there is already one in the
queue?
- * @param cont continuation to run once the message is out (#GNUNET_OK on
success, #GNUNET_NO
- * if the helper process died, #GNUNET_SYSERR during
#GNUNET_HELPER_destroy).
- * @param cont_cls closure for @a cont
- * @return NULL if the message was dropped,
- * otherwise handle to cancel *cont* (actual transmission may
- * not be abortable)
- */
struct GNUNET_HELPER_SendHandle *
GNUNET_HELPER_send (struct GNUNET_HELPER_Handle *h,
const struct GNUNET_MessageHeader *msg,
diff --git a/src/util/mst.c b/src/util/mst.c
index 2236f2883..264fdb979 100644
--- a/src/util/mst.c
+++ b/src/util/mst.c
@@ -96,20 +96,6 @@ GNUNET_MST_create (GNUNET_MessageTokenizerCallback cb,
}
-/**
- * Add incoming data to the receive buffer and call the
- * callback for all complete messages.
- *
- * @param mst tokenizer to use
- * @param buf input data to add
- * @param size number of bytes in @a buf
- * @param purge should any excess bytes in the buffer be discarded
- * (i.e. for packet-based services like UDP)
- * @param one_shot only call callback once, keep rest of message in buffer
- * @return #GNUNET_OK if we are done processing (need more data)
- * #GNUNET_NO if @a one_shot was set and we have another message ready
- * #GNUNET_SYSERR if the data stream is corrupt
- */
int
GNUNET_MST_from_buffer (struct GNUNET_MessageStreamTokenizer *mst,
const char *buf,
diff --git a/src/util/network.c b/src/util/network.c
index 2f77bc54e..7588033c4 100644
--- a/src/util/network.c
+++ b/src/util/network.c
@@ -561,11 +561,6 @@ GNUNET_NETWORK_socket_close (struct GNUNET_NETWORK_Handle
*desc)
}
-/**
- * Only free memory of a socket, keep the file descriptor untouched.
- *
- * @param desc socket
- */
void
GNUNET_NETWORK_socket_free_memory_only_ (struct GNUNET_NETWORK_Handle *desc)
{
@@ -688,16 +683,6 @@ GNUNET_NETWORK_socket_recvfrom_amount (const struct
GNUNET_NETWORK_Handle *desc)
}
-/**
- * Read data from a socket (always non-blocking).
- *
- * @param desc socket
- * @param buffer buffer
- * @param length length of @a buffer
- * @param src_addr either the source to recv from, or all zeroes
- * to be filled in by recvfrom
- * @param addrlen length of the @a src_addr
- */
ssize_t
GNUNET_NETWORK_socket_recvfrom (const struct GNUNET_NETWORK_Handle *desc,
void *buffer,
@@ -748,14 +733,6 @@ GNUNET_NETWORK_socket_recv (const struct
GNUNET_NETWORK_Handle *desc,
}
-/**
- * Send data (always non-blocking).
- *
- * @param desc socket
- * @param buffer data to send
- * @param length size of the @a buffer
- * @return number of bytes sent, #GNUNET_SYSERR on error
- */
ssize_t
GNUNET_NETWORK_socket_send (const struct GNUNET_NETWORK_Handle *desc,
const void *buffer,
diff --git a/src/util/os_installation.c b/src/util/os_installation.c
index 1835c6e84..7a348b42e 100644
--- a/src/util/os_installation.c
+++ b/src/util/os_installation.c
@@ -117,11 +117,6 @@ GNUNET_OS_project_data_get ()
}
-/**
- * Setup OS subsystem with project data.
- *
- * @param pd project data used to determine paths
- */
void
GNUNET_OS_init (const struct GNUNET_OS_ProjectData *pd)
{
diff --git a/src/util/os_priority.c b/src/util/os_priority.c
index 2ed49b5aa..e60273814 100644
--- a/src/util/os_priority.c
+++ b/src/util/os_priority.c
@@ -128,14 +128,6 @@ parent_control_handler (void *cls)
}
-/**
- * Task that connects this process to its parent via pipe;
- * essentially, the parent control handler will read signal numbers
- * from the #GNUNET_OS_CONTROL_PIPE (as given in an environment
- * variable) and raise those signals.
- *
- * @param cls closure (unused)
- */
void
GNUNET_OS_install_parent_control_handler (void *cls)
{
@@ -583,17 +575,6 @@ start_process (enum GNUNET_OS_InheritStdioFlags
std_inheritance,
}
-/**
- * Start a process.
- *
- * @param std_inheritance a set of GNUNET_OS_INHERIT_STD_* flags
- * @param pipe_stdin pipe to use to send input to child process (or NULL)
- * @param pipe_stdout pipe to use to get output from child process (or NULL)
- * @param pipe_stderr pipe to use to get output from child process (or NULL)
- * @param filename name of the binary
- * @param argv NULL-terminated array of arguments to the process
- * @return pointer to process structure of the new process, NULL on error
- */
struct GNUNET_OS_Process *
GNUNET_OS_start_process_vap (enum GNUNET_OS_InheritStdioFlags std_inheritance,
struct GNUNET_DISK_PipeHandle *pipe_stdin,
@@ -612,17 +593,6 @@ GNUNET_OS_start_process_vap (enum
GNUNET_OS_InheritStdioFlags std_inheritance,
}
-/**
- * Start a process.
- *
- * @param std_inheritance a set of GNUNET_OS_INHERIT_STD_* flags
- * @param pipe_stdin pipe to use to send input to child process (or NULL)
- * @param pipe_stdout pipe to use to get output from child process (or NULL)
- * @param pipe_stderr pipe to use to get output from child process (or NULL)
- * @param filename name of the binary
- * @param va NULL-terminated list of arguments to the process
- * @return pointer to process structure of the new process, NULL on error
- */
struct GNUNET_OS_Process *
GNUNET_OS_start_process_va (enum GNUNET_OS_InheritStdioFlags std_inheritance,
struct GNUNET_DISK_PipeHandle *pipe_stdin,
@@ -658,16 +628,6 @@ GNUNET_OS_start_process_va (enum
GNUNET_OS_InheritStdioFlags std_inheritance,
}
-/**
- * Start a process.
- *
- * @param std_inheritance a set of GNUNET_OS_INHERIT_STD_* flags
- * @param pipe_stdin pipe to use to send input to child process (or NULL)
- * @param pipe_stdout pipe to use to get output from child process (or NULL)
- * @param filename name of the binary
- * @param ... NULL-terminated list of arguments to the process
- * @return pointer to process structure of the new process, NULL on error
- */
struct GNUNET_OS_Process *
GNUNET_OS_start_process (enum GNUNET_OS_InheritStdioFlags std_inheritance,
struct GNUNET_DISK_PipeHandle *pipe_stdin,
@@ -1127,17 +1087,6 @@ cmd_read (void *cls)
}
-/**
- * Run the given command line and call the given function
- * for each line of the output.
- *
- * @param proc function to call for each line of the output
- * @param proc_cls closure for @a proc
- * @param timeout when to time out
- * @param binary command to run
- * @param ... arguments to command
- * @return NULL on error
- */
struct GNUNET_OS_CommandHandle *
GNUNET_OS_command_run (GNUNET_OS_LineProcessor proc,
void *proc_cls,
diff --git a/src/util/peer.c b/src/util/peer.c
index 257922f36..809efdcd5 100644
--- a/src/util/peer.c
+++ b/src/util/peer.c
@@ -152,12 +152,6 @@ GNUNET_PEER_intern (const struct GNUNET_PeerIdentity *pid)
}
-/**
- * Decrement multiple RCs of peer identities by one.
- *
- * @param ids array of PIDs to decrement the RCs of
- * @param count size of the ids array
- */
void
GNUNET_PEER_decrement_rcs (const GNUNET_PEER_Id *ids, unsigned int count)
{
@@ -235,12 +229,6 @@ GNUNET_PEER_resolve (GNUNET_PEER_Id id, struct
GNUNET_PeerIdentity *pid)
}
-/**
- * Convert an interned PID to a normal peer identity.
- *
- * @param id interned PID to convert
- * @return pointer to peer identity, valid as long 'id' is valid
- */
const struct GNUNET_PeerIdentity *
GNUNET_PEER_resolve2 (GNUNET_PEER_Id id)
{
diff --git a/src/util/regex.c b/src/util/regex.c
index fed325cd6..c2040a4b8 100644
--- a/src/util/regex.c
+++ b/src/util/regex.c
@@ -33,14 +33,6 @@
#define DOT "(0|1|2|3|4|5|6|7|8|9|A|B|C|D|E|F)"
-/**
- * Create a regex in @a rxstr from the given @a ip and @a netmask.
- *
- * @param ip IPv4 representation.
- * @param port destination port
- * @param rxstr generated regex, must be at least #GNUNET_TUN_IPV4_REGEXLEN
- * bytes long.
- */
void
GNUNET_TUN_ipv4toregexsearch (const struct in_addr *ip,
uint16_t port,
@@ -54,14 +46,6 @@ GNUNET_TUN_ipv4toregexsearch (const struct in_addr *ip,
}
-/**
- * Create a regex in @a rxstr from the given @a ipv6 and @a prefixlen.
- *
- * @param ipv6 IPv6 representation.
- * @param port destination port
- * @param rxstr generated regex, must be at least #GNUNET_TUN_IPV6_REGEXLEN
- * bytes long.
- */
void
GNUNET_TUN_ipv6toregexsearch (const struct in6_addr *ipv6,
uint16_t port,
@@ -694,15 +678,6 @@ ipv6_to_regex (const struct
GNUNET_STRINGS_IPv6NetworkPolicy *v6)
}
-/**
- * Convert an exit policy to a regular expression. The exit policy
- * specifies a set of subnets this peer is willing to serve as an
- * exit for; the resulting regular expression will match the
- * IPv4 address strings as returned by #GNUNET_TUN_ipv4toregexsearch().
- *
- * @param policy exit policy specification
- * @return regular expression, NULL on error
- */
char *
GNUNET_TUN_ipv4policy2regex (const char *policy)
{
@@ -746,15 +721,6 @@ GNUNET_TUN_ipv4policy2regex (const char *policy)
}
-/**
- * Convert an exit policy to a regular expression. The exit policy
- * specifies a set of subnets this peer is willing to serve as an
- * exit for; the resulting regular expression will match the
- * IPv6 address strings as returned by #GNUNET_TUN_ipv6toregexsearch().
- *
- * @param policy exit policy specification
- * @return regular expression, NULL on error
- */
char *
GNUNET_TUN_ipv6policy2regex (const char *policy)
{
@@ -802,14 +768,6 @@ GNUNET_TUN_ipv6policy2regex (const char *policy)
}
-/**
- * Hash the service name of a hosted service to the
- * hash code that is used to identify the service on
- * the network.
- *
- * @param service_name a string
- * @param hc corresponding hash
- */
void
GNUNET_TUN_service_name_to_hash (const char *service_name,
struct GNUNET_HashCode *hc)
diff --git a/src/util/scheduler.c b/src/util/scheduler.c
index 7e035ae3d..acae4d7e2 100644
--- a/src/util/scheduler.c
+++ b/src/util/scheduler.c
@@ -687,20 +687,6 @@ select_loop (struct GNUNET_SCHEDULER_Handle *sh,
struct DriverContext *context);
-/**
- * Initialize and run scheduler. This function will return when all
- * tasks have completed. On systems with signals, receiving a SIGTERM
- * (and other similar signals) will cause #GNUNET_SCHEDULER_shutdown()
- * to be run after the active task is complete. As a result, SIGTERM
- * causes all active tasks to be scheduled with reason
- * #GNUNET_SCHEDULER_REASON_SHUTDOWN. (However, tasks added
- * afterwards will execute normally!). Note that any particular signal
- * will only shut down one scheduler; applications should always only
- * create a single scheduler.
- *
- * @param task task to run immediately
- * @param task_cls closure of @a task
- */
void
GNUNET_SCHEDULER_run (GNUNET_SCHEDULER_TaskCallback task,
void *task_cls)
@@ -1345,20 +1331,6 @@ GNUNET_SCHEDULER_add_shutdown
(GNUNET_SCHEDULER_TaskCallback task,
}
-/**
- * Schedule a new task to be run as soon as possible with the
- * (transitive) ignore-shutdown flag either explicitly set or
- * explicitly enabled. This task (and all tasks created from it,
- * other than by another call to this function) will either count or
- * not count for the "lifeness" of the process. This API is only
- * useful in a few special cases.
- *
- * @param lifeness #GNUNET_YES if the task counts for lifeness, #GNUNET_NO if
not.
- * @param task main function of the task
- * @param task_cls closure of @a task
- * @return unique task identifier for the job
- * only valid until @a task is started!
- */
struct GNUNET_SCHEDULER_Task *
GNUNET_SCHEDULER_add_now_with_lifeness (int lifeness,
GNUNET_SCHEDULER_TaskCallback task,
diff --git a/src/util/service.c b/src/util/service.c
index c48060437..27183981e 100644
--- a/src/util/service.c
+++ b/src/util/service.c
@@ -743,7 +743,7 @@ service_client_recv (void *cls)
* setup the client (with the scheduler) and tell the application.
*
* @param sh service that accepted the client
- * @param sock socket associated with the client
+ * @param csock socket associated with the client
*/
static void
start_client (struct GNUNET_SERVICE_Handle *sh,
diff --git a/src/util/socks.c b/src/util/socks.c
index 5c9f8a5f8..a1990ec8b 100644
--- a/src/util/socks.c
+++ b/src/util/socks.c
@@ -516,7 +516,7 @@ GNUNET_SOCKS_init_handshake_noauth ()
* and port.
*
* @param ih SOCKS5 handshake
- * @param hostname
+ * @param host
* @param port
*/
void
diff --git a/src/util/speedup.c b/src/util/speedup.c
index 3d9e82319..82a8746a9 100644
--- a/src/util/speedup.c
+++ b/src/util/speedup.c
@@ -55,12 +55,6 @@ do_speedup (void *cls)
}
-/**
- * Start task that may speed up our system clock artificially
- *
- * @param cfg configuration to use
- * @return #GNUNET_OK on success, #GNUNET_SYSERR if the speedup was not
configured
- */
int
GNUNET_SPEEDUP_start_ (const struct GNUNET_CONFIGURATION_Handle *cfg)
{
diff --git a/src/util/tun.c b/src/util/tun.c
index d2b675c71..e22cf0be8 100644
--- a/src/util/tun.c
+++ b/src/util/tun.c
@@ -97,14 +97,6 @@ GNUNET_TUN_initialize_ipv6_header (struct
GNUNET_TUN_IPv6Header *ip,
}
-/**
- * Calculate IPv4 TCP checksum.
- *
- * @param ip ipv4 header fully initialized
- * @param tcp TCP header (initialized except for CRC)
- * @param payload the TCP payload
- * @param payload_length number of bytes of TCP payload
- */
void
GNUNET_TUN_calculate_tcp4_checksum (const struct GNUNET_TUN_IPv4Header *ip,
struct GNUNET_TUN_TcpHeader *tcp,
@@ -135,14 +127,6 @@ GNUNET_TUN_calculate_tcp4_checksum (const struct
GNUNET_TUN_IPv4Header *ip,
}
-/**
- * Calculate IPv6 TCP checksum.
- *
- * @param ip ipv6 header fully initialized
- * @param tcp header (initialized except for CRC)
- * @param payload the TCP payload
- * @param payload_length number of bytes of TCP payload
- */
void
GNUNET_TUN_calculate_tcp6_checksum (const struct GNUNET_TUN_IPv6Header *ip,
struct GNUNET_TUN_TcpHeader *tcp,
@@ -171,14 +155,6 @@ GNUNET_TUN_calculate_tcp6_checksum (const struct
GNUNET_TUN_IPv6Header *ip,
}
-/**
- * Calculate IPv4 UDP checksum.
- *
- * @param ip ipv4 header fully initialized
- * @param udp UDP header (initialized except for CRC)
- * @param payload the UDP payload
- * @param payload_length number of bytes of UDP payload
- */
void
GNUNET_TUN_calculate_udp4_checksum (const struct GNUNET_TUN_IPv4Header *ip,
struct GNUNET_TUN_UdpHeader *udp,
@@ -210,14 +186,6 @@ GNUNET_TUN_calculate_udp4_checksum (const struct
GNUNET_TUN_IPv4Header *ip,
}
-/**
- * Calculate IPv6 UDP checksum.
- *
- * @param ip ipv6 header fully initialized
- * @param udp UDP header (initialized except for CRC)
- * @param payload the UDP payload
- * @param payload_length number of bytes of UDP payload
- */
void
GNUNET_TUN_calculate_udp6_checksum (const struct GNUNET_TUN_IPv6Header *ip,
struct GNUNET_TUN_UdpHeader *udp,
@@ -249,13 +217,6 @@ GNUNET_TUN_calculate_udp6_checksum (const struct
GNUNET_TUN_IPv6Header *ip,
}
-/**
- * Calculate ICMP checksum.
- *
- * @param icmp IMCP header (initialized except for CRC)
- * @param payload the ICMP payload
- * @param payload_length number of bytes of ICMP payload
- */
void
GNUNET_TUN_calculate_icmp_checksum (struct GNUNET_TUN_IcmpHeader *icmp,
const void *payload,
diff --git a/src/vpn/gnunet-service-vpn.c b/src/vpn/gnunet-service-vpn.c
index b4233905f..a2a16e380 100644
--- a/src/vpn/gnunet-service-vpn.c
+++ b/src/vpn/gnunet-service-vpn.c
@@ -696,7 +696,7 @@ make_up_icmpv6_payload (struct ChannelState *ts,
* We got an ICMP packet back from the CADET channel. Check it is OK.
*
* @param cls our `struct ChannelState *`
- * @param message the actual message
+ * @param i2v the actual message
* @return #GNUNET_OK to keep the connection open,
* #GNUNET_SYSERR to close it (signal serious error)
*/
@@ -724,7 +724,7 @@ check_icmp_back (void *cls, const struct
GNUNET_EXIT_IcmpToVPNMessage *i2v)
* local virtual interface via the helper.
*
* @param cls our `struct ChannelState *`
- * @param message the actual message
+ * @param i2v the actual message
*/
static void
handle_icmp_back (void *cls, const struct GNUNET_EXIT_IcmpToVPNMessage *i2v)
diff --git a/src/vpn/vpn_api.c b/src/vpn/vpn_api.c
index 3f7d9d000..8a3464786 100644
--- a/src/vpn/vpn_api.c
+++ b/src/vpn/vpn_api.c
@@ -384,28 +384,6 @@ GNUNET_VPN_cancel_request (struct
GNUNET_VPN_RedirectionRequest *rr)
}
-/**
- * Tell the VPN that a forwarding to a particular peer offering a
- * particular service is requested. The VPN is to reserve a
- * particular IP for the redirection and return it. The VPN will
- * begin the redirection as soon as possible and maintain it as long
- * as it is actively used and keeping it is feasible. Given resource
- * limitations, the longest inactive mappings will be destroyed.
- *
- * @param vh VPN handle
- * @param result_af desired address family for the returned allocation
- * can also be AF_UNSPEC
- * @param protocol protocol, IPPROTO_UDP or IPPROTO_TCP
- * @param peer target peer for the redirection
- * @param serv service descriptor to give to the peer
- * @param expiration_time at what time should the redirection expire?
- * (this should not impact connections that are active at that time)
- * @param cb function to call with the IP
- * @param cb_cls closure for @a cb
- * @return handle to cancel the request (means the callback won't be
- * invoked anymore; the mapping may or may not be established
- * anyway)
- */
struct GNUNET_VPN_RedirectionRequest *
GNUNET_VPN_redirect_to_peer (struct GNUNET_VPN_Handle *vh,
int result_af,
--
To stop receiving notification emails like this one, please contact
gnunet@gnunet.org.
- [gnunet] branch master updated (4ca81ff1a -> baea2e9c4),
gnunet <=
- [gnunet] 02/90: -DOC: Pass through GNSRECORD library, gnunet, 2022/10/17
- [gnunet] 04/90: -DOC: Pass through PEERSTORE subsystem, gnunet, 2022/10/17
- [gnunet] 08/90: -DOC: Pass through NAT library, gnunet, 2022/10/17
- [gnunet] 06/90: -DOC: Pass through HELLO library, gnunet, 2022/10/17
- [gnunet] 05/90: -DOC: Pass through IDENTITY subsystem, gnunet, 2022/10/17
- [gnunet] 07/90: -DOC: Pass through UTIL libraries (HELPER, MST, NETWORK, OS, PEER), gnunet, 2022/10/17
- [gnunet] 03/90: -DOC: Pass through PEERINFO subsystem, gnunet, 2022/10/17
- [gnunet] 13/90: -DOC: Comment stripping pass in SETU subsystem, gnunet, 2022/10/17
- [gnunet] 21/90: -DOC: Comment stripping pass in REST service, gnunet, 2022/10/17
- [gnunet] 16/90: -DOC: Comment stripping pass in TESTBED logger subsystem, gnunet, 2022/10/17