gnunet-svn
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[GNUnet-SVN] r36814 - gnunet/src/include


From: gnunet
Subject: [GNUnet-SVN] r36814 - gnunet/src/include
Date: Fri, 15 Jan 2016 23:12:27 +0100

Author: tg
Date: 2016-01-15 23:12:27 +0100 (Fri, 15 Jan 2016)
New Revision: 36814

Modified:
   gnunet/src/include/gnunet_arm_service.h
   gnunet/src/include/gnunet_ats_service.h
   gnunet/src/include/gnunet_cadet_service.h
   gnunet/src/include/gnunet_client_lib.h
   gnunet/src/include/gnunet_common.h
   gnunet/src/include/gnunet_container_lib.h
   gnunet/src/include/gnunet_core_service.h
   gnunet/src/include/gnunet_crypto_lib.h
   gnunet/src/include/gnunet_dht_service.h
   gnunet/src/include/gnunet_dns_service.h
   gnunet/src/include/gnunet_fs_service.h
   gnunet/src/include/gnunet_gns_service.h
   gnunet/src/include/gnunet_gnsrecord_lib.h
   gnunet/src/include/gnunet_gnsrecord_plugin.h
   gnunet/src/include/gnunet_hello_lib.h
   gnunet/src/include/gnunet_identity_service.h
   gnunet/src/include/gnunet_mq_lib.h
   gnunet/src/include/gnunet_namecache_plugin.h
   gnunet/src/include/gnunet_namecache_service.h
   gnunet/src/include/gnunet_namestore_service.h
   gnunet/src/include/gnunet_nse_service.h
   gnunet/src/include/gnunet_peerinfo_service.h
   gnunet/src/include/gnunet_peerstore_service.h
   gnunet/src/include/gnunet_protocols.h
   gnunet/src/include/gnunet_regex_service.h
   gnunet/src/include/gnunet_revocation_service.h
   gnunet/src/include/gnunet_server_lib.h
   gnunet/src/include/gnunet_service_lib.h
   gnunet/src/include/gnunet_set_service.h
   gnunet/src/include/gnunet_statistics_service.h
   gnunet/src/include/gnunet_testbed_service.h
   gnunet/src/include/gnunet_testing_lib.h
   gnunet/src/include/gnunet_transport_service.h
   gnunet/src/include/gnunet_util_lib.h
Log:
doxygen: add documentation links

Modified: gnunet/src/include/gnunet_arm_service.h
===================================================================
--- gnunet/src/include/gnunet_arm_service.h     2016-01-12 23:26:47 UTC (rev 
36813)
+++ gnunet/src/include/gnunet_arm_service.h     2016-01-15 22:12:27 UTC (rev 
36814)
@@ -26,6 +26,9 @@
  *
  * @defgroup arm  ARM service
  * Automatic Restart Manager
+ *
+ * @see [Documentation](https://gnunet.org/arm)
+ *
  * @{
  */
 

Modified: gnunet/src/include/gnunet_ats_service.h
===================================================================
--- gnunet/src/include/gnunet_ats_service.h     2016-01-12 23:26:47 UTC (rev 
36813)
+++ gnunet/src/include/gnunet_ats_service.h     2016-01-15 22:12:27 UTC (rev 
36814)
@@ -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

Modified: gnunet/src/include/gnunet_cadet_service.h
===================================================================
--- gnunet/src/include/gnunet_cadet_service.h   2016-01-12 23:26:47 UTC (rev 
36813)
+++ gnunet/src/include/gnunet_cadet_service.h   2016-01-15 22:12:27 UTC (rev 
36814)
@@ -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)
  *
  * @{
  */

Modified: gnunet/src/include/gnunet_client_lib.h
===================================================================
--- gnunet/src/include/gnunet_client_lib.h      2016-01-12 23:26:47 UTC (rev 
36813)
+++ gnunet/src/include/gnunet_client_lib.h      2016-01-15 22:12:27 UTC (rev 
36814)
@@ -26,6 +26,9 @@
 
  * @defgroup client  Client library
  * Generic client-side communication with services
+ *
+ * @see [Documentation](https://gnunet.org/ipc)
+ *
  * @{
  */
 

Modified: gnunet/src/include/gnunet_common.h
===================================================================
--- gnunet/src/include/gnunet_common.h  2016-01-12 23:26:47 UTC (rev 36813)
+++ gnunet/src/include/gnunet_common.h  2016-01-15 22:12:27 UTC (rev 36814)
@@ -28,6 +28,8 @@
  * @author Nils Durner
  *
  * @defgroup logging Logging
+ * @see [Documentation](https://gnunet.org/logging)
+ *
  * @defgroup memory Memory management
  */
 #ifndef GNUNET_COMMON_H

Modified: gnunet/src/include/gnunet_container_lib.h
===================================================================
--- gnunet/src/include/gnunet_container_lib.h   2016-01-12 23:26:47 UTC (rev 
36813)
+++ gnunet/src/include/gnunet_container_lib.h   2016-01-15 22:12:27 UTC (rev 
36814)
@@ -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
  */

Modified: gnunet/src/include/gnunet_core_service.h
===================================================================
--- gnunet/src/include/gnunet_core_service.h    2016-01-12 23:26:47 UTC (rev 
36813)
+++ gnunet/src/include/gnunet_core_service.h    2016-01-15 22:12:27 UTC (rev 
36814)
@@ -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

Modified: gnunet/src/include/gnunet_crypto_lib.h
===================================================================
--- gnunet/src/include/gnunet_crypto_lib.h      2016-01-12 23:26:47 UTC (rev 
36813)
+++ gnunet/src/include/gnunet_crypto_lib.h      2016-01-15 22:12:27 UTC (rev 
36814)
@@ -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

Modified: gnunet/src/include/gnunet_dht_service.h
===================================================================
--- gnunet/src/include/gnunet_dht_service.h     2016-01-12 23:26:47 UTC (rev 
36813)
+++ gnunet/src/include/gnunet_dht_service.h     2016-01-15 22:12:27 UTC (rev 
36814)
@@ -26,6 +26,9 @@
  *
  * @defgroup dht  DHT service
  * Distributed Hash Table
+ *
+ * @see [Documentation](https://gnunet.org/developer-handbook-dht)
+ *
  * @{
  */
 

Modified: gnunet/src/include/gnunet_dns_service.h
===================================================================
--- gnunet/src/include/gnunet_dns_service.h     2016-01-12 23:26:47 UTC (rev 
36813)
+++ gnunet/src/include/gnunet_dns_service.h     2016-01-15 22:12:27 UTC (rev 
36814)
@@ -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

Modified: gnunet/src/include/gnunet_fs_service.h
===================================================================
--- gnunet/src/include/gnunet_fs_service.h      2016-01-12 23:26:47 UTC (rev 
36813)
+++ gnunet/src/include/gnunet_fs_service.h      2016-01-15 22:12:27 UTC (rev 
36814)
@@ -25,6 +25,9 @@
  *
  * @defgroup fs FS service
  * File sharing
+ *
+ * @see [Documentation](https://gnunet.org/file-sharing-service)
+ *
  * @{
  */
 #ifndef GNUNET_FS_LIB_H

Modified: gnunet/src/include/gnunet_gns_service.h
===================================================================
--- gnunet/src/include/gnunet_gns_service.h     2016-01-12 23:26:47 UTC (rev 
36813)
+++ gnunet/src/include/gnunet_gns_service.h     2016-01-15 22:12:27 UTC (rev 
36814)
@@ -26,6 +26,9 @@
  *
  * @defgroup gns  GNS service
  * GNU Name System
+ *
+ * @see [Documentation](https://gnunet.org/gns-implementation)
+ *
  * @{
  */
 #ifndef GNUNET_GNS_SERVICE_H

Modified: gnunet/src/include/gnunet_gnsrecord_lib.h
===================================================================
--- gnunet/src/include/gnunet_gnsrecord_lib.h   2016-01-12 23:26:47 UTC (rev 
36813)
+++ gnunet/src/include/gnunet_gnsrecord_lib.h   2016-01-15 22:12:27 UTC (rev 
36814)
@@ -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

Modified: gnunet/src/include/gnunet_gnsrecord_plugin.h
===================================================================
--- gnunet/src/include/gnunet_gnsrecord_plugin.h        2016-01-12 23:26:47 UTC 
(rev 36813)
+++ gnunet/src/include/gnunet_gnsrecord_plugin.h        2016-01-15 22:12:27 UTC 
(rev 36814)
@@ -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

Modified: gnunet/src/include/gnunet_hello_lib.h
===================================================================
--- gnunet/src/include/gnunet_hello_lib.h       2016-01-12 23:26:47 UTC (rev 
36813)
+++ gnunet/src/include/gnunet_hello_lib.h       2016-01-15 22:12:27 UTC (rev 
36814)
@@ -25,6 +25,9 @@
  *
  * @defgroup hello  Hello library
  * Helper library for handling HELLOs
+ *
+ * @see [Documentation](https://gnunet.org/gnunets-hostlist-subsystem)
+ *
  * @{
  */
 

Modified: gnunet/src/include/gnunet_identity_service.h
===================================================================
--- gnunet/src/include/gnunet_identity_service.h        2016-01-12 23:26:47 UTC 
(rev 36813)
+++ gnunet/src/include/gnunet_identity_service.h        2016-01-15 22:12:27 UTC 
(rev 36814)
@@ -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

Modified: gnunet/src/include/gnunet_mq_lib.h
===================================================================
--- gnunet/src/include/gnunet_mq_lib.h  2016-01-12 23:26:47 UTC (rev 36813)
+++ gnunet/src/include/gnunet_mq_lib.h  2016-01-15 22:12:27 UTC (rev 36814)
@@ -26,6 +26,9 @@
  *
  * @defgroup mq  MQ library
  * General-purpose message queue
+ *
+ * @see [Documentation](https://gnunet.org/message-queue-api)
+ *
  * @{
  */
 #ifndef GNUNET_MQ_H

Modified: gnunet/src/include/gnunet_namecache_plugin.h
===================================================================
--- gnunet/src/include/gnunet_namecache_plugin.h        2016-01-12 23:26:47 UTC 
(rev 36813)
+++ gnunet/src/include/gnunet_namecache_plugin.h        2016-01-15 22:12:27 UTC 
(rev 36814)
@@ -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

Modified: gnunet/src/include/gnunet_namecache_service.h
===================================================================
--- gnunet/src/include/gnunet_namecache_service.h       2016-01-12 23:26:47 UTC 
(rev 36813)
+++ gnunet/src/include/gnunet_namecache_service.h       2016-01-15 22:12:27 UTC 
(rev 36814)
@@ -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

Modified: gnunet/src/include/gnunet_namestore_service.h
===================================================================
--- gnunet/src/include/gnunet_namestore_service.h       2016-01-12 23:26:47 UTC 
(rev 36813)
+++ gnunet/src/include/gnunet_namestore_service.h       2016-01-15 22:12:27 UTC 
(rev 36814)
@@ -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

Modified: gnunet/src/include/gnunet_nse_service.h
===================================================================
--- gnunet/src/include/gnunet_nse_service.h     2016-01-12 23:26:47 UTC (rev 
36813)
+++ gnunet/src/include/gnunet_nse_service.h     2016-01-15 22:12:27 UTC (rev 
36814)
@@ -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)
+ *
  * @{
  */
 

Modified: gnunet/src/include/gnunet_peerinfo_service.h
===================================================================
--- gnunet/src/include/gnunet_peerinfo_service.h        2016-01-12 23:26:47 UTC 
(rev 36813)
+++ gnunet/src/include/gnunet_peerinfo_service.h        2016-01-15 22:12:27 UTC 
(rev 36814)
@@ -28,6 +28,8 @@
  *
  * Holds an in-memory structure of data/hosts.
  *
+ * @see [Documentation](https://gnunet.org/gnunets-peerinfo-subsystem)
+ *
  * @{
  */
 

Modified: gnunet/src/include/gnunet_peerstore_service.h
===================================================================
--- gnunet/src/include/gnunet_peerstore_service.h       2016-01-12 23:26:47 UTC 
(rev 36813)
+++ gnunet/src/include/gnunet_peerstore_service.h       2016-01-15 22:12:27 UTC 
(rev 36814)
@@ -26,6 +26,8 @@
  *
  * @defgroup peerstore  Peer Store service
  *
+ * @see [Documentation](https://gnunet.org/gnunets-peerstore-subsystem)
+ *
  * @{
  */
 #ifndef GNUNET_PEERSTORE_SERVICE_H

Modified: gnunet/src/include/gnunet_protocols.h
===================================================================
--- gnunet/src/include/gnunet_protocols.h       2016-01-12 23:26:47 UTC (rev 
36813)
+++ gnunet/src/include/gnunet_protocols.h       2016-01-15 22:12:27 UTC (rev 
36814)
@@ -26,6 +26,9 @@
  *
  * @defgroup protocols  Network protocol definitions
  * Types of messages used in GNUnet.
+ *
+ * @see [Documentation](https://gnunet.org/ipc)
+ *
  * @{
  */
 

Modified: gnunet/src/include/gnunet_regex_service.h
===================================================================
--- gnunet/src/include/gnunet_regex_service.h   2016-01-12 23:26:47 UTC (rev 
36813)
+++ gnunet/src/include/gnunet_regex_service.h   2016-01-15 22:12:27 UTC (rev 
36814)
@@ -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

Modified: gnunet/src/include/gnunet_revocation_service.h
===================================================================
--- gnunet/src/include/gnunet_revocation_service.h      2016-01-12 23:26:47 UTC 
(rev 36813)
+++ gnunet/src/include/gnunet_revocation_service.h      2016-01-15 22:12:27 UTC 
(rev 36814)
@@ -29,6 +29,9 @@
  *
  * @defgroup revocation  Revocation service
  * Perform and access key revocations.
+ *
+ * @see [Documentation](https://gnunet.org/revocation-subsystem)
+ *
  * @{
  */
 

Modified: gnunet/src/include/gnunet_server_lib.h
===================================================================
--- gnunet/src/include/gnunet_server_lib.h      2016-01-12 23:26:47 UTC (rev 
36813)
+++ gnunet/src/include/gnunet_server_lib.h      2016-01-15 22:12:27 UTC (rev 
36814)
@@ -29,6 +29,8 @@
  *
  * Provides functions for a server that communicates with clients.
  *
+ * @see [Documentation](https://gnunet.org/ipc)
+ *
  * @{
  */
 

Modified: gnunet/src/include/gnunet_service_lib.h
===================================================================
--- gnunet/src/include/gnunet_service_lib.h     2016-01-12 23:26:47 UTC (rev 
36813)
+++ gnunet/src/include/gnunet_service_lib.h     2016-01-15 22:12:27 UTC (rev 
36814)
@@ -26,6 +26,9 @@
  *
  * @defgroup service  Service library
  * Start service processes.
+ *
+ * @see [Documentation](https://gnunet.org/developer-handbook-util-services)
+ *
  * @{
  */
 

Modified: gnunet/src/include/gnunet_set_service.h
===================================================================
--- gnunet/src/include/gnunet_set_service.h     2016-01-12 23:26:47 UTC (rev 
36813)
+++ gnunet/src/include/gnunet_set_service.h     2016-01-15 22:12:27 UTC (rev 
36814)
@@ -27,6 +27,9 @@
  *
  * @defgroup set  Set service
  * Two-peer set operations
+ *
+ * @see [Documentation](https://gnunet.org/set-subsystem)
+ *
  * @{
  */
 

Modified: gnunet/src/include/gnunet_statistics_service.h
===================================================================
--- gnunet/src/include/gnunet_statistics_service.h      2016-01-12 23:26:47 UTC 
(rev 36813)
+++ gnunet/src/include/gnunet_statistics_service.h      2016-01-15 22:12:27 UTC 
(rev 36814)
@@ -31,6 +31,8 @@
  *
  * All statistical values must be of type `unsigned long long`.
  *
+ * @see [Documentation](https://gnunet.org/gnunet-statistics-subsystem)
+ *
  * @{
  */
 

Modified: gnunet/src/include/gnunet_testbed_service.h
===================================================================
--- gnunet/src/include/gnunet_testbed_service.h 2016-01-12 23:26:47 UTC (rev 
36813)
+++ gnunet/src/include/gnunet_testbed_service.h 2016-01-15 22:12:27 UTC (rev 
36814)
@@ -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)
+ *
  * @{
  */
 

Modified: gnunet/src/include/gnunet_testing_lib.h
===================================================================
--- gnunet/src/include/gnunet_testing_lib.h     2016-01-12 23:26:47 UTC (rev 
36813)
+++ gnunet/src/include/gnunet_testing_lib.h     2016-01-15 22:12:27 UTC (rev 
36814)
@@ -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)
+ *
  * @{
  */
 

Modified: gnunet/src/include/gnunet_transport_service.h
===================================================================
--- gnunet/src/include/gnunet_transport_service.h       2016-01-12 23:26:47 UTC 
(rev 36813)
+++ gnunet/src/include/gnunet_transport_service.h       2016-01-15 22:12:27 UTC 
(rev 36814)
@@ -26,6 +26,9 @@
  *
  * @defgroup transport  Transport service
  * Low-level P2P IO
+ *
+ * @see [Documentation](https://gnunet.org/transport-service)
+ *
  * @{
  */
 

Modified: gnunet/src/include/gnunet_util_lib.h
===================================================================
--- gnunet/src/include/gnunet_util_lib.h        2016-01-12 23:26:47 UTC (rev 
36813)
+++ gnunet/src/include/gnunet_util_lib.h        2016-01-15 22:12:27 UTC (rev 
36814)
@@ -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




reply via email to

[Prev in Thread] Current Thread [Next in Thread]