aboutsummaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorGabor X Toth <*@tg-x.net>2016-01-15 22:12:27 +0000
committerGabor X Toth <*@tg-x.net>2016-01-15 22:12:27 +0000
commit61e8794662ce2fc6ca669906822840a3743b4b78 (patch)
tree1d774b5430a744416ab46b0d50245770da791bfe /src
parent50eaf8d7de763d25b7dae7ffdee8d7c6b5fe71ea (diff)
doxygen: add documentation links
Diffstat (limited to 'src')
-rw-r--r--src/include/gnunet_arm_service.h3
-rw-r--r--src/include/gnunet_ats_service.h3
-rw-r--r--src/include/gnunet_cadet_service.h5
-rw-r--r--src/include/gnunet_client_lib.h3
-rw-r--r--src/include/gnunet_common.h2
-rw-r--r--src/include/gnunet_container_lib.h4
-rw-r--r--src/include/gnunet_core_service.h3
-rw-r--r--src/include/gnunet_crypto_lib.h7
-rw-r--r--src/include/gnunet_dht_service.h3
-rw-r--r--src/include/gnunet_dns_service.h3
-rw-r--r--src/include/gnunet_fs_service.h3
-rw-r--r--src/include/gnunet_gns_service.h3
-rw-r--r--src/include/gnunet_gnsrecord_lib.h3
-rw-r--r--src/include/gnunet_gnsrecord_plugin.h3
-rw-r--r--src/include/gnunet_hello_lib.h3
-rw-r--r--src/include/gnunet_identity_service.h2
-rw-r--r--src/include/gnunet_mq_lib.h3
-rw-r--r--src/include/gnunet_namecache_plugin.h3
-rw-r--r--src/include/gnunet_namecache_service.h2
-rw-r--r--src/include/gnunet_namestore_service.h2
-rw-r--r--src/include/gnunet_nse_service.h2
-rw-r--r--src/include/gnunet_peerinfo_service.h2
-rw-r--r--src/include/gnunet_peerstore_service.h2
-rw-r--r--src/include/gnunet_protocols.h3
-rw-r--r--src/include/gnunet_regex_service.h2
-rw-r--r--src/include/gnunet_revocation_service.h3
-rw-r--r--src/include/gnunet_server_lib.h2
-rw-r--r--src/include/gnunet_service_lib.h3
-rw-r--r--src/include/gnunet_set_service.h3
-rw-r--r--src/include/gnunet_statistics_service.h2
-rw-r--r--src/include/gnunet_testbed_service.h3
-rw-r--r--src/include/gnunet_testing_lib.h2
-rw-r--r--src/include/gnunet_transport_service.h3
-rw-r--r--src/include/gnunet_util_lib.h2
34 files changed, 93 insertions, 4 deletions
diff --git a/src/include/gnunet_arm_service.h b/src/include/gnunet_arm_service.h
index d9712d57e1..1c089497f6 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 9f57b57e16..f5363ff0e5 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 554bc1fdc0..922dc04037 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 cdc184d062..9b3a8c7feb 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 e455f2082b..b69469be1e 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 3ef64fbb79..6f21be75bc 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 c7a0bd5e99..8adb5d3d7b 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 4e6dc93ab9..77b4d04524 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 b8337fe54b..e31db94918 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 973964764b..4e8efb4886 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 9dfd1bad39..6064dedba5 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 2d511755ee..3593b70d09 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 2a025b3ac2..83e3df3741 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 e35e0997b4..abcab59bdf 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 81beaa75e6..5c1dcc98cb 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 fa39a33d77..43b84f2811 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 54559a77d4..81ddc4bb84 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 31a235b66b..c2892cd67b 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 da0e53859f..5cb06199fb 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 b1cb812406..5cfe4d08a9 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 91a1859920..3b8cb975e3 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 b1996b3e6f..35ef54d5ef 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 7520efad13..63ec0167b8 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 de029aeae1..0251c57fed 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 67cf2106f9..b8ada69503 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 d25e954045..afb8ccc6fb 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 86b2d9de7d..821305c5a4 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 589ea0270a..bf05293a2d 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 75dc6049e5..b734657be7 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 7e6b969e23..2f33d29bd8 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 04d7e93d68..4fbda3667e 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 616125adcd..3cb371b714 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 750330665f..09651052e7 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 c2e18dd7c2..b886953e7e 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