From: Gabor X Toth <*@tg-x.net> Date: Fri, 15 Jan 2016 22:12:27 +0000 (+0000) Subject: doxygen: add documentation links X-Git-Tag: initial-import-from-subversion-38251~1061 X-Git-Url: https://git.librecmc.org/?a=commitdiff_plain;h=61e8794662ce2fc6ca669906822840a3743b4b78;p=oweals%2Fgnunet.git doxygen: add documentation links --- diff --git a/src/include/gnunet_arm_service.h b/src/include/gnunet_arm_service.h index d9712d57e..1c089497f 100644 --- a/src/include/gnunet_arm_service.h +++ b/src/include/gnunet_arm_service.h @@ -26,6 +26,9 @@ * * @defgroup arm ARM service * Automatic Restart Manager + * + * @see [Documentation](https://gnunet.org/arm) + * * @{ */ diff --git a/src/include/gnunet_ats_service.h b/src/include/gnunet_ats_service.h index 9f57b57e1..f5363ff0e 100644 --- a/src/include/gnunet_ats_service.h +++ b/src/include/gnunet_ats_service.h @@ -26,6 +26,9 @@ * * @defgroup ats ATS service * Automatic Transport Selection and outbound bandwidth determination + * + * @see [Documentation](https://gnunet.org/ats-subsystem) + * * @{ */ #ifndef GNUNET_ATS_SERVICE_H diff --git a/src/include/gnunet_cadet_service.h b/src/include/gnunet_cadet_service.h index 554bc1fdc..922dc0403 100644 --- a/src/include/gnunet_cadet_service.h +++ b/src/include/gnunet_cadet_service.h @@ -27,9 +27,8 @@ * @defgroup cadet CADET service * Confidential Ad-hoc Decentralized End-to-End Transport * - * See also: - * - [CADET documentation](https://gnunet.org/cadet-subsystem) - * - [CADET paper](https://gnunet.org/cadet) + * @see [Documentation](https://gnunet.org/cadet-subsystem) + * @see [Paper](https://gnunet.org/cadet) * * @{ */ diff --git a/src/include/gnunet_client_lib.h b/src/include/gnunet_client_lib.h index cdc184d06..9b3a8c7fe 100644 --- a/src/include/gnunet_client_lib.h +++ b/src/include/gnunet_client_lib.h @@ -26,6 +26,9 @@ * @defgroup client Client library * Generic client-side communication with services + * + * @see [Documentation](https://gnunet.org/ipc) + * * @{ */ diff --git a/src/include/gnunet_common.h b/src/include/gnunet_common.h index e455f2082..b69469be1 100644 --- a/src/include/gnunet_common.h +++ b/src/include/gnunet_common.h @@ -28,6 +28,8 @@ * @author Nils Durner * * @defgroup logging Logging + * @see [Documentation](https://gnunet.org/logging) + * * @defgroup memory Memory management */ #ifndef GNUNET_COMMON_H diff --git a/src/include/gnunet_container_lib.h b/src/include/gnunet_container_lib.h index 3ef64fbb7..6f21be75b 100644 --- a/src/include/gnunet_container_lib.h +++ b/src/include/gnunet_container_lib.h @@ -28,6 +28,8 @@ * @defgroup hashmap Container library: MultiHashMap * Hash map with multiple values per key. * + * @see [Documentation](https://gnunet.org/util_multihashmap) + * * @defgroup heap Container library: Heap * Min- or max-heap with arbitrary element removal * @@ -36,6 +38,8 @@ * * @defgroup dll Container library: Doubly-linked list * + * @see [Documentation](https://gnunet.org/mdll-api) + * * @defgroup metadata Container library: Metadata * GNU libextractor key-value pairs */ diff --git a/src/include/gnunet_core_service.h b/src/include/gnunet_core_service.h index c7a0bd5e9..8adb5d3d7 100644 --- a/src/include/gnunet_core_service.h +++ b/src/include/gnunet_core_service.h @@ -25,6 +25,9 @@ * * @defgroup core Core service * Encrypted direct communication between peers + * + * @see [Documentation](https://gnunet.org/gnunet-core-subsystem) + * * @{ */ #ifndef GNUNET_CORE_SERVICE_H diff --git a/src/include/gnunet_crypto_lib.h b/src/include/gnunet_crypto_lib.h index 4e6dc93ab..77b4d0452 100644 --- a/src/include/gnunet_crypto_lib.h +++ b/src/include/gnunet_crypto_lib.h @@ -29,9 +29,14 @@ * @author Tzvetan Horozov * * @defgroup crypto Crypto library: cryptographic operations + * Provides cryptographic primitives. + * + * @see [Documentation](https://gnunet.org/crypto-api) * * @defgroup hash Crypto library: hash operations - * Hashing and operations on hashes + * Provides hashing and operations on hashes. + * + * @see [Documentation](https://gnunet.org/crypto-api) */ #ifndef GNUNET_CRYPTO_LIB_H diff --git a/src/include/gnunet_dht_service.h b/src/include/gnunet_dht_service.h index b8337fe54..e31db9491 100644 --- a/src/include/gnunet_dht_service.h +++ b/src/include/gnunet_dht_service.h @@ -26,6 +26,9 @@ * * @defgroup dht DHT service * Distributed Hash Table + * + * @see [Documentation](https://gnunet.org/developer-handbook-dht) + * * @{ */ diff --git a/src/include/gnunet_dns_service.h b/src/include/gnunet_dns_service.h index 973964764..4e8efb488 100644 --- a/src/include/gnunet_dns_service.h +++ b/src/include/gnunet_dns_service.h @@ -25,6 +25,9 @@ * API to access the DNS service. * * @defgroup dns DNS service + * + * @see [Documentation](https://gnunet.org/gnunet-service-dns) + * * @{ */ #ifndef GNUNET_DNS_SERVICE_H diff --git a/src/include/gnunet_fs_service.h b/src/include/gnunet_fs_service.h index 9dfd1bad3..6064dedba 100644 --- a/src/include/gnunet_fs_service.h +++ b/src/include/gnunet_fs_service.h @@ -25,6 +25,9 @@ * * @defgroup fs FS service * File sharing + * + * @see [Documentation](https://gnunet.org/file-sharing-service) + * * @{ */ #ifndef GNUNET_FS_LIB_H diff --git a/src/include/gnunet_gns_service.h b/src/include/gnunet_gns_service.h index 2d511755e..3593b70d0 100644 --- a/src/include/gnunet_gns_service.h +++ b/src/include/gnunet_gns_service.h @@ -26,6 +26,9 @@ * * @defgroup gns GNS service * GNU Name System + * + * @see [Documentation](https://gnunet.org/gns-implementation) + * * @{ */ #ifndef GNUNET_GNS_SERVICE_H diff --git a/src/include/gnunet_gnsrecord_lib.h b/src/include/gnunet_gnsrecord_lib.h index 2a025b3ac..83e3df374 100644 --- a/src/include/gnunet_gnsrecord_lib.h +++ b/src/include/gnunet_gnsrecord_lib.h @@ -26,6 +26,9 @@ * * @defgroup gnsrecord GNS Record library * Manipulate GNS record data + * + * @see [Documentation](https://gnunet.org/gns-plugins) + * * @{ */ #ifndef GNUNET_GNSRECORD_LIB_H diff --git a/src/include/gnunet_gnsrecord_plugin.h b/src/include/gnunet_gnsrecord_plugin.h index e35e0997b..abcab59bd 100644 --- a/src/include/gnunet_gnsrecord_plugin.h +++ b/src/include/gnunet_gnsrecord_plugin.h @@ -26,6 +26,9 @@ * * @defgroup gnsrecord-plugin GNS Record plugin API * To be implemented by applications defining new record types. + * + * @see [Documentation](https://gnunet.org/gns-plugins) + * * @{ */ #ifndef GNUNET_GNSRECORD_PLUGIN_H diff --git a/src/include/gnunet_hello_lib.h b/src/include/gnunet_hello_lib.h index 81beaa75e..5c1dcc98c 100644 --- a/src/include/gnunet_hello_lib.h +++ b/src/include/gnunet_hello_lib.h @@ -25,6 +25,9 @@ * * @defgroup hello Hello library * Helper library for handling HELLOs + * + * @see [Documentation](https://gnunet.org/gnunets-hostlist-subsystem) + * * @{ */ diff --git a/src/include/gnunet_identity_service.h b/src/include/gnunet_identity_service.h index fa39a33d7..43b84f281 100644 --- a/src/include/gnunet_identity_service.h +++ b/src/include/gnunet_identity_service.h @@ -35,6 +35,8 @@ * (public keys). For giving names to other users and manage their * public keys securely, we use GNS. * + * @see [Documentation](https://gnunet.org/identity-subsystem) + * * @{ */ #ifndef GNUNET_IDENTITY_SERVICE_H diff --git a/src/include/gnunet_mq_lib.h b/src/include/gnunet_mq_lib.h index 54559a77d..81ddc4bb8 100644 --- a/src/include/gnunet_mq_lib.h +++ b/src/include/gnunet_mq_lib.h @@ -26,6 +26,9 @@ * * @defgroup mq MQ library * General-purpose message queue + * + * @see [Documentation](https://gnunet.org/message-queue-api) + * * @{ */ #ifndef GNUNET_MQ_H diff --git a/src/include/gnunet_namecache_plugin.h b/src/include/gnunet_namecache_plugin.h index 31a235b66..c2892cd67 100644 --- a/src/include/gnunet_namecache_plugin.h +++ b/src/include/gnunet_namecache_plugin.h @@ -26,6 +26,9 @@ * * @defgroup namecache-plugin Name Cache service plugin API * Plugin API for the namecache database backend. + * + * @see [Documentation](https://gnunet.org/namecache-plugin-api) + * * @{ */ #ifndef GNUNET_NAMECACHE_PLUGIN_H diff --git a/src/include/gnunet_namecache_service.h b/src/include/gnunet_namecache_service.h index da0e53859..5cb06199f 100644 --- a/src/include/gnunet_namecache_service.h +++ b/src/include/gnunet_namecache_service.h @@ -31,6 +31,8 @@ * authoritative, or blocks which are cached, encrypted naming data from other * peers. * + * @see [Documentation](https://gnunet.org/namecache-subsystem) + * * @{ */ #ifndef GNUNET_NAMECACHE_SERVICE_H diff --git a/src/include/gnunet_namestore_service.h b/src/include/gnunet_namestore_service.h index b1cb81240..5cfe4d08a 100644 --- a/src/include/gnunet_namestore_service.h +++ b/src/include/gnunet_namestore_service.h @@ -31,6 +31,8 @@ * authoritative, or blocks which are cached, encrypted naming data from other * peers. * + * @see [Documentation](https://gnunet.org/namestore-subsystem) + * * @{ */ #ifndef GNUNET_NAMESTORE_SERVICE_H diff --git a/src/include/gnunet_nse_service.h b/src/include/gnunet_nse_service.h index 91a185992..3b8cb975e 100644 --- a/src/include/gnunet_nse_service.h +++ b/src/include/gnunet_nse_service.h @@ -34,6 +34,8 @@ * also to register for notifications whenever a new * network size estimate is calculated. * + * @see [Documentation](https://gnunet.org/gnunet-nse-subsystem) + * * @{ */ diff --git a/src/include/gnunet_peerinfo_service.h b/src/include/gnunet_peerinfo_service.h index b1996b3e6..35ef54d5e 100644 --- a/src/include/gnunet_peerinfo_service.h +++ b/src/include/gnunet_peerinfo_service.h @@ -28,6 +28,8 @@ * * Holds an in-memory structure of data/hosts. * + * @see [Documentation](https://gnunet.org/gnunets-peerinfo-subsystem) + * * @{ */ diff --git a/src/include/gnunet_peerstore_service.h b/src/include/gnunet_peerstore_service.h index 7520efad1..63ec0167b 100644 --- a/src/include/gnunet_peerstore_service.h +++ b/src/include/gnunet_peerstore_service.h @@ -26,6 +26,8 @@ * * @defgroup peerstore Peer Store service * + * @see [Documentation](https://gnunet.org/gnunets-peerstore-subsystem) + * * @{ */ #ifndef GNUNET_PEERSTORE_SERVICE_H diff --git a/src/include/gnunet_protocols.h b/src/include/gnunet_protocols.h index de029aeae..0251c57fe 100644 --- a/src/include/gnunet_protocols.h +++ b/src/include/gnunet_protocols.h @@ -26,6 +26,9 @@ * * @defgroup protocols Network protocol definitions * Types of messages used in GNUnet. + * + * @see [Documentation](https://gnunet.org/ipc) + * * @{ */ diff --git a/src/include/gnunet_regex_service.h b/src/include/gnunet_regex_service.h index 67cf2106f..b8ada6950 100644 --- a/src/include/gnunet_regex_service.h +++ b/src/include/gnunet_regex_service.h @@ -29,6 +29,8 @@ * Advertise capabilities via RegEx and discover * respective peers using matching strings. * + * @see [Documentation](https://gnunet.org/regex) + * * @{ */ #ifndef GNUNET_REGEX_SERVICE_H diff --git a/src/include/gnunet_revocation_service.h b/src/include/gnunet_revocation_service.h index d25e95404..afb8ccc6f 100644 --- a/src/include/gnunet_revocation_service.h +++ b/src/include/gnunet_revocation_service.h @@ -29,6 +29,9 @@ * * @defgroup revocation Revocation service * Perform and access key revocations. + * + * @see [Documentation](https://gnunet.org/revocation-subsystem) + * * @{ */ diff --git a/src/include/gnunet_server_lib.h b/src/include/gnunet_server_lib.h index 86b2d9de7..821305c5a 100644 --- a/src/include/gnunet_server_lib.h +++ b/src/include/gnunet_server_lib.h @@ -29,6 +29,8 @@ * * Provides functions for a server that communicates with clients. * + * @see [Documentation](https://gnunet.org/ipc) + * * @{ */ diff --git a/src/include/gnunet_service_lib.h b/src/include/gnunet_service_lib.h index 589ea0270..bf05293a2 100644 --- a/src/include/gnunet_service_lib.h +++ b/src/include/gnunet_service_lib.h @@ -26,6 +26,9 @@ * * @defgroup service Service library * Start service processes. + * + * @see [Documentation](https://gnunet.org/developer-handbook-util-services) + * * @{ */ diff --git a/src/include/gnunet_set_service.h b/src/include/gnunet_set_service.h index 75dc6049e..b734657be 100644 --- a/src/include/gnunet_set_service.h +++ b/src/include/gnunet_set_service.h @@ -27,6 +27,9 @@ * * @defgroup set Set service * Two-peer set operations + * + * @see [Documentation](https://gnunet.org/set-subsystem) + * * @{ */ diff --git a/src/include/gnunet_statistics_service.h b/src/include/gnunet_statistics_service.h index 7e6b969e2..2f33d29bd 100644 --- a/src/include/gnunet_statistics_service.h +++ b/src/include/gnunet_statistics_service.h @@ -31,6 +31,8 @@ * * All statistical values must be of type `unsigned long long`. * + * @see [Documentation](https://gnunet.org/gnunet-statistics-subsystem) + * * @{ */ diff --git a/src/include/gnunet_testbed_service.h b/src/include/gnunet_testbed_service.h index 04d7e93d6..4fbda3667 100644 --- a/src/include/gnunet_testbed_service.h +++ b/src/include/gnunet_testbed_service.h @@ -26,6 +26,9 @@ * * @defgroup testbed Testbed service * Writing tests and creating large-scale emulation testbeds for GNUnet. + * + * @see [Documentation](https://gnunet.org/gnunet-testbed-subsystem) + * * @{ */ diff --git a/src/include/gnunet_testing_lib.h b/src/include/gnunet_testing_lib.h index 616125adc..3cb371b71 100644 --- a/src/include/gnunet_testing_lib.h +++ b/src/include/gnunet_testing_lib.h @@ -33,6 +33,8 @@ * management or distributed testbed maintenance (those are provided by the * [Testbed service](@ref testbed)) * + * @see [Documentation](https://gnunet.org/writing_testcases) + * * @{ */ diff --git a/src/include/gnunet_transport_service.h b/src/include/gnunet_transport_service.h index 750330665..09651052e 100644 --- a/src/include/gnunet_transport_service.h +++ b/src/include/gnunet_transport_service.h @@ -26,6 +26,9 @@ * * @defgroup transport Transport service * Low-level P2P IO + * + * @see [Documentation](https://gnunet.org/transport-service) + * * @{ */ diff --git a/src/include/gnunet_util_lib.h b/src/include/gnunet_util_lib.h index c2e18dd7c..b886953e7 100644 --- a/src/include/gnunet_util_lib.h +++ b/src/include/gnunet_util_lib.h @@ -23,6 +23,8 @@ * * @file * Convenience header including all headers of subsystems in the gnunet_util library + * + * @see [Documentation](https://gnunet.org/libgnuneutil) */ #ifndef GNUNET_UTIL_LIB_H