doxygen: add documentation links

diff --git a/src/include/gnunet_arm_service.h b/src/include/gnunet_arm_service.h
index d9712d57e130b83aeba7420ab928c7c6fea918e8..1c089497f636d73914e8d5b038ffb0800eef7714 100644 (file)
--- 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 9f57b57e16d729b42e9902cf88668c34d3dc236f..f5363ff0e5086af26e6f72ae8b539d4c725707c7 100644 (file)
--- 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 554bc1fdc033834f218fae06f38e4d05e856ae2e..922dc04037c12cda09db42c6a7fa52fe087a2b43 100644 (file)
--- 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 cdc184d06244de6312303d7d90a82c7d602f2f67..9b3a8c7feb0d612b059a6d7dcff3c8ec9f3ad807 100644 (file)
--- 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 e455f2082b5185e19f23f6388c565c15e86ca6f5..b69469be1ee622b8e7272bb356abc7793820f5d8 100644 (file)
--- 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 3ef64fbb79148e9c5476acc8b8e950636854d570..6f21be75bcff097168c4ca4e398af7e540c87afb 100644 (file)
--- 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 c7a0bd5e99f1d9851c53009ec25895c765d1f2df..8adb5d3d7b65141b6d8502c2c61325863ecfde42 100644 (file)
--- 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 4e6dc93ab99c8e03c2e07675e6aafed017dd4fa4..77b4d04524248e51342a8585a6556f4bb416307f 100644 (file)
--- 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 b8337fe54bef811ee2671de42045b7def91b7155..e31db94918528dbcaccf7be18bc10b828a3621ea 100644 (file)
--- 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 973964764b55a4a2b3d5ab2c2f5a44b8b223da86..4e8efb48867d75250debe336d62a94a9ef3107b6 100644 (file)
--- 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 9dfd1bad39ef63278674705e0687aed8feab9d01..6064dedba5950fd1144c2ed8212c67b89e702831 100644 (file)
--- 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 2d511755ee7bb15f41f508e7bc3c6d8452a95806..3593b70d097dcb87f03329a09e69cc879dcf181f 100644 (file)
--- 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 2a025b3ac2ac6bfa5d1c0fea52269f8ca2e3c70d..83e3df3741458561fe9981758ad4ded5d1a6dfc5 100644 (file)
--- 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 e35e0997b4c34c554ee64e361a3e0e17a2d95962..abcab59bdfb6cd3da035beb8c04dbd0f2892269c 100644 (file)
--- 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 81beaa75e6b614a08cb993d6decd780e5c48c7f9..5c1dcc98cb58ccd9b13f9dcf1922604ba17b95d7 100644 (file)
--- 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 fa39a33d77b276ea4283a14e4b7a265b675e85a2..43b84f28114555fab268538ac6607517e0de059b 100644 (file)
--- 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 54559a77d4475f45ca47ec09db36ec927c76ec22..81ddc4bb845edda7d2ef4ec551df9982e7906703 100644 (file)
--- 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 31a235b66bcbe6c17bab29e1e89183eab1d32d2e..c2892cd67bd3b63c0171e22156613a1b1725cf74 100644 (file)
--- 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 da0e53859fba13fd3838f52f74632a7e5b810de7..5cb06199fbe159ca40d11dfe6106bee8dee2587c 100644 (file)
--- 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 b1cb8124069393e8505ed6390374eac828e1c8bf..5cfe4d08a91c716e9f6059c58ae14b905ca6652a 100644 (file)
--- 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 91a185992034bd194c942f7c5fe19c9fc820e18f..3b8cb975e3ef772ca63f9681b27a7b8358a93df3 100644 (file)
--- 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 b1996b3e6fb20cdd67fd0aac325ba6986ff21e9a..35ef54d5ef5a1b67eff3355a4f7780037304e24b 100644 (file)
--- 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 7520efad13e2ebfca8ebef1492c069c42eb2763a..63ec0167b8ee1aa653ca11436025820a6c9bf581 100644 (file)
--- 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 de029aeae155159d47e62f11facd8f0e6332e48e..0251c57fedfcd167b83f8d15799a74f240287889 100644 (file)
--- 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 67cf2106f9d4935d285e564947112a9d9735c0c3..b8ada69503cf48852360baf39d51965317a50598 100644 (file)
--- 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 d25e95404553330722d126e9607103dbf7220d64..afb8ccc6fbaf93b0189be10e535f0c095a750e37 100644 (file)
--- 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 86b2d9de7d20f2a3996f61830e9595bb584526ee..821305c5a43c3572453c94425ed9dd82aeac19d0 100644 (file)
--- 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 589ea0270a013b0f78f4cef73804f0efedd037ca..bf05293a2d3b69050cf263331ab942a107902834 100644 (file)
--- 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 75dc6049e54d8fdea4093d031f666842875bd9de..b734657be7eba431851920b1c405fc2ff9d6ee0c 100644 (file)
--- 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 7e6b969e234a99949c5529740d825474c59757df..2f33d29bd821d50f7922cc1dc4b15b564875126b 100644 (file)
--- 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 04d7e93d68527412b3a314c31613260c8b922b9d..4fbda3667e631dad6140060e643a70f959d51986 100644 (file)
--- 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 616125adcdce53c5de694f6b6526d7d99692b0a2..3cb371b714f094a4e8b80f921c66df2c805e5c12 100644 (file)
--- 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 750330665fbc632ada26ee20fb4589d20b6bfcd5..09651052e77c88853cc2af629b4ec42c261a5f80 100644 (file)
--- 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 c2e18dd7c2b025cd9a7ee7f8a8a930e682a28cbe..b886953e7e3c8ff814e7957bf85fb642d77f009c 100644 (file)
--- 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