diff options
author | Gabor X Toth <*@tg-x.net> | 2016-01-11 21:23:17 +0000 |
---|---|---|
committer | Gabor X Toth <*@tg-x.net> | 2016-01-11 21:23:17 +0000 |
commit | b23f7bcde58fdada9170f16af39ab1e84f4c3a68 (patch) | |
tree | 7b41d9839d854eef7ebd6b93fa161c55221a6577 /src | |
parent | 1e53d26243bc986844a7b5b53bedeefb61dd7960 (diff) | |
download | gnunet-b23f7bcde58fdada9170f16af39ab1e84f4c3a68.tar.gz gnunet-b23f7bcde58fdada9170f16af39ab1e84f4c3a68.zip |
doxygen: group/module definitions (part 1)
Diffstat (limited to 'src')
60 files changed, 642 insertions, 197 deletions
diff --git a/src/include/block_dns.h b/src/include/block_dns.h index 459f4b2c0..e43036a48 100644 --- a/src/include/block_dns.h +++ b/src/include/block_dns.h | |||
@@ -19,7 +19,9 @@ | |||
19 | */ | 19 | */ |
20 | 20 | ||
21 | /** | 21 | /** |
22 | * @file include/block_dns.h | 22 | * @file |
23 | * DNS network structs | ||
24 | * | ||
23 | * @author Christian Grothoff | 25 | * @author Christian Grothoff |
24 | */ | 26 | */ |
25 | #ifndef BLOCK_DNS_H | 27 | #ifndef BLOCK_DNS_H |
diff --git a/src/include/block_fs.h b/src/include/block_fs.h index 0af504627..15610d333 100644 --- a/src/include/block_fs.h +++ b/src/include/block_fs.h | |||
@@ -19,8 +19,9 @@ | |||
19 | */ | 19 | */ |
20 | 20 | ||
21 | /** | 21 | /** |
22 | * @file include/block_fs.h | 22 | * @file |
23 | * @brief fs block formats (shared between fs and block) | 23 | * FS block formats (shared between FS and Block) |
24 | * | ||
24 | * @author Christian Grothoff | 25 | * @author Christian Grothoff |
25 | */ | 26 | */ |
26 | #ifndef BLOCK_FS_H | 27 | #ifndef BLOCK_FS_H |
diff --git a/src/include/block_regex.h b/src/include/block_regex.h index e8f8cf757..901cc4565 100644 --- a/src/include/block_regex.h +++ b/src/include/block_regex.h | |||
@@ -19,8 +19,9 @@ | |||
19 | */ | 19 | */ |
20 | 20 | ||
21 | /** | 21 | /** |
22 | * @file include/block_regex.h | 22 | * @file |
23 | * @brief regex block formats | 23 | * regex block formats |
24 | * | ||
24 | * @author Bartlomiej Polot | 25 | * @author Bartlomiej Polot |
25 | */ | 26 | */ |
26 | #ifndef BLOCK_REGEX_H | 27 | #ifndef BLOCK_REGEX_H |
diff --git a/src/include/gauger.h b/src/include/gauger.h index 10ada9065..54ba7f1f7 100644 --- a/src/include/gauger.h +++ b/src/include/gauger.h | |||
@@ -1,4 +1,4 @@ | |||
1 | /** --------------------------------------------------------------------------- | 1 | /* --------------------------------------------------------------------------- |
2 | * This software is in the public domain, furnished "as is", without technical | 2 | * This software is in the public domain, furnished "as is", without technical |
3 | * support, and with no warranty, express or implied, as to its usefulness for | 3 | * support, and with no warranty, express or implied, as to its usefulness for |
4 | * any purpose. | 4 | * any purpose. |
diff --git a/src/include/gnunet_applications.h b/src/include/gnunet_applications.h index 067a72f38..0c8837bd4 100644 --- a/src/include/gnunet_applications.h +++ b/src/include/gnunet_applications.h | |||
@@ -19,8 +19,9 @@ | |||
19 | */ | 19 | */ |
20 | 20 | ||
21 | /** | 21 | /** |
22 | * @file include/gnunet_applications.h | 22 | * @file |
23 | * @brief constants for network applications operating on top of the CADET service | 23 | * Constants for network applications operating on top of the CADET service |
24 | * | ||
24 | * @author Christian Grothoff | 25 | * @author Christian Grothoff |
25 | */ | 26 | */ |
26 | 27 | ||
diff --git a/src/include/gnunet_arm_service.h b/src/include/gnunet_arm_service.h index 6b1682710..b2d234c59 100644 --- a/src/include/gnunet_arm_service.h +++ b/src/include/gnunet_arm_service.h | |||
@@ -19,9 +19,14 @@ | |||
19 | */ | 19 | */ |
20 | 20 | ||
21 | /** | 21 | /** |
22 | * @file include/gnunet_arm_service.h | ||
23 | * @brief API to access gnunet-arm | ||
24 | * @author Christian Grothoff | 22 | * @author Christian Grothoff |
23 | * | ||
24 | * @file | ||
25 | * API to access gnunet-arm | ||
26 | * | ||
27 | * @defgroup arm ARM service | ||
28 | * Automatic Restart Manager | ||
29 | * @{ | ||
25 | */ | 30 | */ |
26 | 31 | ||
27 | #ifndef GNUNET_ARM_SERVICE_H | 32 | #ifndef GNUNET_ARM_SERVICE_H |
@@ -342,6 +347,7 @@ GNUNET_ARM_monitor (const struct GNUNET_CONFIGURATION_Handle *cfg, | |||
342 | void | 347 | void |
343 | GNUNET_ARM_monitor_disconnect_and_free (struct GNUNET_ARM_MonitorHandle *h); | 348 | GNUNET_ARM_monitor_disconnect_and_free (struct GNUNET_ARM_MonitorHandle *h); |
344 | 349 | ||
350 | /** @} */ /* end of group */ | ||
345 | 351 | ||
346 | #if 0 /* keep Emacsens' auto-indent happy */ | 352 | #if 0 /* keep Emacsens' auto-indent happy */ |
347 | { | 353 | { |
diff --git a/src/include/gnunet_ats_plugin.h b/src/include/gnunet_ats_plugin.h index 71572d64e..19003aa02 100644 --- a/src/include/gnunet_ats_plugin.h +++ b/src/include/gnunet_ats_plugin.h | |||
@@ -19,14 +19,20 @@ | |||
19 | */ | 19 | */ |
20 | 20 | ||
21 | /** | 21 | /** |
22 | * @file include/gnunet_ats_plugin.h | ||
23 | * @brief API for the ATS solvers. This header | ||
24 | * specifies the struct that is given to the plugin's entry | ||
25 | * method and the other struct that must be returned. | ||
26 | * Note that the destructors of ATS plugins will | ||
27 | * be given the value returned by the constructor | ||
28 | * and is expected to return a NULL pointer. | ||
29 | * @author Christian Grothoff | 22 | * @author Christian Grothoff |
23 | * | ||
24 | * @file | ||
25 | * API for the ATS solvers. | ||
26 | * | ||
27 | * @defgroup ats-plugin ATS service plugin API | ||
28 | * Plugin API for the ATS service. | ||
29 | * | ||
30 | * Specifies the struct that is given to the plugin's entry method and the other | ||
31 | * struct that must be returned. Note that the destructors of ATS plugins will | ||
32 | * be given the value returned by the constructor and is expected to return a | ||
33 | * NULL pointer. | ||
34 | * | ||
35 | * @{ | ||
30 | */ | 36 | */ |
31 | #ifndef PLUGIN_ATS_H | 37 | #ifndef PLUGIN_ATS_H |
32 | #define PLUGIN_ATS_H | 38 | #define PLUGIN_ATS_H |
@@ -472,4 +478,6 @@ struct GNUNET_ATS_PluginEnvironment | |||
472 | unsigned long long in_quota[GNUNET_ATS_NetworkTypeCount]; | 478 | unsigned long long in_quota[GNUNET_ATS_NetworkTypeCount]; |
473 | }; | 479 | }; |
474 | 480 | ||
481 | /** @} */ /* end of group */ | ||
482 | |||
475 | #endif | 483 | #endif |
diff --git a/src/include/gnunet_ats_service.h b/src/include/gnunet_ats_service.h index b727b4f9a..acbaabafc 100644 --- a/src/include/gnunet_ats_service.h +++ b/src/include/gnunet_ats_service.h | |||
@@ -18,10 +18,15 @@ | |||
18 | Boston, MA 02110-1301, USA. | 18 | Boston, MA 02110-1301, USA. |
19 | */ | 19 | */ |
20 | /** | 20 | /** |
21 | * @file include/gnunet_ats_service.h | 21 | * @file |
22 | * @brief automatic transport selection and outbound bandwidth determination | 22 | * Automatic transport selection and outbound bandwidth determination |
23 | * | ||
23 | * @author Christian Grothoff | 24 | * @author Christian Grothoff |
24 | * @author Matthias Wachs | 25 | * @author Matthias Wachs |
26 | * | ||
27 | * @defgroup ats ATS service | ||
28 | * Automatic transport selection and outbound bandwidth determination | ||
29 | * @{ | ||
25 | */ | 30 | */ |
26 | #ifndef GNUNET_ATS_SERVICE_H | 31 | #ifndef GNUNET_ATS_SERVICE_H |
27 | #define GNUNET_ATS_SERVICE_H | 32 | #define GNUNET_ATS_SERVICE_H |
@@ -695,5 +700,7 @@ GNUNET_ATS_performance_give_feedback (struct GNUNET_ATS_PerformanceHandle *ph, | |||
695 | const struct GNUNET_TIME_Relative scope, | 700 | const struct GNUNET_TIME_Relative scope, |
696 | ...); | 701 | ...); |
697 | 702 | ||
703 | /** @} */ /* end of group */ | ||
704 | |||
698 | #endif | 705 | #endif |
699 | /* end of file gnunet-service-transport_ats.h */ | 706 | /* end of file gnunet-service-transport_ats.h */ |
diff --git a/src/include/gnunet_bandwidth_lib.h b/src/include/gnunet_bandwidth_lib.h index bed817144..01fd5c0bc 100644 --- a/src/include/gnunet_bandwidth_lib.h +++ b/src/include/gnunet_bandwidth_lib.h | |||
@@ -19,9 +19,14 @@ | |||
19 | */ | 19 | */ |
20 | 20 | ||
21 | /** | 21 | /** |
22 | * @file include/gnunet_bandwidth_lib.h | ||
23 | * @brief functions related to bandwidth (unit) | ||
24 | * @author Christian Grothoff | 22 | * @author Christian Grothoff |
23 | * | ||
24 | * @file | ||
25 | * Functions related to bandwidth (unit) | ||
26 | * | ||
27 | * @defgroup bandwidth Bandwidth library | ||
28 | * Functions related to bandwidth (unit) | ||
29 | * @{ | ||
25 | */ | 30 | */ |
26 | 31 | ||
27 | #ifndef GNUNET_BANDWIDTH_LIB_H | 32 | #ifndef GNUNET_BANDWIDTH_LIB_H |
@@ -327,6 +332,8 @@ GNUNET_BANDWIDTH_tracker_update_quota (struct GNUNET_BANDWIDTH_Tracker *av, | |||
327 | } | 332 | } |
328 | #endif | 333 | #endif |
329 | 334 | ||
335 | /** @} */ /* end of group */ | ||
336 | |||
330 | /* ifndef GNUNET_BANDWIDTH_LIB_H */ | 337 | /* ifndef GNUNET_BANDWIDTH_LIB_H */ |
331 | #endif | 338 | #endif |
332 | /* end of gnunet_bandwidth_lib.h */ | 339 | /* end of gnunet_bandwidth_lib.h */ |
diff --git a/src/include/gnunet_bio_lib.h b/src/include/gnunet_bio_lib.h index 7a711649d..034be2ed2 100644 --- a/src/include/gnunet_bio_lib.h +++ b/src/include/gnunet_bio_lib.h | |||
@@ -19,10 +19,13 @@ | |||
19 | */ | 19 | */ |
20 | 20 | ||
21 | /** | 21 | /** |
22 | * @file include/gnunet_bio_lib.h | ||
23 | * @brief buffered IO API | ||
24 | * @author Christian Grothoff | 22 | * @author Christian Grothoff |
25 | * @defgroup bio Buffered binary disk IO (with endianess conversion) | 23 | * |
24 | * @file | ||
25 | * Buffered IO library | ||
26 | * | ||
27 | * @defgroup bio BIO library | ||
28 | * Buffered binary disk IO (with endianess conversion) | ||
26 | * @{ | 29 | * @{ |
27 | */ | 30 | */ |
28 | 31 | ||
diff --git a/src/include/gnunet_block_lib.h b/src/include/gnunet_block_lib.h index 66c15da05..d42a6dac9 100644 --- a/src/include/gnunet_block_lib.h +++ b/src/include/gnunet_block_lib.h | |||
@@ -19,9 +19,14 @@ | |||
19 | */ | 19 | */ |
20 | 20 | ||
21 | /** | 21 | /** |
22 | * @file include/gnunet_block_lib.h | ||
23 | * @brief library for data block manipulation | ||
24 | * @author Christian Grothoff | 22 | * @author Christian Grothoff |
23 | * | ||
24 | * @file | ||
25 | * Library for data block manipulation | ||
26 | * | ||
27 | * @defgroup block Block library | ||
28 | * Library for data block manipulation | ||
29 | * @{ | ||
25 | */ | 30 | */ |
26 | #ifndef GNUNET_BLOCK_LIB_H | 31 | #ifndef GNUNET_BLOCK_LIB_H |
27 | #define GNUNET_BLOCK_LIB_H | 32 | #define GNUNET_BLOCK_LIB_H |
@@ -301,6 +306,8 @@ GNUNET_BLOCK_construct_bloomfilter (int32_t bf_mutator, | |||
301 | } | 306 | } |
302 | #endif | 307 | #endif |
303 | 308 | ||
309 | /** @} */ /* end of group */ | ||
310 | |||
304 | 311 | ||
305 | /* ifndef GNUNET_BLOCK_LIB_H */ | 312 | /* ifndef GNUNET_BLOCK_LIB_H */ |
306 | #endif | 313 | #endif |
diff --git a/src/include/gnunet_block_plugin.h b/src/include/gnunet_block_plugin.h index 35afa8a7f..362d7c740 100644 --- a/src/include/gnunet_block_plugin.h +++ b/src/include/gnunet_block_plugin.h | |||
@@ -19,13 +19,19 @@ | |||
19 | */ | 19 | */ |
20 | 20 | ||
21 | /** | 21 | /** |
22 | * @file include/gnunet_block_plugin.h | ||
23 | * @brief API for block plugins. Each block plugin must conform to | ||
24 | * the API specified by this header. | ||
25 | * @author Christian Grothoff | 22 | * @author Christian Grothoff |
26 | * @defgroup block API to be implemented by applications storing data in the DHT | 23 | * |
24 | * @file | ||
25 | * API for block plugins. Each block plugin must conform to the API specified by this header. | ||
26 | * | ||
27 | * @defgroup block-plugin Block plugin API | ||
28 | * To be implemented by applications storing data in the DHT. | ||
29 | * | ||
30 | * Each block plugin must conform to the API specified by this header. | ||
31 | * | ||
27 | * @{ | 32 | * @{ |
28 | */ | 33 | */ |
34 | |||
29 | #ifndef PLUGIN_BLOCK_H | 35 | #ifndef PLUGIN_BLOCK_H |
30 | #define PLUGIN_BLOCK_H | 36 | #define PLUGIN_BLOCK_H |
31 | 37 | ||
diff --git a/src/include/gnunet_cadet_service.h b/src/include/gnunet_cadet_service.h index a0d28b531..0ba6e2e91 100644 --- a/src/include/gnunet_cadet_service.h +++ b/src/include/gnunet_cadet_service.h | |||
@@ -18,10 +18,20 @@ | |||
18 | Boston, MA 02110-1301, USA. | 18 | Boston, MA 02110-1301, USA. |
19 | */ | 19 | */ |
20 | /** | 20 | /** |
21 | * @file include/gnunet_cadet_service.h | ||
22 | * @brief cadet service; establish channels to distant peers | ||
23 | * @author Christian Grothoff | 21 | * @author Christian Grothoff |
24 | * @author Bart Polot | 22 | * @author Bart Polot |
23 | * | ||
24 | * @file | ||
25 | * CADET service; establish channels to distant peers | ||
26 | * | ||
27 | * @defgroup cadet CADET service | ||
28 | * Confidential Ad-hoc Decentralized End-to-End Transport | ||
29 | * | ||
30 | * See also: | ||
31 | * - [CADET documentation](https://gnunet.org/cadet-subsystem) | ||
32 | * - [CADET paper](https://gnunet.org/cadet) | ||
33 | * | ||
34 | * @{ | ||
25 | */ | 35 | */ |
26 | #ifndef GNUNET_CADET_SERVICE_H | 36 | #ifndef GNUNET_CADET_SERVICE_H |
27 | #define GNUNET_CADET_SERVICE_H | 37 | #define GNUNET_CADET_SERVICE_H |
@@ -632,6 +642,8 @@ GNUNET_CADET_mq_create (struct GNUNET_CADET_Channel *channel); | |||
632 | } | 642 | } |
633 | #endif | 643 | #endif |
634 | 644 | ||
645 | /** @} */ /* end of group */ | ||
646 | |||
635 | /* ifndef GNUNET_CADET_SERVICE_H */ | 647 | /* ifndef GNUNET_CADET_SERVICE_H */ |
636 | #endif | 648 | #endif |
637 | /* end of gnunet_cadet_service.h */ | 649 | /* end of gnunet_cadet_service.h */ |
diff --git a/src/include/gnunet_client_lib.h b/src/include/gnunet_client_lib.h index 70dd98504..f961ee181 100644 --- a/src/include/gnunet_client_lib.h +++ b/src/include/gnunet_client_lib.h | |||
@@ -19,10 +19,13 @@ | |||
19 | */ | 19 | */ |
20 | 20 | ||
21 | /** | 21 | /** |
22 | * @file include/gnunet_client_lib.h | ||
23 | * @brief functions related to accessing services | ||
24 | * @author Christian Grothoff | 22 | * @author Christian Grothoff |
25 | * @defgroup client Generic client-side communication with services | 23 | * |
24 | * @file | ||
25 | * Functions related to accessing services | ||
26 | |||
27 | * @defgroup client Client library | ||
28 | * Generic client-side communication with services | ||
26 | * @{ | 29 | * @{ |
27 | */ | 30 | */ |
28 | 31 | ||
diff --git a/src/include/gnunet_client_manager_lib.h b/src/include/gnunet_client_manager_lib.h index 8f143a770..6838ee046 100644 --- a/src/include/gnunet_client_manager_lib.h +++ b/src/include/gnunet_client_manager_lib.h | |||
@@ -19,11 +19,17 @@ | |||
19 | */ | 19 | */ |
20 | 20 | ||
21 | /** | 21 | /** |
22 | * @file include/gnunet_client_manager_lib.h | ||
23 | * @brief Client manager; higher level client API with transmission queue | ||
24 | * and message handler registration. | ||
25 | * @author Gabor X Toth | 22 | * @author Gabor X Toth |
26 | * @defgroup client_manager Higher level client-side communication with services. | 23 | * |
24 | * @file | ||
25 | * Client manager; higher level client API with transmission queue | ||
26 | * and message handler registration. | ||
27 | * | ||
28 | * @defgroup client-manager Client manager library | ||
29 | * Higher level client-side communication with services. | ||
30 | * | ||
31 | * Provides a higher level client API | ||
32 | * with transmission queue and message handler registration. | ||
27 | * @{ | 33 | * @{ |
28 | */ | 34 | */ |
29 | #ifndef GNUNET_CLIENT_MANAGER_LIB_H | 35 | #ifndef GNUNET_CLIENT_MANAGER_LIB_H |
@@ -347,7 +353,7 @@ GNUNET_CLIENT_MANAGER_op_cancel (struct GNUNET_CLIENT_MANAGER_Connection *mgr, | |||
347 | } | 353 | } |
348 | #endif | 354 | #endif |
349 | 355 | ||
350 | /** @} */ /* end of group client_manager */ | 356 | /** @} */ /* end of group */ |
351 | 357 | ||
352 | /* ifndef GNUNET_CLIENT_MANAGER_LIB_H */ | 358 | /* ifndef GNUNET_CLIENT_MANAGER_LIB_H */ |
353 | #endif | 359 | #endif |
diff --git a/src/include/gnunet_configuration_lib.h b/src/include/gnunet_configuration_lib.h index 7813096b1..b74aa9520 100644 --- a/src/include/gnunet_configuration_lib.h +++ b/src/include/gnunet_configuration_lib.h | |||
@@ -19,10 +19,13 @@ | |||
19 | */ | 19 | */ |
20 | 20 | ||
21 | /** | 21 | /** |
22 | * @file include/gnunet_configuration_lib.h | ||
23 | * @brief configuration API | ||
24 | * @author Christian Grothoff | 22 | * @author Christian Grothoff |
25 | * @defgroup configuration Configuration management | 23 | * |
24 | * @file | ||
25 | * Configuration API | ||
26 | * | ||
27 | * @defgroup configuration Configuration library | ||
28 | * Configuration management | ||
26 | * @{ | 29 | * @{ |
27 | */ | 30 | */ |
28 | #ifndef GNUNET_CONFIGURATION_LIB_H | 31 | #ifndef GNUNET_CONFIGURATION_LIB_H |
diff --git a/src/include/gnunet_connection_lib.h b/src/include/gnunet_connection_lib.h index 02b2304c9..a91175b8a 100644 --- a/src/include/gnunet_connection_lib.h +++ b/src/include/gnunet_connection_lib.h | |||
@@ -19,9 +19,14 @@ | |||
19 | */ | 19 | */ |
20 | 20 | ||
21 | /** | 21 | /** |
22 | * @file include/gnunet_connection_lib.h | ||
23 | * @brief basic, low-level TCP networking interface | ||
24 | * @author Christian Grothoff | 22 | * @author Christian Grothoff |
23 | * | ||
24 | * @file include/gnunet_connection_lib.h | ||
25 | * Basic, low-level TCP networking interface | ||
26 | * | ||
27 | * @defgroup connection Connection library | ||
28 | * Basic, low-level TCP networking interface | ||
29 | * @{ | ||
25 | */ | 30 | */ |
26 | #ifndef GNUNET_CONNECTION_LIB_H | 31 | #ifndef GNUNET_CONNECTION_LIB_H |
27 | #define GNUNET_CONNECTION_LIB_H | 32 | #define GNUNET_CONNECTION_LIB_H |
@@ -370,7 +375,7 @@ GNUNET_CONNECTION_create_proxied_from_handshake (struct GNUNET_CONNECTION_Handle | |||
370 | 375 | ||
371 | 376 | ||
372 | /** | 377 | /** |
373 | * Activate proxied connection and destroy initial proxy handshake connection. | 378 | * Activate proxied connection and destroy initial proxy handshake connection. |
374 | * There must not be any pending requests for reading or writing to the | 379 | * There must not be any pending requests for reading or writing to the |
375 | * proxy hadshake connection at this time. | 380 | * proxy hadshake connection at this time. |
376 | * | 381 | * |
@@ -387,6 +392,7 @@ GNUNET_CONNECTION_acivate_proxied (struct GNUNET_CONNECTION_Handle *proxied); | |||
387 | } | 392 | } |
388 | #endif | 393 | #endif |
389 | 394 | ||
395 | /** @} */ /* end of group */ | ||
390 | 396 | ||
391 | /* ifndef GNUNET_CONNECTION_LIB_H */ | 397 | /* ifndef GNUNET_CONNECTION_LIB_H */ |
392 | #endif | 398 | #endif |
diff --git a/src/include/gnunet_consensus_service.h b/src/include/gnunet_consensus_service.h index 77607a6e2..aaac12834 100644 --- a/src/include/gnunet_consensus_service.h +++ b/src/include/gnunet_consensus_service.h | |||
@@ -19,9 +19,14 @@ | |||
19 | */ | 19 | */ |
20 | 20 | ||
21 | /** | 21 | /** |
22 | * @file include/gnunet_consensus_service.h | ||
23 | * @brief multi-peer set reconciliation | ||
24 | * @author Florian Dold | 22 | * @author Florian Dold |
23 | * | ||
24 | * @file | ||
25 | * Multi-peer set reconciliation | ||
26 | * | ||
27 | * @defgroup consensus Consensus service | ||
28 | * Multi-peer set reconciliation | ||
29 | * @{ | ||
25 | */ | 30 | */ |
26 | 31 | ||
27 | #ifndef GNUNET_CONSENSUS_SERVICE_H | 32 | #ifndef GNUNET_CONSENSUS_SERVICE_H |
@@ -166,6 +171,7 @@ GNUNET_CONSENSUS_conclude (struct GNUNET_CONSENSUS_Handle *consensus, | |||
166 | void | 171 | void |
167 | GNUNET_CONSENSUS_destroy (struct GNUNET_CONSENSUS_Handle *consensus); | 172 | GNUNET_CONSENSUS_destroy (struct GNUNET_CONSENSUS_Handle *consensus); |
168 | 173 | ||
174 | /** @} */ /* end of group */ | ||
169 | 175 | ||
170 | #if 0 /* keep Emacsens' auto-indent happy */ | 176 | #if 0 /* keep Emacsens' auto-indent happy */ |
171 | { | 177 | { |
diff --git a/src/include/gnunet_constants.h b/src/include/gnunet_constants.h index 0d7614f0b..11c14845a 100644 --- a/src/include/gnunet_constants.h +++ b/src/include/gnunet_constants.h | |||
@@ -19,9 +19,10 @@ | |||
19 | */ | 19 | */ |
20 | 20 | ||
21 | /** | 21 | /** |
22 | * @file include/gnunet_constants.h | ||
23 | * @brief "global" constants for performance tuning | ||
24 | * @author Christian Grothoff | 22 | * @author Christian Grothoff |
23 | * | ||
24 | * @file | ||
25 | * "Global" constants for performance tuning | ||
25 | */ | 26 | */ |
26 | 27 | ||
27 | #ifndef GNUNET_CONSTANTS_H | 28 | #ifndef GNUNET_CONSTANTS_H |
diff --git a/src/include/gnunet_container_lib.h b/src/include/gnunet_container_lib.h index aa6a17150..3ef64fbb7 100644 --- a/src/include/gnunet_container_lib.h +++ b/src/include/gnunet_container_lib.h | |||
@@ -19,15 +19,25 @@ | |||
19 | */ | 19 | */ |
20 | 20 | ||
21 | /** | 21 | /** |
22 | * @file include/gnunet_container_lib.h | ||
23 | * @brief container classes for GNUnet | ||
24 | * @author Christian Grothoff | 22 | * @author Christian Grothoff |
25 | * @author Nils Durner | 23 | * @author Nils Durner |
26 | * @defgroup hashmap multi hash-map | 24 | * |
27 | * @defgroup heap min- or max-heap with arbitrary element removal | 25 | * @file |
28 | * @defgroup bloomfilter Bloom filter (probabilistic set tests) | 26 | * Container classes for GNUnet |
29 | * @defgroup dll Doubly-linked list | 27 | * |
30 | * @defgroup metadata Meta data (GNU libextractor key-value pairs) | 28 | * @defgroup hashmap Container library: MultiHashMap |
29 | * Hash map with multiple values per key. | ||
30 | * | ||
31 | * @defgroup heap Container library: Heap | ||
32 | * Min- or max-heap with arbitrary element removal | ||
33 | * | ||
34 | * @defgroup bloomfilter Container library: Bloom filter | ||
35 | * Probabilistic set tests | ||
36 | * | ||
37 | * @defgroup dll Container library: Doubly-linked list | ||
38 | * | ||
39 | * @defgroup metadata Container library: Metadata | ||
40 | * GNU libextractor key-value pairs | ||
31 | */ | 41 | */ |
32 | 42 | ||
33 | #ifndef GNUNET_CONTAINER_LIB_H | 43 | #ifndef GNUNET_CONTAINER_LIB_H |
diff --git a/src/include/gnunet_conversation_service.h b/src/include/gnunet_conversation_service.h index 61ccfc03f..15cc0a3d3 100644 --- a/src/include/gnunet_conversation_service.h +++ b/src/include/gnunet_conversation_service.h | |||
@@ -19,12 +19,15 @@ | |||
19 | */ | 19 | */ |
20 | 20 | ||
21 | /** | 21 | /** |
22 | * @file include/gnunet_conversation_service.h | ||
23 | * @brief API to the conversation service | ||
24 | * @author Simon Dieterle | 22 | * @author Simon Dieterle |
25 | * @author Andreas Fuchs | 23 | * @author Andreas Fuchs |
26 | * @author Christian Grothoff | 24 | * @author Christian Grothoff |
27 | * | 25 | * |
26 | * @file | ||
27 | * API to the conversation service | ||
28 | * | ||
29 | * @defgroup conversation Conversation service | ||
30 | * One-to-one voice communication over CADET | ||
28 | * | 31 | * |
29 | * NOTE: This API is deliberately deceptively simple; the idea | 32 | * NOTE: This API is deliberately deceptively simple; the idea |
30 | * is that advanced features (such as answering machines) will | 33 | * is that advanced features (such as answering machines) will |
@@ -41,6 +44,8 @@ | |||
41 | * course provided as part of the basic implementation, as only the | 44 | * course provided as part of the basic implementation, as only the |
42 | * CONVERSATION service can know for sure who it is that we are | 45 | * CONVERSATION service can know for sure who it is that we are |
43 | * talking to. | 46 | * talking to. |
47 | * | ||
48 | * @{ | ||
44 | */ | 49 | */ |
45 | #ifndef GNUNET_CONVERSATION_SERVICE_H | 50 | #ifndef GNUNET_CONVERSATION_SERVICE_H |
46 | #define GNUNET_CONVERSATION_SERVICE_H | 51 | #define GNUNET_CONVERSATION_SERVICE_H |
@@ -417,6 +422,7 @@ GNUNET_CONVERSATION_call_resume (struct GNUNET_CONVERSATION_Call *call, | |||
417 | void | 422 | void |
418 | GNUNET_CONVERSATION_call_stop (struct GNUNET_CONVERSATION_Call *call); | 423 | GNUNET_CONVERSATION_call_stop (struct GNUNET_CONVERSATION_Call *call); |
419 | 424 | ||
425 | /** @} */ /* end of group */ | ||
420 | 426 | ||
421 | #if 0 /* keep Emacsens' auto-indent happy */ | 427 | #if 0 /* keep Emacsens' auto-indent happy */ |
422 | { | 428 | { |
diff --git a/src/include/gnunet_core_service.h b/src/include/gnunet_core_service.h index 8f2ff738b..3dd3e2b2d 100644 --- a/src/include/gnunet_core_service.h +++ b/src/include/gnunet_core_service.h | |||
@@ -18,11 +18,13 @@ | |||
18 | Boston, MA 02110-1301, USA. | 18 | Boston, MA 02110-1301, USA. |
19 | */ | 19 | */ |
20 | /** | 20 | /** |
21 | * @file include/gnunet_core_service.h | ||
22 | * @brief core service; this is the main API for encrypted P2P | ||
23 | * communications | ||
24 | * @author Christian Grothoff | 21 | * @author Christian Grothoff |
25 | * @defgroup core encrypted direct communication between peers | 22 | * |
23 | * @file include/gnunet_core_service.h | ||
24 | * Core service; the main API for encrypted P2P communications | ||
25 | * | ||
26 | * @defgroup core Core service | ||
27 | * Encrypted direct communication between peers | ||
26 | * @{ | 28 | * @{ |
27 | */ | 29 | */ |
28 | #ifndef GNUNET_CORE_SERVICE_H | 30 | #ifndef GNUNET_CORE_SERVICE_H |
diff --git a/src/include/gnunet_crypto_lib.h b/src/include/gnunet_crypto_lib.h index 2ec3b4d8d..4e6dc93ab 100644 --- a/src/include/gnunet_crypto_lib.h +++ b/src/include/gnunet_crypto_lib.h | |||
@@ -28,8 +28,10 @@ | |||
28 | * @author Ioana Patrascu | 28 | * @author Ioana Patrascu |
29 | * @author Tzvetan Horozov | 29 | * @author Tzvetan Horozov |
30 | * | 30 | * |
31 | * @defgroup crypto Cryptographic operations | 31 | * @defgroup crypto Crypto library: cryptographic operations |
32 | * @defgroup hash Hashing and operations on hashes | 32 | * |
33 | * @defgroup hash Crypto library: hash operations | ||
34 | * Hashing and operations on hashes | ||
33 | */ | 35 | */ |
34 | 36 | ||
35 | #ifndef GNUNET_CRYPTO_LIB_H | 37 | #ifndef GNUNET_CRYPTO_LIB_H |
diff --git a/src/include/gnunet_datacache_lib.h b/src/include/gnunet_datacache_lib.h index 6334935cc..28efa9627 100644 --- a/src/include/gnunet_datacache_lib.h +++ b/src/include/gnunet_datacache_lib.h | |||
@@ -19,13 +19,19 @@ | |||
19 | */ | 19 | */ |
20 | 20 | ||
21 | /** | 21 | /** |
22 | * @file include/gnunet_datacache_lib.h | ||
23 | * @brief datacache is a simple, transient hash table | ||
24 | * of bounded size with content expiration. | ||
25 | * In contrast to the sqstore there is | ||
26 | * no prioritization, deletion or iteration. | ||
27 | * All of the data is discarded when the peer shuts down! | ||
28 | * @author Christian Grothoff | 22 | * @author Christian Grothoff |
23 | * | ||
24 | * @file | ||
25 | * datacache API | ||
26 | * | ||
27 | * @defgroup datacache Datacache library | ||
28 | * Simple, transient hash table of bounded size with content expiration. | ||
29 | * | ||
30 | * In contrast to the sqstore there is | ||
31 | * no prioritization, deletion or iteration. | ||
32 | * All of the data is discarded when the peer shuts down! | ||
33 | * | ||
34 | * @{ | ||
29 | */ | 35 | */ |
30 | 36 | ||
31 | #ifndef GNUNET_DATACACHE_LIB_H | 37 | #ifndef GNUNET_DATACACHE_LIB_H |
@@ -171,6 +177,7 @@ GNUNET_DATACACHE_get_closest (struct GNUNET_DATACACHE_Handle *h, | |||
171 | GNUNET_DATACACHE_Iterator iter, | 177 | GNUNET_DATACACHE_Iterator iter, |
172 | void *iter_cls); | 178 | void *iter_cls); |
173 | 179 | ||
180 | /** @} */ /* end of group */ | ||
174 | 181 | ||
175 | #if 0 /* keep Emacsens' auto-indent happy */ | 182 | #if 0 /* keep Emacsens' auto-indent happy */ |
176 | { | 183 | { |
diff --git a/src/include/gnunet_datacache_plugin.h b/src/include/gnunet_datacache_plugin.h index 699973b0c..cda4e88ce 100644 --- a/src/include/gnunet_datacache_plugin.h +++ b/src/include/gnunet_datacache_plugin.h | |||
@@ -19,9 +19,14 @@ | |||
19 | */ | 19 | */ |
20 | 20 | ||
21 | /** | 21 | /** |
22 | * @file include/gnunet_datacache_plugin.h | ||
23 | * @brief API for database backends for the datacache | ||
24 | * @author Christian Grothoff | 22 | * @author Christian Grothoff |
23 | * | ||
24 | * @file | ||
25 | * API for database backends for the datacache | ||
26 | * | ||
27 | * @defgroup datacache-plugin Datacache plugin API | ||
28 | * API for database backends for the datacache | ||
29 | * @{ | ||
25 | */ | 30 | */ |
26 | #ifndef PLUGIN_DATACACHE_H | 31 | #ifndef PLUGIN_DATACACHE_H |
27 | #define PLUGIN_DATACACHE_H | 32 | #define PLUGIN_DATACACHE_H |
@@ -181,6 +186,7 @@ struct GNUNET_DATACACHE_PluginFunctions | |||
181 | 186 | ||
182 | }; | 187 | }; |
183 | 188 | ||
189 | /** @} */ /* end of group */ | ||
184 | 190 | ||
185 | #if 0 /* keep Emacsens' auto-indent happy */ | 191 | #if 0 /* keep Emacsens' auto-indent happy */ |
186 | { | 192 | { |
diff --git a/src/include/gnunet_datastore_plugin.h b/src/include/gnunet_datastore_plugin.h index 08093d55e..7e5344ebf 100644 --- a/src/include/gnunet_datastore_plugin.h +++ b/src/include/gnunet_datastore_plugin.h | |||
@@ -19,9 +19,14 @@ | |||
19 | */ | 19 | */ |
20 | 20 | ||
21 | /** | 21 | /** |
22 | * @file include/gnunet_datastore_plugin.h | ||
23 | * @brief API for the database backend plugins. | ||
24 | * @author Christian Grothoff | 22 | * @author Christian Grothoff |
23 | * | ||
24 | * @file | ||
25 | * API for the database backend plugins. | ||
26 | * | ||
27 | * @defgroup datastore-plugin Datastore service plugin API | ||
28 | * API for the database backend plugins. | ||
29 | * @{ | ||
25 | */ | 30 | */ |
26 | #ifndef PLUGIN_DATASTORE_H | 31 | #ifndef PLUGIN_DATASTORE_H |
27 | #define PLUGIN_DATASTORE_H | 32 | #define PLUGIN_DATASTORE_H |
@@ -48,8 +53,8 @@ | |||
48 | * @param delta change in disk utilization, | 53 | * @param delta change in disk utilization, |
49 | * 0 for "reset to empty" | 54 | * 0 for "reset to empty" |
50 | */ | 55 | */ |
51 | typedef void | 56 | typedef void |
52 | (*GNUNET_DATASTORE_DiskUtilizationChange) (void *cls, | 57 | (*GNUNET_DATASTORE_DiskUtilizationChange) (void *cls, |
53 | int delta); | 58 | int delta); |
54 | 59 | ||
55 | 60 | ||
@@ -93,13 +98,13 @@ struct GNUNET_DATASTORE_PluginEnvironment | |||
93 | * @return #GNUNET_OK to keep the item | 98 | * @return #GNUNET_OK to keep the item |
94 | * #GNUNET_NO to delete the item | 99 | * #GNUNET_NO to delete the item |
95 | */ | 100 | */ |
96 | typedef int | 101 | typedef int |
97 | (*PluginDatumProcessor) (void *cls, | 102 | (*PluginDatumProcessor) (void *cls, |
98 | const struct GNUNET_HashCode *key, | 103 | const struct GNUNET_HashCode *key, |
99 | uint32_t size, | 104 | uint32_t size, |
100 | const void *data, | 105 | const void *data, |
101 | enum GNUNET_BLOCK_Type type, | 106 | enum GNUNET_BLOCK_Type type, |
102 | uint32_t priority, | 107 | uint32_t priority, |
103 | uint32_t anonymity, | 108 | uint32_t anonymity, |
104 | struct GNUNET_TIME_Absolute expiration, | 109 | struct GNUNET_TIME_Absolute expiration, |
105 | uint64_t uid); | 110 | uint64_t uid); |
@@ -130,11 +135,11 @@ typedef void | |||
130 | * @param status #GNUNET_OK or #GNUNET_SYSERROR | 135 | * @param status #GNUNET_OK or #GNUNET_SYSERROR |
131 | * @param msg error message on error | 136 | * @param msg error message on error |
132 | */ | 137 | */ |
133 | typedef void | 138 | typedef void |
134 | (*PluginPutCont) (void *cls, | 139 | (*PluginPutCont) (void *cls, |
135 | const struct GNUNET_HashCode *key, | 140 | const struct GNUNET_HashCode *key, |
136 | uint32_t size, | 141 | uint32_t size, |
137 | int status, | 142 | int status, |
138 | const char *msg); | 143 | const char *msg); |
139 | 144 | ||
140 | 145 | ||
@@ -155,16 +160,16 @@ typedef void | |||
155 | * @param cont continuation called with success or failure status | 160 | * @param cont continuation called with success or failure status |
156 | * @param cont_cls continuation closure for @a cont | 161 | * @param cont_cls continuation closure for @a cont |
157 | */ | 162 | */ |
158 | typedef void | 163 | typedef void |
159 | (*PluginPut) (void *cls, const struct GNUNET_HashCode *key, | 164 | (*PluginPut) (void *cls, const struct GNUNET_HashCode *key, |
160 | uint32_t size, | 165 | uint32_t size, |
161 | const void *data, | 166 | const void *data, |
162 | enum GNUNET_BLOCK_Type type, | 167 | enum GNUNET_BLOCK_Type type, |
163 | uint32_t priority, | 168 | uint32_t priority, |
164 | uint32_t anonymity, | 169 | uint32_t anonymity, |
165 | uint32_t replication, | 170 | uint32_t replication, |
166 | struct GNUNET_TIME_Absolute expiration, | 171 | struct GNUNET_TIME_Absolute expiration, |
167 | PluginPutCont cont, | 172 | PluginPutCont cont, |
168 | void *cont_cls); | 173 | void *cont_cls); |
169 | 174 | ||
170 | 175 | ||
@@ -175,7 +180,7 @@ typedef void | |||
175 | * @param key key in the data store, if NULL iteration is finished | 180 | * @param key key in the data store, if NULL iteration is finished |
176 | * @param count how many values are stored under this key in the datastore | 181 | * @param count how many values are stored under this key in the datastore |
177 | */ | 182 | */ |
178 | typedef void | 183 | typedef void |
179 | (*PluginKeyProcessor) (void *cls, | 184 | (*PluginKeyProcessor) (void *cls, |
180 | const struct GNUNET_HashCode *key, | 185 | const struct GNUNET_HashCode *key, |
181 | unsigned int count); | 186 | unsigned int count); |
@@ -211,8 +216,8 @@ typedef void | |||
211 | * proc should be called with NULL if there is no result | 216 | * proc should be called with NULL if there is no result |
212 | * @param proc_cls closure for @a proc | 217 | * @param proc_cls closure for @a proc |
213 | */ | 218 | */ |
214 | typedef void | 219 | typedef void |
215 | (*PluginGetKey) (void *cls, | 220 | (*PluginGetKey) (void *cls, |
216 | uint64_t offset, | 221 | uint64_t offset, |
217 | const struct GNUNET_HashCode *key, | 222 | const struct GNUNET_HashCode *key, |
218 | const struct GNUNET_HashCode *vhash, | 223 | const struct GNUNET_HashCode *vhash, |
@@ -231,8 +236,8 @@ typedef void | |||
231 | * @param proc function to call the value (once only). | 236 | * @param proc function to call the value (once only). |
232 | * @param proc_cls closure for @a proc | 237 | * @param proc_cls closure for @a proc |
233 | */ | 238 | */ |
234 | typedef void | 239 | typedef void |
235 | (*PluginGetRandom) (void *cls, | 240 | (*PluginGetRandom) (void *cls, |
236 | PluginDatumProcessor proc, | 241 | PluginDatumProcessor proc, |
237 | void *proc_cls); | 242 | void *proc_cls); |
238 | 243 | ||
@@ -244,8 +249,8 @@ typedef void | |||
244 | * @param status #GNUNET_OK or #GNUNET_SYSERROR | 249 | * @param status #GNUNET_OK or #GNUNET_SYSERROR |
245 | * @param msg error message on error | 250 | * @param msg error message on error |
246 | */ | 251 | */ |
247 | typedef void | 252 | typedef void |
248 | (*PluginUpdateCont) (void *cls, | 253 | (*PluginUpdateCont) (void *cls, |
249 | int status, | 254 | int status, |
250 | const char *msg); | 255 | const char *msg); |
251 | 256 | ||
@@ -270,12 +275,12 @@ typedef void | |||
270 | * @param cont continuation called with success or failure status | 275 | * @param cont continuation called with success or failure status |
271 | * @param cons_cls continuation closure | 276 | * @param cons_cls continuation closure |
272 | */ | 277 | */ |
273 | typedef void | 278 | typedef void |
274 | (*PluginUpdate) (void *cls, | 279 | (*PluginUpdate) (void *cls, |
275 | uint64_t uid, | 280 | uint64_t uid, |
276 | int delta, | 281 | int delta, |
277 | struct GNUNET_TIME_Absolute expire, | 282 | struct GNUNET_TIME_Absolute expire, |
278 | PluginUpdateCont cont, | 283 | PluginUpdateCont cont, |
279 | void *cont_cls); | 284 | void *cont_cls); |
280 | 285 | ||
281 | 286 | ||
@@ -291,7 +296,7 @@ typedef void | |||
291 | * @param proc function to call on the matching value | 296 | * @param proc function to call on the matching value |
292 | * @param proc_cls closure for @a proc | 297 | * @param proc_cls closure for @a proc |
293 | */ | 298 | */ |
294 | typedef void | 299 | typedef void |
295 | (*PluginGetType) (void *cls, | 300 | (*PluginGetType) (void *cls, |
296 | uint64_t offset, | 301 | uint64_t offset, |
297 | enum GNUNET_BLOCK_Type type, | 302 | enum GNUNET_BLOCK_Type type, |
@@ -304,7 +309,7 @@ typedef void | |||
304 | * | 309 | * |
305 | * @param cls closure | 310 | * @param cls closure |
306 | */ | 311 | */ |
307 | typedef void | 312 | typedef void |
308 | (*PluginDrop) (void *cls); | 313 | (*PluginDrop) (void *cls); |
309 | 314 | ||
310 | 315 | ||
@@ -384,5 +389,6 @@ struct GNUNET_DATASTORE_PluginFunctions | |||
384 | 389 | ||
385 | }; | 390 | }; |
386 | 391 | ||
392 | /** @} */ /* end of group */ | ||
387 | 393 | ||
388 | #endif | 394 | #endif |
diff --git a/src/include/gnunet_datastore_service.h b/src/include/gnunet_datastore_service.h index 14ffb1740..bdc12b26c 100644 --- a/src/include/gnunet_datastore_service.h +++ b/src/include/gnunet_datastore_service.h | |||
@@ -19,13 +19,21 @@ | |||
19 | */ | 19 | */ |
20 | 20 | ||
21 | /** | 21 | /** |
22 | * @file include/gnunet_datastore_service.h | ||
23 | * @brief API that can be used manage the | ||
24 | * datastore for files stored on a GNUnet node; | ||
25 | * note that the datastore is NOT responsible for | ||
26 | * on-demand encoding, that is achieved using | ||
27 | * a special kind of entry. | ||
28 | * @author Christian Grothoff | 22 | * @author Christian Grothoff |
23 | * | ||
24 | * @file | ||
25 | * datastore service | ||
26 | * | ||
27 | * @defgroup datastore Datastore service | ||
28 | * Data store for files stored on a GNUnet node. | ||
29 | * | ||
30 | * Provides an API that can be used manage the | ||
31 | * datastore for files stored on a GNUnet node. | ||
32 | * Note that the datastore is NOT responsible for | ||
33 | * on-demand encoding, that is achieved using | ||
34 | * a special kind of entry. | ||
35 | * | ||
36 | * @{ | ||
29 | */ | 37 | */ |
30 | 38 | ||
31 | #ifndef GNUNET_DATASTORE_SERVICE_H | 39 | #ifndef GNUNET_DATASTORE_SERVICE_H |
@@ -389,6 +397,7 @@ GNUNET_DATASTORE_get_for_replication (struct GNUNET_DATASTORE_Handle *h, | |||
389 | void | 397 | void |
390 | GNUNET_DATASTORE_cancel (struct GNUNET_DATASTORE_QueueEntry *qe); | 398 | GNUNET_DATASTORE_cancel (struct GNUNET_DATASTORE_QueueEntry *qe); |
391 | 399 | ||
400 | /** @} */ /* end of group */ | ||
392 | 401 | ||
393 | #if 0 /* keep Emacsens' auto-indent happy */ | 402 | #if 0 /* keep Emacsens' auto-indent happy */ |
394 | { | 403 | { |
diff --git a/src/include/gnunet_dht_service.h b/src/include/gnunet_dht_service.h index c5b980ba9..36463f488 100644 --- a/src/include/gnunet_dht_service.h +++ b/src/include/gnunet_dht_service.h | |||
@@ -19,10 +19,13 @@ | |||
19 | */ | 19 | */ |
20 | 20 | ||
21 | /** | 21 | /** |
22 | * @file include/gnunet_dht_service.h | ||
23 | * @brief API to the DHT service | ||
24 | * @author Christian Grothoff | 22 | * @author Christian Grothoff |
25 | * @defgroup dht Distributed Hash Table | 23 | * |
24 | * @file | ||
25 | * API to the DHT service | ||
26 | * | ||
27 | * @defgroup dht DHT service | ||
28 | * Distributed Hash Table | ||
26 | * @{ | 29 | * @{ |
27 | */ | 30 | */ |
28 | 31 | ||
@@ -414,8 +417,8 @@ typedef void (*GNUNET_DHT_ActMaliciousContinuation)(void *cls, | |||
414 | FIXME: perhaps make this an enum of known malicious behaviors? | 417 | FIXME: perhaps make this an enum of known malicious behaviors? |
415 | */ | 418 | */ |
416 | struct GNUNET_DHT_ActMaliciousHandle * | 419 | struct GNUNET_DHT_ActMaliciousHandle * |
417 | GNUNET_DHT_act_malicious (struct GNUNET_DHT_Handle *handle, | 420 | GNUNET_DHT_act_malicious (struct GNUNET_DHT_Handle *handle, |
418 | unsigned int action, | 421 | unsigned int action, |
419 | GNUNET_DHT_PutContinuation cont, | 422 | GNUNET_DHT_PutContinuation cont, |
420 | void *cont_cls); | 423 | void *cont_cls); |
421 | #endif | 424 | #endif |
diff --git a/src/include/gnunet_disk_lib.h b/src/include/gnunet_disk_lib.h index 4b38a31d6..7b0b0e998 100644 --- a/src/include/gnunet_disk_lib.h +++ b/src/include/gnunet_disk_lib.h | |||
@@ -18,9 +18,14 @@ | |||
18 | Boston, MA 02110-1301, USA. | 18 | Boston, MA 02110-1301, USA. |
19 | */ | 19 | */ |
20 | /** | 20 | /** |
21 | * @file include/gnunet_disk_lib.h | ||
22 | * @brief disk IO apis | ||
23 | * @author Christian Grothoff | 21 | * @author Christian Grothoff |
22 | * | ||
23 | * @file | ||
24 | * Disk IO APIs | ||
25 | * | ||
26 | * @defgroup disk Disk library | ||
27 | * Disk IO APIs | ||
28 | * @{ | ||
24 | */ | 29 | */ |
25 | #ifndef GNUNET_DISK_LIB_H | 30 | #ifndef GNUNET_DISK_LIB_H |
26 | #define GNUNET_DISK_LIB_H | 31 | #define GNUNET_DISK_LIB_H |
@@ -861,6 +866,7 @@ GNUNET_DISK_file_sync (const struct GNUNET_DISK_FileHandle *h); | |||
861 | } | 866 | } |
862 | #endif | 867 | #endif |
863 | 868 | ||
869 | /** @} */ /* end of group */ | ||
864 | 870 | ||
865 | /* ifndef GNUNET_DISK_LIB_H */ | 871 | /* ifndef GNUNET_DISK_LIB_H */ |
866 | #endif | 872 | #endif |
diff --git a/src/include/gnunet_dns_service.h b/src/include/gnunet_dns_service.h index edf5cf182..4a8956e84 100644 --- a/src/include/gnunet_dns_service.h +++ b/src/include/gnunet_dns_service.h | |||
@@ -19,9 +19,13 @@ | |||
19 | */ | 19 | */ |
20 | 20 | ||
21 | /** | 21 | /** |
22 | * @file include/gnunet_dns_service.h | ||
23 | * @brief API to access the DNS service. | ||
24 | * @author Christian Grothoff | 22 | * @author Christian Grothoff |
23 | * | ||
24 | * @file | ||
25 | * API to access the DNS service. | ||
26 | * | ||
27 | * @defgroup dns DNS service | ||
28 | * @{ | ||
25 | */ | 29 | */ |
26 | #ifndef GNUNET_DNS_SERVICE_H | 30 | #ifndef GNUNET_DNS_SERVICE_H |
27 | #define GNUNET_DNS_SERVICE_H | 31 | #define GNUNET_DNS_SERVICE_H |
@@ -153,7 +157,7 @@ GNUNET_DNS_request_drop (struct GNUNET_DNS_RequestHandle *rh); | |||
153 | * @param reply reply data | 157 | * @param reply reply data |
154 | */ | 158 | */ |
155 | void | 159 | void |
156 | GNUNET_DNS_request_answer (struct GNUNET_DNS_RequestHandle *rh, | 160 | GNUNET_DNS_request_answer (struct GNUNET_DNS_RequestHandle *rh, |
157 | uint16_t reply_length, | 161 | uint16_t reply_length, |
158 | const char *reply); | 162 | const char *reply); |
159 | 163 | ||
@@ -182,4 +186,6 @@ GNUNET_DNS_connect (const struct GNUNET_CONFIGURATION_Handle *cfg, | |||
182 | void | 186 | void |
183 | GNUNET_DNS_disconnect (struct GNUNET_DNS_Handle *dh); | 187 | GNUNET_DNS_disconnect (struct GNUNET_DNS_Handle *dh); |
184 | 188 | ||
189 | /** @} */ /* end of group */ | ||
190 | |||
185 | #endif | 191 | #endif |
diff --git a/src/include/gnunet_dnsparser_lib.h b/src/include/gnunet_dnsparser_lib.h index e800442dc..9680af329 100644 --- a/src/include/gnunet_dnsparser_lib.h +++ b/src/include/gnunet_dnsparser_lib.h | |||
@@ -19,10 +19,15 @@ | |||
19 | */ | 19 | */ |
20 | 20 | ||
21 | /** | 21 | /** |
22 | * @file include/gnunet_dnsparser_lib.h | ||
23 | * @brief API for helper library to parse DNS packets. | ||
24 | * @author Philipp Toelke | 22 | * @author Philipp Toelke |
25 | * @author Christian Grothoff | 23 | * @author Christian Grothoff |
24 | * | ||
25 | * @file | ||
26 | * API for helper library to parse DNS packets. | ||
27 | * | ||
28 | * @defgroup dns-parser DNS parser library | ||
29 | * Helper library to parse DNS packets. | ||
30 | * @{ | ||
26 | */ | 31 | */ |
27 | #ifndef GNUNET_DNSPARSER_LIB_H | 32 | #ifndef GNUNET_DNSPARSER_LIB_H |
28 | #define GNUNET_DNSPARSER_LIB_H | 33 | #define GNUNET_DNSPARSER_LIB_H |
@@ -883,5 +888,6 @@ size_t | |||
883 | GNUNET_DNSPARSER_hex_to_bin (const char *hex, | 888 | GNUNET_DNSPARSER_hex_to_bin (const char *hex, |
884 | void *data); | 889 | void *data); |
885 | 890 | ||
891 | /** @} */ /* end of group */ | ||
886 | 892 | ||
887 | #endif | 893 | #endif |
diff --git a/src/include/gnunet_dnsstub_lib.h b/src/include/gnunet_dnsstub_lib.h index 164df18c6..08029cebf 100644 --- a/src/include/gnunet_dnsstub_lib.h +++ b/src/include/gnunet_dnsstub_lib.h | |||
@@ -19,9 +19,14 @@ | |||
19 | */ | 19 | */ |
20 | 20 | ||
21 | /** | 21 | /** |
22 | * @file include/gnunet_dnsstub_lib.h | ||
23 | * @brief API for helper library to send DNS requests to DNS resolver | ||
24 | * @author Christian Grothoff | 22 | * @author Christian Grothoff |
23 | * | ||
24 | * @file | ||
25 | * API for helper library to send DNS requests to DNS resolver | ||
26 | * | ||
27 | * @defgroup dns-stub DNS stub library | ||
28 | * Helper library to send DNS requests to DNS resolver | ||
29 | * @{ | ||
25 | */ | 30 | */ |
26 | #ifndef GNUNET_DNSSTUB_LIB_H | 31 | #ifndef GNUNET_DNSSTUB_LIB_H |
27 | #define GNUNET_DNSSTUB_LIB_H | 32 | #define GNUNET_DNSSTUB_LIB_H |
@@ -122,4 +127,6 @@ GNUNET_DNSSTUB_resolve2 (struct GNUNET_DNSSTUB_Context *ctx, | |||
122 | void | 127 | void |
123 | GNUNET_DNSSTUB_resolve_cancel (struct GNUNET_DNSSTUB_RequestSocket *rs); | 128 | GNUNET_DNSSTUB_resolve_cancel (struct GNUNET_DNSSTUB_RequestSocket *rs); |
124 | 129 | ||
130 | /** @} */ /* end of group */ | ||
131 | |||
125 | #endif | 132 | #endif |
diff --git a/src/include/gnunet_dv_service.h b/src/include/gnunet_dv_service.h index f694c17ea..aa33408ce 100644 --- a/src/include/gnunet_dv_service.h +++ b/src/include/gnunet_dv_service.h | |||
@@ -20,8 +20,15 @@ | |||
20 | 20 | ||
21 | /** | 21 | /** |
22 | * @author Christian Grothoff | 22 | * @author Christian Grothoff |
23 | * @file include/gnunet_dv_service.h | 23 | * |
24 | * @brief DV service API (should only be used by the DV plugin) | 24 | * @file |
25 | * DV service API (should only be used by the DV plugin) | ||
26 | * | ||
27 | * @defgroup dv DV service | ||
28 | * Distance vector routing | ||
29 | * | ||
30 | * The DV service API should only be used by the DV plugin. | ||
31 | * @{ | ||
25 | */ | 32 | */ |
26 | #ifndef GNUNET_SERVICE_DV_H | 33 | #ifndef GNUNET_SERVICE_DV_H |
27 | #define GNUNET_SERVICE_DV_H | 34 | #define GNUNET_SERVICE_DV_H |
@@ -165,5 +172,6 @@ GNUNET_DV_send (struct GNUNET_DV_ServiceHandle *sh, | |||
165 | void | 172 | void |
166 | GNUNET_DV_send_cancel (struct GNUNET_DV_TransmitHandle *th); | 173 | GNUNET_DV_send_cancel (struct GNUNET_DV_TransmitHandle *th); |
167 | 174 | ||
175 | /** @} */ /* end of group */ | ||
168 | 176 | ||
169 | #endif | 177 | #endif |
diff --git a/src/include/gnunet_env_lib.h b/src/include/gnunet_env_lib.h index 408a19a56..75fd62bbe 100644 --- a/src/include/gnunet_env_lib.h +++ b/src/include/gnunet_env_lib.h | |||
@@ -19,10 +19,18 @@ | |||
19 | */ | 19 | */ |
20 | 20 | ||
21 | /** | 21 | /** |
22 | * @file include/gnunet_env_lib.h | ||
23 | * @brief Library providing operations for the @e environment of | ||
24 | * PSYC and Social messages, and for (de)serializing variable values. | ||
25 | * @author Gabor X Toth | 22 | * @author Gabor X Toth |
23 | * | ||
24 | * @file | ||
25 | * Environment library | ||
26 | * | ||
27 | * @defgroup env Environment library | ||
28 | * Environment data structure for PSYC and Social messages. | ||
29 | * | ||
30 | * Library providing operations for the @e environment of | ||
31 | * PSYC and Social messages, and for (de)serializing variable values. | ||
32 | * | ||
33 | * @{ | ||
26 | */ | 34 | */ |
27 | 35 | ||
28 | 36 | ||
@@ -326,6 +334,8 @@ GNUNET_ENV_value_from_dict (struct GNUNET_CONTAINER_MultiHashMap *dict, size_t * | |||
326 | } | 334 | } |
327 | #endif | 335 | #endif |
328 | 336 | ||
337 | /** @} */ /* end of group */ | ||
338 | |||
329 | /* ifndef GNUNET_ENV_LIB_H */ | 339 | /* ifndef GNUNET_ENV_LIB_H */ |
330 | #endif | 340 | #endif |
331 | /* end of gnunet_env_lib.h */ | 341 | /* end of gnunet_env_lib.h */ |
diff --git a/src/include/gnunet_fragmentation_lib.h b/src/include/gnunet_fragmentation_lib.h index f39ad26a0..b408de3bf 100644 --- a/src/include/gnunet_fragmentation_lib.h +++ b/src/include/gnunet_fragmentation_lib.h | |||
@@ -18,11 +18,16 @@ | |||
18 | Boston, MA 02110-1301, USA. | 18 | Boston, MA 02110-1301, USA. |
19 | */ | 19 | */ |
20 | /** | 20 | /** |
21 | * @file include/gnunet_fragmentation_lib.h | ||
22 | * @brief library to help fragment messages | ||
23 | * @author Christian Grothoff | 21 | * @author Christian Grothoff |
24 | * | 22 | * |
25 | * TODO: consider additional flow-control for sending from | 23 | * @file |
24 | * Library to help fragment messages | ||
25 | * | ||
26 | * @defgroup fragmentation Fragmentation library | ||
27 | * Library to help fragment messages | ||
28 | * @{ | ||
29 | * | ||
30 | * @todo Consider additional flow-control for sending from | ||
26 | * fragmentation based on continuations. | 31 | * fragmentation based on continuations. |
27 | */ | 32 | */ |
28 | 33 | ||
@@ -213,6 +218,8 @@ GNUNET_DEFRAGMENT_process_fragment (struct GNUNET_DEFRAGMENT_Context *dc, | |||
213 | const struct GNUNET_MessageHeader *msg); | 218 | const struct GNUNET_MessageHeader *msg); |
214 | 219 | ||
215 | 220 | ||
221 | /** @} */ /* end of group */ | ||
222 | |||
216 | #if 0 /* keep Emacsens' auto-indent happy */ | 223 | #if 0 /* keep Emacsens' auto-indent happy */ |
217 | { | 224 | { |
218 | #endif | 225 | #endif |
diff --git a/src/include/gnunet_friends_lib.h b/src/include/gnunet_friends_lib.h index 0a757c4ef..2d8d231a5 100644 --- a/src/include/gnunet_friends_lib.h +++ b/src/include/gnunet_friends_lib.h | |||
@@ -19,9 +19,14 @@ | |||
19 | */ | 19 | */ |
20 | 20 | ||
21 | /** | 21 | /** |
22 | * @file include/gnunet_friends_lib.h | ||
23 | * @brief library to read and write the FRIENDS file | ||
24 | * @author Christian Grothoff | 22 | * @author Christian Grothoff |
23 | * | ||
24 | * @file | ||
25 | * Library to read and write the FRIENDS file | ||
26 | * | ||
27 | * @defgroup friends Friends library | ||
28 | * Library to read and write the FRIENDS file | ||
29 | * @{ | ||
25 | */ | 30 | */ |
26 | #ifndef GNUNET_FRIENDS_LIB_H | 31 | #ifndef GNUNET_FRIENDS_LIB_H |
27 | #define GNUNET_FRIENDS_LIB_H | 32 | #define GNUNET_FRIENDS_LIB_H |
@@ -99,8 +104,9 @@ int | |||
99 | GNUNET_FRIENDS_write (struct GNUNET_FRIENDS_Writer *w, | 104 | GNUNET_FRIENDS_write (struct GNUNET_FRIENDS_Writer *w, |
100 | const struct GNUNET_PeerIdentity *friend_id); | 105 | const struct GNUNET_PeerIdentity *friend_id); |
101 | 106 | ||
107 | /** @} */ /* end of group */ | ||
102 | 108 | ||
103 | #if 0 /* keep Emacsens' auto-indent happy */ | 109 | #if 0 /* keep Emacsens' auto-indent happy */ |
104 | { | 110 | { |
105 | #endif | 111 | #endif |
106 | #ifdef __cplusplus | 112 | #ifdef __cplusplus |
diff --git a/src/include/gnunet_fs_service.h b/src/include/gnunet_fs_service.h index 26757e558..736a67ae3 100644 --- a/src/include/gnunet_fs_service.h +++ b/src/include/gnunet_fs_service.h | |||
@@ -18,9 +18,14 @@ | |||
18 | Boston, MA 02110-1301, USA. | 18 | Boston, MA 02110-1301, USA. |
19 | */ | 19 | */ |
20 | /** | 20 | /** |
21 | * @file include/gnunet_fs_service.h | ||
22 | * @brief API for file-sharing via GNUnet | ||
23 | * @author Christian Grothoff | 21 | * @author Christian Grothoff |
22 | * | ||
23 | * @file | ||
24 | * API for file sharing via GNUnet | ||
25 | * | ||
26 | * @defgroup fs FS service | ||
27 | * File sharing | ||
28 | * @{ | ||
24 | */ | 29 | */ |
25 | #ifndef GNUNET_FS_LIB_H | 30 | #ifndef GNUNET_FS_LIB_H |
26 | #define GNUNET_FS_LIB_H | 31 | #define GNUNET_FS_LIB_H |
@@ -2746,7 +2751,7 @@ struct GNUNET_FS_ShareTreeItem | |||
2746 | 2751 | ||
2747 | 2752 | ||
2748 | /** | 2753 | /** |
2749 | * Opaqe handle to an asynchronous directory scanning activity. | 2754 | * Opaque handle to an asynchronous directory scanning activity. |
2750 | */ | 2755 | */ |
2751 | struct GNUNET_FS_DirScanner; | 2756 | struct GNUNET_FS_DirScanner; |
2752 | 2757 | ||
@@ -2809,6 +2814,7 @@ GNUNET_FS_share_tree_trim (struct GNUNET_FS_ShareTreeItem *toplevel); | |||
2809 | void | 2814 | void |
2810 | GNUNET_FS_share_tree_free (struct GNUNET_FS_ShareTreeItem *toplevel); | 2815 | GNUNET_FS_share_tree_free (struct GNUNET_FS_ShareTreeItem *toplevel); |
2811 | 2816 | ||
2817 | /** @} */ /* end of group */ | ||
2812 | 2818 | ||
2813 | #if 0 /* keep Emacsens' auto-indent happy */ | 2819 | #if 0 /* keep Emacsens' auto-indent happy */ |
2814 | { | 2820 | { |
diff --git a/src/include/gnunet_getopt_lib.h b/src/include/gnunet_getopt_lib.h index 11916ac80..59b0c9d4c 100644 --- a/src/include/gnunet_getopt_lib.h +++ b/src/include/gnunet_getopt_lib.h | |||
@@ -19,10 +19,13 @@ | |||
19 | */ | 19 | */ |
20 | 20 | ||
21 | /** | 21 | /** |
22 | * @file include/gnunet_getopt_lib.h | ||
23 | * @brief command line parsing and --help formatting | ||
24 | * @author Christian Grothoff | 22 | * @author Christian Grothoff |
25 | * @defgroup getopt command-line parsing | 23 | * |
24 | * @file | ||
25 | * Command line parsing and --help formatting | ||
26 | * | ||
27 | * @defgroup getopt Getopt library | ||
28 | * Command line parsing and --help formatting | ||
26 | * @{ | 29 | * @{ |
27 | */ | 30 | */ |
28 | 31 | ||
diff --git a/src/include/gnunet_gns_service.h b/src/include/gnunet_gns_service.h index c4b4a4962..b24d9a64a 100644 --- a/src/include/gnunet_gns_service.h +++ b/src/include/gnunet_gns_service.h | |||
@@ -19,9 +19,14 @@ | |||
19 | */ | 19 | */ |
20 | 20 | ||
21 | /** | 21 | /** |
22 | * @file include/gnunet_gns_service.h | ||
23 | * @brief API to the GNS service | ||
24 | * @author Martin Schanzenbach | 22 | * @author Martin Schanzenbach |
23 | * | ||
24 | * @file | ||
25 | * API to the GNS service | ||
26 | * | ||
27 | * @defgroup gns GNS service | ||
28 | * GNU Name System | ||
29 | * @{ | ||
25 | */ | 30 | */ |
26 | #ifndef GNUNET_GNS_SERVICE_H | 31 | #ifndef GNUNET_GNS_SERVICE_H |
27 | #define GNUNET_GNS_SERVICE_H | 32 | #define GNUNET_GNS_SERVICE_H |
@@ -101,7 +106,7 @@ enum GNUNET_GNS_LocalOptions | |||
101 | * Never look in the DHT, keep request to local cache. | 106 | * Never look in the DHT, keep request to local cache. |
102 | */ | 107 | */ |
103 | GNUNET_GNS_LO_NO_DHT = 1, | 108 | GNUNET_GNS_LO_NO_DHT = 1, |
104 | 109 | ||
105 | /** | 110 | /** |
106 | * For the rightmost label, only look in the cache (it | 111 | * For the rightmost label, only look in the cache (it |
107 | * is our master zone), for the others, the DHT is OK. | 112 | * is our master zone), for the others, the DHT is OK. |
@@ -147,6 +152,7 @@ GNUNET_GNS_lookup (struct GNUNET_GNS_Handle *handle, | |||
147 | void | 152 | void |
148 | GNUNET_GNS_lookup_cancel (struct GNUNET_GNS_LookupRequest *lr); | 153 | GNUNET_GNS_lookup_cancel (struct GNUNET_GNS_LookupRequest *lr); |
149 | 154 | ||
155 | /** @} */ /* end of group */ | ||
150 | 156 | ||
151 | #if 0 /* keep Emacsens' auto-indent happy */ | 157 | #if 0 /* keep Emacsens' auto-indent happy */ |
152 | { | 158 | { |
diff --git a/src/include/gnunet_gnsrecord_lib.h b/src/include/gnunet_gnsrecord_lib.h index 718365f95..110646563 100644 --- a/src/include/gnunet_gnsrecord_lib.h +++ b/src/include/gnunet_gnsrecord_lib.h | |||
@@ -19,9 +19,14 @@ | |||
19 | */ | 19 | */ |
20 | 20 | ||
21 | /** | 21 | /** |
22 | * @file include/gnunet_gnsrecord_lib.h | ||
23 | * @brief API that can be used to manipulate GNS record data | ||
24 | * @author Christian Grothoff | 22 | * @author Christian Grothoff |
23 | * | ||
24 | * @file | ||
25 | * API that can be used to manipulate GNS record data | ||
26 | * | ||
27 | * @defgroup gns-record GNS record library | ||
28 | * Manipulate GNS record data | ||
29 | * @{ | ||
25 | */ | 30 | */ |
26 | #ifndef GNUNET_GNSRECORD_LIB_H | 31 | #ifndef GNUNET_GNSRECORD_LIB_H |
27 | #define GNUNET_GNSRECORD_LIB_H | 32 | #define GNUNET_GNSRECORD_LIB_H |
@@ -558,7 +563,7 @@ struct GNUNET_TIME_Absolute | |||
558 | GNUNET_GNSRECORD_record_get_expiration_time (unsigned int rd_count, | 563 | GNUNET_GNSRECORD_record_get_expiration_time (unsigned int rd_count, |
559 | const struct GNUNET_GNSRECORD_Data *rd); | 564 | const struct GNUNET_GNSRECORD_Data *rd); |
560 | 565 | ||
561 | 566 | /** @} */ /* end of group */ | |
562 | 567 | ||
563 | #if 0 /* keep Emacsens' auto-indent happy */ | 568 | #if 0 /* keep Emacsens' auto-indent happy */ |
564 | { | 569 | { |
diff --git a/src/include/gnunet_gnsrecord_plugin.h b/src/include/gnunet_gnsrecord_plugin.h index b0b492634..7315ec879 100644 --- a/src/include/gnunet_gnsrecord_plugin.h +++ b/src/include/gnunet_gnsrecord_plugin.h | |||
@@ -19,11 +19,15 @@ | |||
19 | */ | 19 | */ |
20 | 20 | ||
21 | /** | 21 | /** |
22 | * @file include/gnunet_gnsrecord_plugin.h | ||
23 | * @brief plugin API for GNS record types | ||
24 | * @author Christian Grothoff | 22 | * @author Christian Grothoff |
25 | * @defgroup gnsrecordplugin API to be implemented by applications defining new GNS record types | 23 | * |
26 | * @{ */ | 24 | * @file |
25 | * Plugin API for GNS record types | ||
26 | * | ||
27 | * @defgroup gns-record-plugin GNS record plugin API | ||
28 | * To be implemented by applications defining new record types. | ||
29 | * @{ | ||
30 | */ | ||
27 | #ifndef GNUNET_GNSRECORD_PLUGIN_H | 31 | #ifndef GNUNET_GNSRECORD_PLUGIN_H |
28 | #define GNUNET_GNSRECORD_PLUGIN_H | 32 | #define GNUNET_GNSRECORD_PLUGIN_H |
29 | 33 | ||
@@ -129,8 +133,7 @@ struct GNUNET_GNSRECORD_PluginFunctions | |||
129 | 133 | ||
130 | }; | 134 | }; |
131 | 135 | ||
132 | 136 | /** @} */ /* end of group */ | |
133 | /** @} */ /* end of group gnsrecordplugin */ | ||
134 | 137 | ||
135 | #if 0 /* keep Emacsens' auto-indent happy */ | 138 | #if 0 /* keep Emacsens' auto-indent happy */ |
136 | { | 139 | { |
diff --git a/src/include/gnunet_hello_lib.h b/src/include/gnunet_hello_lib.h index f7f4780f0..506566d40 100644 --- a/src/include/gnunet_hello_lib.h +++ b/src/include/gnunet_hello_lib.h | |||
@@ -19,9 +19,13 @@ | |||
19 | */ | 19 | */ |
20 | 20 | ||
21 | /** | 21 | /** |
22 | * @file include/gnunet_hello_lib.h | ||
23 | * @brief helper library for handling HELLOs | ||
24 | * @author Christian Grothoff | 22 | * @author Christian Grothoff |
23 | * @file | ||
24 | * Helper library for handling HELLOs | ||
25 | * | ||
26 | * @defgroup hello Hello library | ||
27 | * Helper library for handling HELLOs | ||
28 | * @{ | ||
25 | */ | 29 | */ |
26 | 30 | ||
27 | #ifndef GNUNET_HELLO_LIB_H | 31 | #ifndef GNUNET_HELLO_LIB_H |
@@ -439,6 +443,8 @@ GNUNET_HELLO_parse_uri (const char *uri, | |||
439 | struct GNUNET_HELLO_Message **hello, | 443 | struct GNUNET_HELLO_Message **hello, |
440 | GNUNET_HELLO_TransportPluginsFind plugins_find); | 444 | GNUNET_HELLO_TransportPluginsFind plugins_find); |
441 | 445 | ||
446 | /** @} */ /* end of group */ | ||
447 | |||
442 | #if 0 /* keep Emacsens' auto-indent happy */ | 448 | #if 0 /* keep Emacsens' auto-indent happy */ |
443 | { | 449 | { |
444 | #endif | 450 | #endif |
diff --git a/src/include/gnunet_helper_lib.h b/src/include/gnunet_helper_lib.h index 7cccecad5..1fee1ac01 100644 --- a/src/include/gnunet_helper_lib.h +++ b/src/include/gnunet_helper_lib.h | |||
@@ -19,11 +19,19 @@ | |||
19 | */ | 19 | */ |
20 | 20 | ||
21 | /** | 21 | /** |
22 | * @file include/gnunet_helper_lib.h | ||
23 | * @brief API for dealing with (SUID) helper processes that communicate via | ||
24 | * GNUNET_MessageHeaders on stdin/stdout | ||
25 | * @author Philipp Toelke | 22 | * @author Philipp Toelke |
26 | * @author Christian Grothoff | 23 | * @author Christian Grothoff |
24 | * | ||
25 | * @file | ||
26 | * API for dealing with SUID helper processes | ||
27 | * | ||
28 | * @defgroup helper Helper library | ||
29 | * Dealing with SUID helper processes. | ||
30 | * | ||
31 | * Provides an API for dealing with (SUID) helper processes | ||
32 | * that communicate via GNUNET_MessageHeaders on STDIN/STDOUT. | ||
33 | * | ||
34 | * @{ | ||
27 | */ | 35 | */ |
28 | 36 | ||
29 | #ifndef GNUNET_HELPER_LIB_H | 37 | #ifndef GNUNET_HELPER_LIB_H |
@@ -166,5 +174,7 @@ GNUNET_HELPER_send (struct GNUNET_HELPER_Handle *h, | |||
166 | void | 174 | void |
167 | GNUNET_HELPER_send_cancel (struct GNUNET_HELPER_SendHandle *sh); | 175 | GNUNET_HELPER_send_cancel (struct GNUNET_HELPER_SendHandle *sh); |
168 | 176 | ||
177 | /** @} */ /* end of group */ | ||
178 | |||
169 | #endif | 179 | #endif |
170 | /* end of include guard: GNUNET_HELPER_LIB_H */ | 180 | /* end of include guard: GNUNET_HELPER_LIB_H */ |
diff --git a/src/include/gnunet_identity_provider_service.h b/src/include/gnunet_identity_provider_service.h index a923f5c2f..1e05244c8 100644 --- a/src/include/gnunet_identity_provider_service.h +++ b/src/include/gnunet_identity_provider_service.h | |||
@@ -19,19 +19,12 @@ | |||
19 | */ | 19 | */ |
20 | 20 | ||
21 | /** | 21 | /** |
22 | * @file include/gnunet_identity_provider_service.h | ||
23 | * @brief Identity provider service; implements identity provider for GNUnet | ||
24 | * @author Martin Schanzenbach | 22 | * @author Martin Schanzenbach |
25 | * | 23 | * |
26 | * Egos in GNUnet are ECDSA keys. You assume an ego by using (signing | 24 | * @file |
27 | * with) a particular private key. As GNUnet users are expected to | 25 | * Identity provider service; implements identity provider for GNUnet |
28 | * have many egos, we need an identity service to allow users to | ||
29 | * manage their egos. The identity service manages the egos (private | ||
30 | * keys) of the local user; it does NOT manage egos of other users | ||
31 | * (public keys). For giving names to other users and manage their | ||
32 | * public keys securely, we use GNS. | ||
33 | * | 26 | * |
34 | * @defgroup identity-provider service | 27 | * @defgroup identity-provider Identity provider service |
35 | * @{ | 28 | * @{ |
36 | */ | 29 | */ |
37 | #ifndef GNUNET_IDENTITY_PROVIDER_SERVICE_H | 30 | #ifndef GNUNET_IDENTITY_PROVIDER_SERVICE_H |
diff --git a/src/include/gnunet_identity_service.h b/src/include/gnunet_identity_service.h index f1a4b31e9..4622e20a9 100644 --- a/src/include/gnunet_identity_service.h +++ b/src/include/gnunet_identity_service.h | |||
@@ -19,10 +19,14 @@ | |||
19 | */ | 19 | */ |
20 | 20 | ||
21 | /** | 21 | /** |
22 | * @file include/gnunet_identity_service.h | ||
23 | * @brief Identity service; implements identity management for GNUnet | ||
24 | * @author Christian Grothoff | 22 | * @author Christian Grothoff |
25 | * | 23 | * |
24 | * @file | ||
25 | * Identity service; implements identity management for GNUnet | ||
26 | * | ||
27 | * @defgroup identity Identity service | ||
28 | * Identity management. | ||
29 | * | ||
26 | * Egos in GNUnet are ECDSA keys. You assume an ego by using (signing | 30 | * Egos in GNUnet are ECDSA keys. You assume an ego by using (signing |
27 | * with) a particular private key. As GNUnet users are expected to | 31 | * with) a particular private key. As GNUnet users are expected to |
28 | * have many egos, we need an identity service to allow users to | 32 | * have many egos, we need an identity service to allow users to |
@@ -31,7 +35,6 @@ | |||
31 | * (public keys). For giving names to other users and manage their | 35 | * (public keys). For giving names to other users and manage their |
32 | * public keys securely, we use GNS. | 36 | * public keys securely, we use GNS. |
33 | * | 37 | * |
34 | * @defgroup identity identity management service | ||
35 | * @{ | 38 | * @{ |
36 | */ | 39 | */ |
37 | #ifndef GNUNET_IDENTITY_SERVICE_H | 40 | #ifndef GNUNET_IDENTITY_SERVICE_H |
diff --git a/src/include/gnunet_load_lib.h b/src/include/gnunet_load_lib.h index 986e82656..22e327bf7 100644 --- a/src/include/gnunet_load_lib.h +++ b/src/include/gnunet_load_lib.h | |||
@@ -19,9 +19,14 @@ | |||
19 | */ | 19 | */ |
20 | 20 | ||
21 | /** | 21 | /** |
22 | * @file include/gnunet_load_lib.h | ||
23 | * @brief functions related to load calculations | ||
24 | * @author Christian Grothoff | 22 | * @author Christian Grothoff |
23 | * | ||
24 | * @file | ||
25 | * Functions related to load calculations | ||
26 | * | ||
27 | * @defgroup load Load library | ||
28 | * Load calculations. | ||
29 | * @{ | ||
25 | */ | 30 | */ |
26 | 31 | ||
27 | #ifndef GNUNET_LOAD_LIB_H | 32 | #ifndef GNUNET_LOAD_LIB_H |
@@ -106,6 +111,7 @@ GNUNET_LOAD_get_average (struct GNUNET_LOAD_Value *load); | |||
106 | void | 111 | void |
107 | GNUNET_LOAD_update (struct GNUNET_LOAD_Value *load, uint64_t data); | 112 | GNUNET_LOAD_update (struct GNUNET_LOAD_Value *load, uint64_t data); |
108 | 113 | ||
114 | /** @} */ /* end of group */ | ||
109 | 115 | ||
110 | #if 0 /* keep Emacsens' auto-indent happy */ | 116 | #if 0 /* keep Emacsens' auto-indent happy */ |
111 | { | 117 | { |
diff --git a/src/include/gnunet_microphone_lib.h b/src/include/gnunet_microphone_lib.h index 96a5e5f07..0d84bfdfc 100644 --- a/src/include/gnunet_microphone_lib.h +++ b/src/include/gnunet_microphone_lib.h | |||
@@ -19,11 +19,16 @@ | |||
19 | */ | 19 | */ |
20 | 20 | ||
21 | /** | 21 | /** |
22 | * @file include/gnunet_microphone_lib.h | ||
23 | * @brief API to access an audio microphone; provides access to hardware microphones | ||
24 | * @author Simon Dieterle | 22 | * @author Simon Dieterle |
25 | * @author Andreas Fuchs | 23 | * @author Andreas Fuchs |
26 | * @author Christian Grothoff | 24 | * @author Christian Grothoff |
25 | * | ||
26 | * @file | ||
27 | * API to access an audio microphone; provides access to hardware microphones | ||
28 | * | ||
29 | * @defgroup microphone Microphone library | ||
30 | * Provides access to hardware microphones. | ||
31 | * @{ | ||
27 | */ | 32 | */ |
28 | #ifndef GNUNET_MICROPHONE_SERVICE_H | 33 | #ifndef GNUNET_MICROPHONE_SERVICE_H |
29 | #define GNUNET_MICROPHONE_SERVICE_H | 34 | #define GNUNET_MICROPHONE_SERVICE_H |
@@ -124,6 +129,7 @@ GNUNET_MICROPHONE_create_from_hardware (const struct GNUNET_CONFIGURATION_Handle | |||
124 | void | 129 | void |
125 | GNUNET_MICROPHONE_destroy (struct GNUNET_MICROPHONE_Handle *microphone); | 130 | GNUNET_MICROPHONE_destroy (struct GNUNET_MICROPHONE_Handle *microphone); |
126 | 131 | ||
132 | /** @} */ /* end of group */ | ||
127 | 133 | ||
128 | #if 0 /* keep Emacsens' auto-indent happy */ | 134 | #if 0 /* keep Emacsens' auto-indent happy */ |
129 | { | 135 | { |
diff --git a/src/include/gnunet_mq_lib.h b/src/include/gnunet_mq_lib.h index 5936f3ca2..1c16b8630 100644 --- a/src/include/gnunet_mq_lib.h +++ b/src/include/gnunet_mq_lib.h | |||
@@ -20,9 +20,12 @@ | |||
20 | 20 | ||
21 | /** | 21 | /** |
22 | * @author Florian Dold | 22 | * @author Florian Dold |
23 | * @file include/gnunet_mq_lib.h | 23 | * |
24 | * @brief general purpose message queue | 24 | * @file |
25 | * @defgroup mq general purpose message queue | 25 | * General-purpose message queue |
26 | * | ||
27 | * @defgroup mq MQ library | ||
28 | * General-purpose message queue | ||
26 | * @{ | 29 | * @{ |
27 | */ | 30 | */ |
28 | #ifndef GNUNET_MQ_H | 31 | #ifndef GNUNET_MQ_H |
diff --git a/src/include/gnunet_multicast_service.h b/src/include/gnunet_multicast_service.h index 5503eb3a9..a8e4a99f6 100644 --- a/src/include/gnunet_multicast_service.h +++ b/src/include/gnunet_multicast_service.h | |||
@@ -19,10 +19,15 @@ | |||
19 | */ | 19 | */ |
20 | 20 | ||
21 | /** | 21 | /** |
22 | * @file include/gnunet_multicast_service.h | ||
23 | * @brief multicast service; establish tunnels to distant peers | ||
24 | * @author Christian Grothoff | ||
25 | * @author Gabor X Toth | 22 | * @author Gabor X Toth |
23 | * @author Christian Grothoff | ||
24 | * | ||
25 | * @file | ||
26 | * Multicast service; multicast messaging via CADET | ||
27 | * | ||
28 | * @defgroup multicast Multicast service | ||
29 | * Multicast messaging via CADET. | ||
30 | * @{ | ||
26 | */ | 31 | */ |
27 | 32 | ||
28 | #ifndef GNUNET_MULTICAST_SERVICE_H | 33 | #ifndef GNUNET_MULTICAST_SERVICE_H |
@@ -897,6 +902,7 @@ GNUNET_MULTICAST_member_to_origin_resume (struct GNUNET_MULTICAST_MemberTransmit | |||
897 | void | 902 | void |
898 | GNUNET_MULTICAST_member_to_origin_cancel (struct GNUNET_MULTICAST_MemberTransmitHandle *th); | 903 | GNUNET_MULTICAST_member_to_origin_cancel (struct GNUNET_MULTICAST_MemberTransmitHandle *th); |
899 | 904 | ||
905 | /** @} */ /* end of group */ | ||
900 | 906 | ||
901 | #if 0 /* keep Emacsens' auto-indent happy */ | 907 | #if 0 /* keep Emacsens' auto-indent happy */ |
902 | { | 908 | { |
diff --git a/src/include/gnunet_mysql_lib.h b/src/include/gnunet_mysql_lib.h index 96e3b9e49..83b10cf79 100644 --- a/src/include/gnunet_mysql_lib.h +++ b/src/include/gnunet_mysql_lib.h | |||
@@ -18,9 +18,14 @@ | |||
18 | Boston, MA 02110-1301, USA. | 18 | Boston, MA 02110-1301, USA. |
19 | */ | 19 | */ |
20 | /** | 20 | /** |
21 | * @file include/gnunet_mysql_lib.h | ||
22 | * @brief library to help with access to a MySQL database | ||
23 | * @author Christian Grothoff | 21 | * @author Christian Grothoff |
22 | * | ||
23 | * @file | ||
24 | * Helper library to access a MySQL database | ||
25 | * | ||
26 | * @defgroup mysql MySQL library | ||
27 | * Helper library to access a MySQL database. | ||
28 | * @{ | ||
24 | */ | 29 | */ |
25 | #ifndef GNUNET_MYSQL_LIB_H | 30 | #ifndef GNUNET_MYSQL_LIB_H |
26 | #define GNUNET_MYSQL_LIB_H | 31 | #define GNUNET_MYSQL_LIB_H |
@@ -202,6 +207,7 @@ GNUNET_MYSQL_statement_run_prepared (struct GNUNET_MYSQL_Context *mc, | |||
202 | struct GNUNET_MYSQL_StatementHandle *sh, | 207 | struct GNUNET_MYSQL_StatementHandle *sh, |
203 | unsigned long long *insert_id, ...); | 208 | unsigned long long *insert_id, ...); |
204 | 209 | ||
210 | /** @} */ /* end of group */ | ||
205 | 211 | ||
206 | #if 0 /* keep Emacsens' auto-indent happy */ | 212 | #if 0 /* keep Emacsens' auto-indent happy */ |
207 | { | 213 | { |
diff --git a/src/include/gnunet_nse_service.h b/src/include/gnunet_nse_service.h index 4e4c10987..365b35d9b 100644 --- a/src/include/gnunet_nse_service.h +++ b/src/include/gnunet_nse_service.h | |||
@@ -22,12 +22,13 @@ | |||
22 | #define GNUNET_NSE_SERVICE_H_ | 22 | #define GNUNET_NSE_SERVICE_H_ |
23 | 23 | ||
24 | /** | 24 | /** |
25 | * @file include/gnunet_nse_service.h | 25 | * @file |
26 | * @brief API to retrieve the current network size estimate, | 26 | * API to retrieve the current network size estimate, |
27 | * also to register for notifications whenever a new | 27 | * also to register for notifications whenever a new |
28 | * network size estimate is calculated. | 28 | * network size estimate is calculated. |
29 | * | ||
29 | * @author Nathan Evans | 30 | * @author Nathan Evans |
30 | * @defgroup nse network size estimation service | 31 | * @defgroup nse Network size estimation service |
31 | * @{ | 32 | * @{ |
32 | */ | 33 | */ |
33 | 34 | ||
diff --git a/src/include/gnunet_os_lib.h b/src/include/gnunet_os_lib.h index 431988042..bb0840029 100644 --- a/src/include/gnunet_os_lib.h +++ b/src/include/gnunet_os_lib.h | |||
@@ -19,8 +19,9 @@ | |||
19 | */ | 19 | */ |
20 | 20 | ||
21 | /** | 21 | /** |
22 | * @file include/gnunet_os_lib.h | 22 | * @file |
23 | * @brief low level process routines | 23 | * Low level process routines |
24 | * | ||
24 | * @author Christian Grothoff | 25 | * @author Christian Grothoff |
25 | * @author Krista Bennett | 26 | * @author Krista Bennett |
26 | * @author Gerd Knorr <kraxel@bytesex.org> | 27 | * @author Gerd Knorr <kraxel@bytesex.org> |
diff --git a/src/include/gnunet_program_lib.h b/src/include/gnunet_program_lib.h index ac176f42c..85c802285 100644 --- a/src/include/gnunet_program_lib.h +++ b/src/include/gnunet_program_lib.h | |||
@@ -19,10 +19,11 @@ | |||
19 | */ | 19 | */ |
20 | 20 | ||
21 | /** | 21 | /** |
22 | * @file include/gnunet_program_lib.h | 22 | * @file |
23 | * @brief functions related to starting programs | 23 | * Functions related to starting programs |
24 | * | ||
24 | * @author Christian Grothoff | 25 | * @author Christian Grothoff |
25 | * @defgroup program functions for writing command-line programs | 26 | * @defgroup program Functions for writing command-line programs |
26 | * @{ | 27 | * @{ |
27 | */ | 28 | */ |
28 | 29 | ||
diff --git a/src/include/gnunet_protocols.h b/src/include/gnunet_protocols.h index 2d1fbbd62..a3e4199a4 100644 --- a/src/include/gnunet_protocols.h +++ b/src/include/gnunet_protocols.h | |||
@@ -2640,6 +2640,9 @@ extern "C" | |||
2640 | /** S->C: notify about an existing place */ | 2640 | /** S->C: notify about an existing place */ |
2641 | #define GNUNET_MESSAGE_TYPE_SOCIAL_APP_PLACE 854 | 2641 | #define GNUNET_MESSAGE_TYPE_SOCIAL_APP_PLACE 854 |
2642 | 2642 | ||
2643 | /** S->C: */ | ||
2644 | #define GNUNET_MESSAGE_TYPE_SOCIAL_HOST_RELAY 855 | ||
2645 | |||
2643 | /******************************************************************************* | 2646 | /******************************************************************************* |
2644 | * X-VINE DHT messages | 2647 | * X-VINE DHT messages |
2645 | ******************************************************************************/ | 2648 | ******************************************************************************/ |
diff --git a/src/include/gnunet_resolver_service.h b/src/include/gnunet_resolver_service.h index bb63fb86f..3806cbdcf 100644 --- a/src/include/gnunet_resolver_service.h +++ b/src/include/gnunet_resolver_service.h | |||
@@ -19,10 +19,13 @@ | |||
19 | */ | 19 | */ |
20 | 20 | ||
21 | /** | 21 | /** |
22 | * @file include/gnunet_resolver_service.h | ||
23 | * @brief functions related to doing DNS lookups | ||
24 | * @author Christian Grothoff | 22 | * @author Christian Grothoff |
25 | * @defgroup resolver asynchronous standard DNS lookups | 23 | * |
24 | * @file | ||
25 | * Functions related to doing DNS lookups | ||
26 | * | ||
27 | * @defgroup resolver Resolver service | ||
28 | * Asynchronous standard DNS lookups | ||
26 | * @{ | 29 | * @{ |
27 | */ | 30 | */ |
28 | 31 | ||
diff --git a/src/include/gnunet_revocation_service.h b/src/include/gnunet_revocation_service.h index c7f487fd4..919f62db9 100644 --- a/src/include/gnunet_revocation_service.h +++ b/src/include/gnunet_revocation_service.h | |||
@@ -25,7 +25,7 @@ | |||
25 | * @file include/gnunet_revocation_service.h | 25 | * @file include/gnunet_revocation_service.h |
26 | * @brief API to perform and access key revocations | 26 | * @brief API to perform and access key revocations |
27 | * @author Christian Grothoff | 27 | * @author Christian Grothoff |
28 | * @defgroup revocation key revocation service | 28 | * @defgroup revocation Key revocation service |
29 | * @{ | 29 | * @{ |
30 | */ | 30 | */ |
31 | 31 | ||
diff --git a/src/include/gnunet_server_lib.h b/src/include/gnunet_server_lib.h index 71ab07e08..b1be9ee3a 100644 --- a/src/include/gnunet_server_lib.h +++ b/src/include/gnunet_server_lib.h | |||
@@ -22,7 +22,7 @@ | |||
22 | * @file include/gnunet_server_lib.h | 22 | * @file include/gnunet_server_lib.h |
23 | * @brief library for building GNUnet network servers | 23 | * @brief library for building GNUnet network servers |
24 | * @author Christian Grothoff | 24 | * @author Christian Grothoff |
25 | * @defgroup server functions for a server that communicates with clients | 25 | * @defgroup server Functions for a server that communicates with clients |
26 | * @{ | 26 | * @{ |
27 | */ | 27 | */ |
28 | 28 | ||
diff --git a/src/include/gnunet_service_lib.h b/src/include/gnunet_service_lib.h index 6cb7413d3..9f3947dda 100644 --- a/src/include/gnunet_service_lib.h +++ b/src/include/gnunet_service_lib.h | |||
@@ -22,7 +22,7 @@ | |||
22 | * @file include/gnunet_service_lib.h | 22 | * @file include/gnunet_service_lib.h |
23 | * @brief functions related to starting services | 23 | * @brief functions related to starting services |
24 | * @author Christian Grothoff | 24 | * @author Christian Grothoff |
25 | * @defgroup service generic functions for implementing service processes | 25 | * @defgroup service Generic functions for implementing service processes |
26 | * @{ | 26 | * @{ |
27 | */ | 27 | */ |
28 | 28 | ||
diff --git a/src/include/gnunet_social_service.h b/src/include/gnunet_social_service.h index bde3dbceb..c5e55bbab 100644 --- a/src/include/gnunet_social_service.h +++ b/src/include/gnunet_social_service.h | |||
@@ -19,11 +19,191 @@ | |||
19 | */ | 19 | */ |
20 | 20 | ||
21 | /** | 21 | /** |
22 | * @file include/gnunet_social_service.h | ||
23 | * @brief Social service; implements social interactions using the PSYC service. | ||
24 | * @author Gabor X Toth | 22 | * @author Gabor X Toth |
25 | * @author Christian Grothoff | 23 | * @author Christian Grothoff |
24 | * | ||
25 | * @file | ||
26 | * Social service; implements social interactions through the PSYC service. | ||
26 | */ | 27 | */ |
28 | |||
29 | /** @defgroup social Social service | ||
30 | Social interactions through the PSYC service. | ||
31 | |||
32 | # Overview | ||
33 | |||
34 | The social service provides an API for social interactions based on a one-to-many messaging model. | ||
35 | It manages subscriptions of applications to places, provides messaging functionality in places, | ||
36 | allows access to the local message history and manages the GNS zone of _egos_ (user identities). | ||
37 | |||
38 | The service stores private and public keys of subscribed places, as well as files received in subscribed places. | ||
39 | |||
40 | # Concepts and terminology | ||
41 | |||
42 | ## Ego, Nym | ||
43 | |||
44 | An _ego_ is an identity of a user, a private-public key pair. | ||
45 | A _nym_ is an identity of another user in the network, identified by its public key. | ||
46 | Each user can have multiple identities. | ||
47 | |||
48 | struct GNUNET_SOCIAL_Ego and struct GNUNET_SOCIAL_Nym represents one of these identities. | ||
49 | |||
50 | ## Place, Host, Guest | ||
51 | |||
52 | A _place_ is where social interactions happen. It is owned and created by an _ego_. | ||
53 | Creating a new place happens by an _ego_ entering a new place as a _host_, | ||
54 | where _guests_ can enter later to receive messages sent to the place. | ||
55 | |||
56 | A place is identified by its public key. | ||
57 | |||
58 | - struct GNUNET_SOCIAL_Host represents a place entered as host, | ||
59 | - struct GNUNET_SOCIAL_Guest is used for a place entered as guest. | ||
60 | - A struct GNUNET_SOCIAL_Place can be obtained for both a host and guest place | ||
61 | using GNUNET_SOCIAL_host_get_place() and GNUNET_SOCIAL_guest_get_place() | ||
62 | and can be used with API functions common to hosts and guests. | ||
63 | |||
64 | ## History | ||
65 | |||
66 | Messages sent to places are stored locally by the PSYCstore service, and can be queried any time. | ||
67 | GNUNET_SOCIAL_history_replay_latest() retrieves the latest N messages sent to the place, | ||
68 | while GNUNET_SOCIAL_history_replay() is used to query a given message ID range. | ||
69 | |||
70 | ## GNU Name System | ||
71 | |||
72 | The GNU Name System is used for assigning human-readable names to nyms and places. | ||
73 | There's a _GNS zone_ corresponding to each _nym_. | ||
74 | An _ego_ can publish PKEY and PLACE records in its own zone, pointing to nyms and places, respectively. | ||
75 | |||
76 | ## Announcement, talk request | ||
77 | |||
78 | The host can _announce_ messages to the place, using GNUNET_SOCIAL_host_announce(). | ||
79 | Guests can send _talk_ requests to the host, using GNUNET_SOCIAL_guest_talk(). | ||
80 | The host receives talk requests of guests and can _relay_ them to the place, | ||
81 | or process it using a message handler function. | ||
82 | |||
83 | # Using the API | ||
84 | |||
85 | ## Connecting to the service | ||
86 | |||
87 | A client first establishes an _application connection_ to the service using | ||
88 | GNUNET_SOCIAL_app_connect() providing its _application ID_, then receives the | ||
89 | public keys of subscribed places and available egos and in response. | ||
90 | |||
91 | ## Reconnecting to places | ||
92 | |||
93 | Then the application can reconnect to its subscribed places by establishing | ||
94 | _place connections_ with GNUNET_SOCIAL_host_enter_reconnect() and | ||
95 | GNUNET_SOCIAL_guest_enter_reconnect(). | ||
96 | |||
97 | ## Subscribing to a place | ||
98 | |||
99 | Entering and subscribing a new host or guest place is done using | ||
100 | GNUNET_SOCIAL_host_enter() and GNUNET_SOCIAL_guest_enter(). | ||
101 | |||
102 | ## Disconnecting from a place | ||
103 | |||
104 | An application can disconnect from a place while the social service keeps its | ||
105 | network connection active, using GNUNET_SOCIAL_host_disconnect() and | ||
106 | GNUNET_SOCIAL_guest_disconnect(). | ||
107 | |||
108 | ## Leaving a place | ||
109 | |||
110 | To permanently leave a place, see GNUNET_SOCIAL_host_leave() and GNUNET_SOCIAL_guest_leave(). | ||
111 | When leaving a place its network connections are closed and all applications are unsubscribed from the place. | ||
112 | |||
113 | # Methods | ||
114 | |||
115 | ## _message | ||
116 | |||
117 | A message sent to the place. | ||
118 | |||
119 | ### Environment | ||
120 | |||
121 | #### _id_reply_to | ||
122 | message ID this message is in reply to. | ||
123 | |||
124 | #### _id_thread | ||
125 | |||
126 | thread ID, the first message ID in the thread. | ||
127 | |||
128 | #### _nym_author__ | ||
129 | nym of the author. | ||
130 | |||
131 | #### _sig_author | ||
132 | signature of the message body and its variables by the author. | ||
133 | |||
134 | ## Data | ||
135 | |||
136 | Message body. | ||
137 | |||
138 | ## _notice_place | ||
139 | |||
140 | Notification about a place. | ||
141 | |||
142 | TODO: Applications can decide to auto-subscribe to certain places, | ||
143 | e.g. files under a given size. | ||
144 | |||
145 | ### Environment | ||
146 | |||
147 | #### Using GNS | ||
148 | |||
149 | ##### _gns_place | ||
150 | GNS name of the place in a globally unique .zkey zone | ||
151 | |||
152 | #### Without GNS | ||
153 | |||
154 | ##### _key_pub_place | ||
155 | public key of place | ||
156 | |||
157 | ##### _peer_origin | ||
158 | peer ID of origin | ||
159 | |||
160 | ##### _list_peer_relays | ||
161 | list of peer IDs of relays | ||
162 | |||
163 | ## _notice_place_file | ||
164 | |||
165 | Notification about a place hosting a file. | ||
166 | |||
167 | ### Environment | ||
168 | |||
169 | The environment of _notice_place above, plus the following: | ||
170 | |||
171 | #### _size_file | ||
172 | size of file | ||
173 | |||
174 | #### _mime_file | ||
175 | MIME type of file | ||
176 | |||
177 | #### _name_file | ||
178 | name of file | ||
179 | |||
180 | #### _description_file | ||
181 | description of file | ||
182 | |||
183 | ## _file | ||
184 | |||
185 | Messages with a _file method contain a file, | ||
186 | which is saved to disk upon receipt at the following location: | ||
187 | $GNUNET_DATA_HOME/social/files/<H(place_pub)>/<message_id> | ||
188 | |||
189 | ### Environment | ||
190 | |||
191 | #### _size_file | ||
192 | size of file | ||
193 | |||
194 | #### _mime_file | ||
195 | MIME type of file | ||
196 | |||
197 | #### _name_file | ||
198 | name of file | ||
199 | |||
200 | #### _description_file | ||
201 | description | ||
202 | |||
203 | @{ | ||
204 | */ | ||
205 | |||
206 | |||
27 | #ifndef GNUNET_SOCIAL_SERVICE_H | 207 | #ifndef GNUNET_SOCIAL_SERVICE_H |
28 | #define GNUNET_SOCIAL_SERVICE_H | 208 | #define GNUNET_SOCIAL_SERVICE_H |
29 | 209 | ||
@@ -371,7 +551,7 @@ typedef void | |||
371 | * Message part, as it arrived from the network. | 551 | * Message part, as it arrived from the network. |
372 | * @param message_id | 552 | * @param message_id |
373 | * Message ID this data fragment belongs to. | 553 | * Message ID this data fragment belongs to. |
374 | * @param cancelled. | 554 | * @param cancelled |
375 | * #GNUNET_YES if the message was cancelled, | 555 | * #GNUNET_YES if the message was cancelled, |
376 | * #GNUNET_NO if the message is complete. | 556 | * #GNUNET_NO if the message is complete. |
377 | */ | 557 | */ |
@@ -1334,6 +1514,7 @@ GNUNET_SOCIAL_zone_add_nym (const struct GNUNET_SOCIAL_App *app, | |||
1334 | GNUNET_ResultCallback result_cb, | 1514 | GNUNET_ResultCallback result_cb, |
1335 | void *result_cls); | 1515 | void *result_cls); |
1336 | 1516 | ||
1517 | /** @} */ /* end of group social */ | ||
1337 | 1518 | ||
1338 | #if 0 /* keep Emacsens' auto-indent happy */ | 1519 | #if 0 /* keep Emacsens' auto-indent happy */ |
1339 | { | 1520 | { |
diff --git a/src/include/gnunet_statistics_service.h b/src/include/gnunet_statistics_service.h index 35c938eb9..a5f5bdb20 100644 --- a/src/include/gnunet_statistics_service.h +++ b/src/include/gnunet_statistics_service.h | |||
@@ -24,7 +24,7 @@ | |||
24 | * the operation of GNUnet; all statistical values | 24 | * the operation of GNUnet; all statistical values |
25 | * must be of type `unsigned long long`. | 25 | * must be of type `unsigned long long`. |
26 | * @author Christian Grothoff | 26 | * @author Christian Grothoff |
27 | * @defgroup statistics track statistics or provide access to statistics | 27 | * @defgroup statistics Track statistics or provide access to statistics |
28 | * @{ | 28 | * @{ |
29 | */ | 29 | */ |
30 | 30 | ||