From: Gabor X Toth <*@tg-x.net> Date: Tue, 12 Jan 2016 12:43:09 +0000 (+0000) Subject: doxygen: group/module definitions (part 2) X-Git-Tag: initial-import-from-subversion-38251~1065 X-Git-Url: https://git.librecmc.org/?a=commitdiff_plain;h=219e64fe613c47eab4c143791128c2b453be3bf8;p=oweals%2Fgnunet.git doxygen: group/module definitions (part 2) --- diff --git a/doc/doc.h b/doc/doc.h index df8fe6c0c..7dfeb1c42 100644 --- a/doc/doc.h +++ b/doc/doc.h @@ -7,5 +7,5 @@ * * Some additional documentation can be found under [Files](files.html), in the src/include/ directory. * - * See also the [handbooks](https://gnunet.org/handbooks) for installation, users, and developers. + * See also the [handbooks](https://gnunet.org/handbooks) on installation, and for user and developer documentation. */ diff --git a/src/include/block_dns.h b/src/include/block_dns.h index e43036a48..f421b36d8 100644 --- a/src/include/block_dns.h +++ b/src/include/block_dns.h @@ -19,10 +19,13 @@ */ /** + * @author Christian Grothoff + * * @file * DNS network structs * - * @author Christian Grothoff + * @defgroup block-dns DNS Service network protocol definitions + * @{ */ #ifndef BLOCK_DNS_H #define BLOCK_DNS_H @@ -61,3 +64,5 @@ struct GNUNET_DNS_Advertisement GNUNET_NETWORK_STRUCT_END #endif + +/** @} */ /* end of group */ diff --git a/src/include/block_fs.h b/src/include/block_fs.h index 15610d333..5688bb3cb 100644 --- a/src/include/block_fs.h +++ b/src/include/block_fs.h @@ -19,10 +19,14 @@ */ /** + * @author Christian Grothoff + * * @file * FS block formats (shared between FS and Block) * - * @author Christian Grothoff + * @defgroup block-fs FS block formats + * Shared between the [FS service](@ref fs) and the [Block library](@ref block). + * @{ */ #ifndef BLOCK_FS_H #define BLOCK_FS_H @@ -96,3 +100,5 @@ struct OnDemandBlock GNUNET_NETWORK_STRUCT_END #endif + +/** @} */ /* end of group */ diff --git a/src/include/gnunet_applications.h b/src/include/gnunet_applications.h index 0c8837bd4..48ecfb796 100644 --- a/src/include/gnunet_applications.h +++ b/src/include/gnunet_applications.h @@ -19,10 +19,14 @@ */ /** + * @author Christian Grothoff + * * @file * Constants for network applications operating on top of the CADET service * - * @author Christian Grothoff + * @defgroup applications CADET application definitions + * Constants for network applications operating on top of the CADET service. + * @{ */ #ifndef GNUNET_APPLICATIONS_H @@ -131,4 +135,7 @@ extern "C" /* ifndef GNUNET_APPLICATIONS_H */ #endif + +/** @} */ /* end of group */ + /* end of gnunet_applications.h */ diff --git a/src/include/gnunet_arm_service.h b/src/include/gnunet_arm_service.h index b2d234c59..d9712d57e 100644 --- a/src/include/gnunet_arm_service.h +++ b/src/include/gnunet_arm_service.h @@ -347,8 +347,6 @@ GNUNET_ARM_monitor (const struct GNUNET_CONFIGURATION_Handle *cfg, void GNUNET_ARM_monitor_disconnect_and_free (struct GNUNET_ARM_MonitorHandle *h); -/** @} */ /* end of group */ - #if 0 /* keep Emacsens' auto-indent happy */ { #endif @@ -357,3 +355,5 @@ GNUNET_ARM_monitor_disconnect_and_free (struct GNUNET_ARM_MonitorHandle *h); #endif #endif + +/** @} */ /* end of group */ diff --git a/src/include/gnunet_ats_plugin.h b/src/include/gnunet_ats_plugin.h index 19003aa02..d3b75c8ae 100644 --- a/src/include/gnunet_ats_plugin.h +++ b/src/include/gnunet_ats_plugin.h @@ -478,6 +478,6 @@ struct GNUNET_ATS_PluginEnvironment unsigned long long in_quota[GNUNET_ATS_NetworkTypeCount]; }; -/** @} */ /* end of group */ - #endif + +/** @} */ /* end of group */ diff --git a/src/include/gnunet_ats_service.h b/src/include/gnunet_ats_service.h index acbaabafc..9f57b57e1 100644 --- a/src/include/gnunet_ats_service.h +++ b/src/include/gnunet_ats_service.h @@ -25,7 +25,7 @@ * @author Matthias Wachs * * @defgroup ats ATS service - * Automatic transport selection and outbound bandwidth determination + * Automatic Transport Selection and outbound bandwidth determination * @{ */ #ifndef GNUNET_ATS_SERVICE_H @@ -700,7 +700,8 @@ GNUNET_ATS_performance_give_feedback (struct GNUNET_ATS_PerformanceHandle *ph, const struct GNUNET_TIME_Relative scope, ...); +#endif + /** @} */ /* end of group */ -#endif /* 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 01fd5c0bc..f14390ebd 100644 --- a/src/include/gnunet_bandwidth_lib.h +++ b/src/include/gnunet_bandwidth_lib.h @@ -332,8 +332,9 @@ GNUNET_BANDWIDTH_tracker_update_quota (struct GNUNET_BANDWIDTH_Tracker *av, } #endif -/** @} */ /* end of group */ - /* ifndef GNUNET_BANDWIDTH_LIB_H */ #endif + +/** @} */ /* end of group */ + /* end of gnunet_bandwidth_lib.h */ diff --git a/src/include/gnunet_bio_lib.h b/src/include/gnunet_bio_lib.h index 034be2ed2..bcbfa5018 100644 --- a/src/include/gnunet_bio_lib.h +++ b/src/include/gnunet_bio_lib.h @@ -43,7 +43,6 @@ extern "C" #endif /** - * @ingroup bio * Handle for buffered reading. */ struct GNUNET_BIO_ReadHandle; @@ -314,8 +313,9 @@ GNUNET_BIO_write_int64 (struct GNUNET_BIO_WriteHandle *h, int64_t i); } #endif -/** @} */ /* end of group bio */ - /* ifndef GNUNET_BIO_LIB_H */ #endif + +/** @} */ /* end of group bio */ + /* end of gnunet_bio_lib.h */ diff --git a/src/include/gnunet_block_lib.h b/src/include/gnunet_block_lib.h index d42a6dac9..a7e2df63b 100644 --- a/src/include/gnunet_block_lib.h +++ b/src/include/gnunet_block_lib.h @@ -306,9 +306,9 @@ GNUNET_BLOCK_construct_bloomfilter (int32_t bf_mutator, } #endif -/** @} */ /* end of group */ - - /* ifndef GNUNET_BLOCK_LIB_H */ #endif + +/** @} */ /* end of group */ + /* end of gnunet_block_lib.h */ diff --git a/src/include/gnunet_block_plugin.h b/src/include/gnunet_block_plugin.h index 362d7c740..bd30406b0 100644 --- a/src/include/gnunet_block_plugin.h +++ b/src/include/gnunet_block_plugin.h @@ -22,7 +22,7 @@ * @author Christian Grothoff * * @file - * API for block plugins. Each block plugin must conform to the API specified by this header. + * API for block plugins. * * @defgroup block-plugin Block plugin API * To be implemented by applications storing data in the DHT. @@ -123,6 +123,6 @@ struct GNUNET_BLOCK_PluginFunctions }; -/** @} */ /* end of group block */ - #endif + +/** @} */ /* end of group */ diff --git a/src/include/gnunet_cadet_service.h b/src/include/gnunet_cadet_service.h index 0ba6e2e91..554bc1fdc 100644 --- a/src/include/gnunet_cadet_service.h +++ b/src/include/gnunet_cadet_service.h @@ -642,8 +642,9 @@ GNUNET_CADET_mq_create (struct GNUNET_CADET_Channel *channel); } #endif -/** @} */ /* end of group */ - /* ifndef GNUNET_CADET_SERVICE_H */ #endif + +/** @} */ /* end of group */ + /* end of gnunet_cadet_service.h */ diff --git a/src/include/gnunet_client_lib.h b/src/include/gnunet_client_lib.h index f961ee181..cdc184d06 100644 --- a/src/include/gnunet_client_lib.h +++ b/src/include/gnunet_client_lib.h @@ -228,8 +228,9 @@ GNUNET_CLIENT_service_test_cancel (struct GNUNET_CLIENT_TestHandle *th); } #endif -/** @} */ /* end of group client */ - /* ifndef GNUNET_CLIENT_LIB_H */ #endif + +/** @} */ /* end of group client */ + /* end of gnunet_client_lib.h */ diff --git a/src/include/gnunet_client_manager_lib.h b/src/include/gnunet_client_manager_lib.h index 6838ee046..2a51daf0a 100644 --- a/src/include/gnunet_client_manager_lib.h +++ b/src/include/gnunet_client_manager_lib.h @@ -353,8 +353,7 @@ GNUNET_CLIENT_MANAGER_op_cancel (struct GNUNET_CLIENT_MANAGER_Connection *mgr, } #endif -/** @} */ /* end of group */ - /* ifndef GNUNET_CLIENT_MANAGER_LIB_H */ #endif -/* end of gnunet_client_manager_lib.h */ + +/** @} */ /* end of group */ diff --git a/src/include/gnunet_common.h b/src/include/gnunet_common.h index c8a1f36ea..e455f2082 100644 --- a/src/include/gnunet_common.h +++ b/src/include/gnunet_common.h @@ -1142,7 +1142,4 @@ enum GNUNET_SCHEDULER_Priority } #endif - - - -#endif /*GNUNET_COMMON_H_ */ +#endif /* GNUNET_COMMON_H */ diff --git a/src/include/gnunet_configuration_lib.h b/src/include/gnunet_configuration_lib.h index b74aa9520..e888d0bf0 100644 --- a/src/include/gnunet_configuration_lib.h +++ b/src/include/gnunet_configuration_lib.h @@ -543,8 +543,6 @@ GNUNET_CONFIGURATION_append_value_filename (struct GNUNET_CONFIGURATION_Handle * const char *option, const char *value); -/** @} */ /* end of group configuration */ - #if 0 /* keep Emacsens' auto-indent happy */ { #endif @@ -553,3 +551,5 @@ GNUNET_CONFIGURATION_append_value_filename (struct GNUNET_CONFIGURATION_Handle * #endif #endif + +/** @} */ /* end of group configuration */ diff --git a/src/include/gnunet_connection_lib.h b/src/include/gnunet_connection_lib.h index a91175b8a..23c24773c 100644 --- a/src/include/gnunet_connection_lib.h +++ b/src/include/gnunet_connection_lib.h @@ -392,8 +392,9 @@ GNUNET_CONNECTION_acivate_proxied (struct GNUNET_CONNECTION_Handle *proxied); } #endif -/** @} */ /* end of group */ - /* ifndef GNUNET_CONNECTION_LIB_H */ #endif + +/** @} */ /* end of group */ + /* end of gnunet_connection_lib.h */ diff --git a/src/include/gnunet_consensus_service.h b/src/include/gnunet_consensus_service.h index aaac12834..a6e8e7731 100644 --- a/src/include/gnunet_consensus_service.h +++ b/src/include/gnunet_consensus_service.h @@ -171,7 +171,6 @@ GNUNET_CONSENSUS_conclude (struct GNUNET_CONSENSUS_Handle *consensus, void GNUNET_CONSENSUS_destroy (struct GNUNET_CONSENSUS_Handle *consensus); -/** @} */ /* end of group */ #if 0 /* keep Emacsens' auto-indent happy */ { @@ -181,3 +180,5 @@ GNUNET_CONSENSUS_destroy (struct GNUNET_CONSENSUS_Handle *consensus); #endif #endif + +/** @} */ /* end of group */ diff --git a/src/include/gnunet_constants.h b/src/include/gnunet_constants.h index 11c14845a..65ced2ff0 100644 --- a/src/include/gnunet_constants.h +++ b/src/include/gnunet_constants.h @@ -22,7 +22,11 @@ * @author Christian Grothoff * * @file - * "Global" constants for performance tuning + * Global constants for performance tuning + * + * @defgroup constants Constant definitions + * Global constants for performance tuning + * @{ */ #ifndef GNUNET_CONSTANTS_H @@ -165,3 +169,5 @@ extern "C" #endif #endif + +/** @} */ /* end of group */ diff --git a/src/include/gnunet_conversation_service.h b/src/include/gnunet_conversation_service.h index 15cc0a3d3..2e583d392 100644 --- a/src/include/gnunet_conversation_service.h +++ b/src/include/gnunet_conversation_service.h @@ -422,7 +422,6 @@ GNUNET_CONVERSATION_call_resume (struct GNUNET_CONVERSATION_Call *call, void GNUNET_CONVERSATION_call_stop (struct GNUNET_CONVERSATION_Call *call); -/** @} */ /* end of group */ #if 0 /* keep Emacsens' auto-indent happy */ { @@ -432,3 +431,5 @@ GNUNET_CONVERSATION_call_stop (struct GNUNET_CONVERSATION_Call *call); #endif #endif + +/** @} */ /* end of group */ diff --git a/src/include/gnunet_core_service.h b/src/include/gnunet_core_service.h index 3dd3e2b2d..c7a0bd5e9 100644 --- a/src/include/gnunet_core_service.h +++ b/src/include/gnunet_core_service.h @@ -450,8 +450,9 @@ GNUNET_CORE_mq_create (struct GNUNET_CORE_Handle *h, } #endif -/** @} */ /* end of group core */ - /* ifndef GNUNET_CORE_SERVICE_H */ #endif + +/** @} */ /* end of group core */ + /* end of gnunet_core_service.h */ diff --git a/src/include/gnunet_datacache_lib.h b/src/include/gnunet_datacache_lib.h index 28efa9627..663589af5 100644 --- a/src/include/gnunet_datacache_lib.h +++ b/src/include/gnunet_datacache_lib.h @@ -24,7 +24,7 @@ * @file * datacache API * - * @defgroup datacache Datacache library + * @defgroup datacache Data Cache library * Simple, transient hash table of bounded size with content expiration. * * In contrast to the sqstore there is @@ -177,7 +177,6 @@ GNUNET_DATACACHE_get_closest (struct GNUNET_DATACACHE_Handle *h, GNUNET_DATACACHE_Iterator iter, void *iter_cls); -/** @} */ /* end of group */ #if 0 /* keep Emacsens' auto-indent happy */ { @@ -186,5 +185,6 @@ GNUNET_DATACACHE_get_closest (struct GNUNET_DATACACHE_Handle *h, } #endif -/* end of gnunet_datacache_lib.h */ #endif + +/** @} */ /* end of group */ diff --git a/src/include/gnunet_datacache_plugin.h b/src/include/gnunet_datacache_plugin.h index cda4e88ce..9fa56f3d5 100644 --- a/src/include/gnunet_datacache_plugin.h +++ b/src/include/gnunet_datacache_plugin.h @@ -24,7 +24,7 @@ * @file * API for database backends for the datacache * - * @defgroup datacache-plugin Datacache plugin API + * @defgroup datacache-plugin Data Cache plugin API * API for database backends for the datacache * @{ */ @@ -186,7 +186,6 @@ struct GNUNET_DATACACHE_PluginFunctions }; -/** @} */ /* end of group */ #if 0 /* keep Emacsens' auto-indent happy */ { @@ -195,5 +194,6 @@ struct GNUNET_DATACACHE_PluginFunctions } #endif -/* end of gnunet_datacache_plugin.h */ #endif + +/** @} */ /* end of group */ diff --git a/src/include/gnunet_datastore_plugin.h b/src/include/gnunet_datastore_plugin.h index 7e5344ebf..90b78b68f 100644 --- a/src/include/gnunet_datastore_plugin.h +++ b/src/include/gnunet_datastore_plugin.h @@ -24,7 +24,7 @@ * @file * API for the database backend plugins. * - * @defgroup datastore-plugin Datastore service plugin API + * @defgroup datastore-plugin Data Store service plugin API * API for the database backend plugins. * @{ */ @@ -389,6 +389,6 @@ struct GNUNET_DATASTORE_PluginFunctions }; -/** @} */ /* end of group */ - #endif + +/** @} */ /* end of group */ diff --git a/src/include/gnunet_datastore_service.h b/src/include/gnunet_datastore_service.h index bdc12b26c..6d2e63324 100644 --- a/src/include/gnunet_datastore_service.h +++ b/src/include/gnunet_datastore_service.h @@ -24,7 +24,7 @@ * @file * datastore service * - * @defgroup datastore Datastore service + * @defgroup datastore Data Store service * Data store for files stored on a GNUnet node. * * Provides an API that can be used manage the @@ -397,7 +397,6 @@ GNUNET_DATASTORE_get_for_replication (struct GNUNET_DATASTORE_Handle *h, void GNUNET_DATASTORE_cancel (struct GNUNET_DATASTORE_QueueEntry *qe); -/** @} */ /* end of group */ #if 0 /* keep Emacsens' auto-indent happy */ { @@ -406,5 +405,6 @@ GNUNET_DATASTORE_cancel (struct GNUNET_DATASTORE_QueueEntry *qe); } #endif -/* end of gnunet_datastore_service.h */ #endif + +/** @} */ /* end of group */ diff --git a/src/include/gnunet_dht_service.h b/src/include/gnunet_dht_service.h index 36463f488..b8337fe54 100644 --- a/src/include/gnunet_dht_service.h +++ b/src/include/gnunet_dht_service.h @@ -431,8 +431,6 @@ GNUNET_DHT_act_malicious (struct GNUNET_DHT_Handle *handle, } #endif -/** @} */ /* end of group dht */ - - #endif -/* gnunet_dht_service.h */ + +/** @} */ /* end of group dht */ diff --git a/src/include/gnunet_disk_lib.h b/src/include/gnunet_disk_lib.h index 7b0b0e998..f78843fad 100644 --- a/src/include/gnunet_disk_lib.h +++ b/src/include/gnunet_disk_lib.h @@ -866,8 +866,9 @@ GNUNET_DISK_file_sync (const struct GNUNET_DISK_FileHandle *h); } #endif -/** @} */ /* end of group */ - /* ifndef GNUNET_DISK_LIB_H */ #endif + +/** @} */ /* end of group */ + /* end of gnunet_disk_lib.h */ diff --git a/src/include/gnunet_dns_service.h b/src/include/gnunet_dns_service.h index 4a8956e84..973964764 100644 --- a/src/include/gnunet_dns_service.h +++ b/src/include/gnunet_dns_service.h @@ -186,6 +186,7 @@ GNUNET_DNS_connect (const struct GNUNET_CONFIGURATION_Handle *cfg, void GNUNET_DNS_disconnect (struct GNUNET_DNS_Handle *dh); -/** @} */ /* end of group */ #endif + +/** @} */ /* end of group */ diff --git a/src/include/gnunet_dnsparser_lib.h b/src/include/gnunet_dnsparser_lib.h index 9680af329..fa7aef429 100644 --- a/src/include/gnunet_dnsparser_lib.h +++ b/src/include/gnunet_dnsparser_lib.h @@ -888,6 +888,7 @@ size_t GNUNET_DNSPARSER_hex_to_bin (const char *hex, void *data); -/** @} */ /* end of group */ #endif + +/** @} */ /* end of group */ diff --git a/src/include/gnunet_dnsstub_lib.h b/src/include/gnunet_dnsstub_lib.h index 08029cebf..5022e02c4 100644 --- a/src/include/gnunet_dnsstub_lib.h +++ b/src/include/gnunet_dnsstub_lib.h @@ -24,7 +24,7 @@ * @file * API for helper library to send DNS requests to DNS resolver * - * @defgroup dns-stub DNS stub library + * @defgroup dns-stub DNS Stub library * Helper library to send DNS requests to DNS resolver * @{ */ @@ -127,6 +127,7 @@ GNUNET_DNSSTUB_resolve2 (struct GNUNET_DNSSTUB_Context *ctx, void GNUNET_DNSSTUB_resolve_cancel (struct GNUNET_DNSSTUB_RequestSocket *rs); -/** @} */ /* end of group */ #endif + +/** @} */ /* end of group */ diff --git a/src/include/gnunet_dv_service.h b/src/include/gnunet_dv_service.h index aa33408ce..76fb57aa0 100644 --- a/src/include/gnunet_dv_service.h +++ b/src/include/gnunet_dv_service.h @@ -25,7 +25,7 @@ * DV service API (should only be used by the DV plugin) * * @defgroup dv DV service - * Distance vector routing + * Distance Vector routing * * The DV service API should only be used by the DV plugin. * @{ @@ -172,6 +172,7 @@ GNUNET_DV_send (struct GNUNET_DV_ServiceHandle *sh, void GNUNET_DV_send_cancel (struct GNUNET_DV_TransmitHandle *th); -/** @} */ /* end of group */ #endif + +/** @} */ /* end of group */ diff --git a/src/include/gnunet_env_lib.h b/src/include/gnunet_env_lib.h index 75fd62bbe..dff005f17 100644 --- a/src/include/gnunet_env_lib.h +++ b/src/include/gnunet_env_lib.h @@ -334,8 +334,7 @@ GNUNET_ENV_value_from_dict (struct GNUNET_CONTAINER_MultiHashMap *dict, size_t * } #endif -/** @} */ /* end of group */ - /* ifndef GNUNET_ENV_LIB_H */ #endif -/* end of gnunet_env_lib.h */ + +/** @} */ /* end of group */ diff --git a/src/include/gnunet_fragmentation_lib.h b/src/include/gnunet_fragmentation_lib.h index b408de3bf..0b4795de2 100644 --- a/src/include/gnunet_fragmentation_lib.h +++ b/src/include/gnunet_fragmentation_lib.h @@ -218,7 +218,6 @@ GNUNET_DEFRAGMENT_process_fragment (struct GNUNET_DEFRAGMENT_Context *dc, const struct GNUNET_MessageHeader *msg); -/** @} */ /* end of group */ #if 0 /* keep Emacsens' auto-indent happy */ { @@ -227,5 +226,6 @@ GNUNET_DEFRAGMENT_process_fragment (struct GNUNET_DEFRAGMENT_Context *dc, } #endif -/* end of gnunet_fragmentation_lib.h */ #endif + +/** @} */ /* end of group */ diff --git a/src/include/gnunet_friends_lib.h b/src/include/gnunet_friends_lib.h index 2d8d231a5..2e111780e 100644 --- a/src/include/gnunet_friends_lib.h +++ b/src/include/gnunet_friends_lib.h @@ -104,7 +104,6 @@ int GNUNET_FRIENDS_write (struct GNUNET_FRIENDS_Writer *w, const struct GNUNET_PeerIdentity *friend_id); -/** @} */ /* end of group */ #if 0 /* keep Emacsens' auto-indent happy */ { @@ -114,3 +113,5 @@ GNUNET_FRIENDS_write (struct GNUNET_FRIENDS_Writer *w, #endif #endif + +/** @} */ /* end of group */ diff --git a/src/include/gnunet_fs_service.h b/src/include/gnunet_fs_service.h index 736a67ae3..9dfd1bad3 100644 --- a/src/include/gnunet_fs_service.h +++ b/src/include/gnunet_fs_service.h @@ -2814,7 +2814,6 @@ GNUNET_FS_share_tree_trim (struct GNUNET_FS_ShareTreeItem *toplevel); void GNUNET_FS_share_tree_free (struct GNUNET_FS_ShareTreeItem *toplevel); -/** @} */ /* end of group */ #if 0 /* keep Emacsens' auto-indent happy */ { @@ -2823,5 +2822,6 @@ GNUNET_FS_share_tree_free (struct GNUNET_FS_ShareTreeItem *toplevel); } #endif - #endif + +/** @} */ /* end of group */ diff --git a/src/include/gnunet_getopt_lib.h b/src/include/gnunet_getopt_lib.h index 59b0c9d4c..24dc154c7 100644 --- a/src/include/gnunet_getopt_lib.h +++ b/src/include/gnunet_getopt_lib.h @@ -384,8 +384,9 @@ GNUNET_GETOPT_print_version_ (struct GNUNET_GETOPT_CommandLineProcessorContext } #endif -/** @} */ /* end of group getopt */ - /* ifndef GNUNET_GETOPT_LIB_H */ #endif + +/** @} */ /* end of group getopt */ + /* end of gnunet_getopt_lib.h */ diff --git a/src/include/gnunet_gns_service.h b/src/include/gnunet_gns_service.h index b24d9a64a..2d511755e 100644 --- a/src/include/gnunet_gns_service.h +++ b/src/include/gnunet_gns_service.h @@ -152,7 +152,6 @@ GNUNET_GNS_lookup (struct GNUNET_GNS_Handle *handle, void GNUNET_GNS_lookup_cancel (struct GNUNET_GNS_LookupRequest *lr); -/** @} */ /* end of group */ #if 0 /* keep Emacsens' auto-indent happy */ { @@ -161,6 +160,6 @@ GNUNET_GNS_lookup_cancel (struct GNUNET_GNS_LookupRequest *lr); } #endif - #endif -/* gnunet_gns_service.h */ + +/** @} */ /* end of group */ diff --git a/src/include/gnunet_gnsrecord_lib.h b/src/include/gnunet_gnsrecord_lib.h index 110646563..6902c4156 100644 --- a/src/include/gnunet_gnsrecord_lib.h +++ b/src/include/gnunet_gnsrecord_lib.h @@ -24,7 +24,7 @@ * @file * API that can be used to manipulate GNS record data * - * @defgroup gns-record GNS record library + * @defgroup gns-record GNS Record library * Manipulate GNS record data * @{ */ @@ -563,7 +563,6 @@ struct GNUNET_TIME_Absolute GNUNET_GNSRECORD_record_get_expiration_time (unsigned int rd_count, const struct GNUNET_GNSRECORD_Data *rd); -/** @} */ /* end of group */ #if 0 /* keep Emacsens' auto-indent happy */ { @@ -573,3 +572,5 @@ GNUNET_GNSRECORD_record_get_expiration_time (unsigned int rd_count, #endif #endif + +/** @} */ /* end of group */ diff --git a/src/include/gnunet_hello_lib.h b/src/include/gnunet_hello_lib.h index 506566d40..81beaa75e 100644 --- a/src/include/gnunet_hello_lib.h +++ b/src/include/gnunet_hello_lib.h @@ -443,7 +443,6 @@ GNUNET_HELLO_parse_uri (const char *uri, struct GNUNET_HELLO_Message **hello, GNUNET_HELLO_TransportPluginsFind plugins_find); -/** @} */ /* end of group */ #if 0 /* keep Emacsens' auto-indent happy */ { @@ -452,7 +451,9 @@ GNUNET_HELLO_parse_uri (const char *uri, } #endif - /* ifndef GNUNET_HELLO_LIB_H */ #endif + +/** @} */ /* end of group */ + /* end of gnunet_hello_lib.h */ diff --git a/src/include/gnunet_helper_lib.h b/src/include/gnunet_helper_lib.h index 1fee1ac01..db0ca98aa 100644 --- a/src/include/gnunet_helper_lib.h +++ b/src/include/gnunet_helper_lib.h @@ -174,7 +174,8 @@ GNUNET_HELPER_send (struct GNUNET_HELPER_Handle *h, void GNUNET_HELPER_send_cancel (struct GNUNET_HELPER_SendHandle *sh); -/** @} */ /* end of group */ #endif /* end of include guard: GNUNET_HELPER_LIB_H */ + +/** @} */ /* end of group */ diff --git a/src/include/gnunet_identity_provider_service.h b/src/include/gnunet_identity_provider_service.h index 1e05244c8..24c89ddf9 100644 --- a/src/include/gnunet_identity_provider_service.h +++ b/src/include/gnunet_identity_provider_service.h @@ -24,7 +24,7 @@ * @file * Identity provider service; implements identity provider for GNUnet * - * @defgroup identity-provider Identity provider service + * @defgroup identity-provider Identity Provider service * @{ */ #ifndef GNUNET_IDENTITY_PROVIDER_SERVICE_H @@ -227,8 +227,10 @@ GNUNET_IDENTITY_PROVIDER_ticket_destroy(struct GNUNET_IDENTITY_PROVIDER_Ticket * } #endif -/** @} */ /* end of group identity */ /* ifndef GNUNET_IDENTITY_PROVIDER_SERVICE_H */ #endif + +/** @} */ /* end of group identity */ + /* end of gnunet_identity_provider_service.h */ diff --git a/src/include/gnunet_identity_service.h b/src/include/gnunet_identity_service.h index 4622e20a9..fa39a33d7 100644 --- a/src/include/gnunet_identity_service.h +++ b/src/include/gnunet_identity_service.h @@ -326,8 +326,9 @@ GNUNET_IDENTITY_ego_lookup_cancel (struct GNUNET_IDENTITY_EgoLookup *el); } #endif -/** @} */ /* end of group identity */ - /* ifndef GNUNET_IDENTITY_SERVICE_H */ #endif + +/** @} */ /* end of group identity */ + /* end of gnunet_identity_service.h */ diff --git a/src/include/gnunet_load_lib.h b/src/include/gnunet_load_lib.h index 22e327bf7..222742136 100644 --- a/src/include/gnunet_load_lib.h +++ b/src/include/gnunet_load_lib.h @@ -111,7 +111,6 @@ GNUNET_LOAD_get_average (struct GNUNET_LOAD_Value *load); void GNUNET_LOAD_update (struct GNUNET_LOAD_Value *load, uint64_t data); -/** @} */ /* end of group */ #if 0 /* keep Emacsens' auto-indent happy */ { @@ -122,4 +121,7 @@ GNUNET_LOAD_update (struct GNUNET_LOAD_Value *load, uint64_t data); /* ifndef GNUNET_LOAD_LIB_H */ #endif + +/** @} */ /* end of group */ + /* end of gnunet_load_lib.h */ diff --git a/src/include/gnunet_microphone_lib.h b/src/include/gnunet_microphone_lib.h index 0d84bfdfc..cd2beb4f2 100644 --- a/src/include/gnunet_microphone_lib.h +++ b/src/include/gnunet_microphone_lib.h @@ -129,7 +129,6 @@ GNUNET_MICROPHONE_create_from_hardware (const struct GNUNET_CONFIGURATION_Handle void GNUNET_MICROPHONE_destroy (struct GNUNET_MICROPHONE_Handle *microphone); -/** @} */ /* end of group */ #if 0 /* keep Emacsens' auto-indent happy */ { @@ -139,4 +138,7 @@ GNUNET_MICROPHONE_destroy (struct GNUNET_MICROPHONE_Handle *microphone); #endif #endif + +/** @} */ /* end of group */ + /* end of gnunet_microphone_lib.h */ diff --git a/src/include/gnunet_mq_lib.h b/src/include/gnunet_mq_lib.h index 1c16b8630..54559a77d 100644 --- a/src/include/gnunet_mq_lib.h +++ b/src/include/gnunet_mq_lib.h @@ -518,6 +518,6 @@ void * GNUNET_MQ_impl_state (struct GNUNET_MQ_Handle *mq); -/** @} */ /* end of group mq */ - #endif + +/** @} */ /* end of group mq */ diff --git a/src/include/gnunet_multicast_service.h b/src/include/gnunet_multicast_service.h index a8e4a99f6..9bbc69243 100644 --- a/src/include/gnunet_multicast_service.h +++ b/src/include/gnunet_multicast_service.h @@ -902,7 +902,6 @@ GNUNET_MULTICAST_member_to_origin_resume (struct GNUNET_MULTICAST_MemberTransmit void GNUNET_MULTICAST_member_to_origin_cancel (struct GNUNET_MULTICAST_MemberTransmitHandle *th); -/** @} */ /* end of group */ #if 0 /* keep Emacsens' auto-indent happy */ { @@ -913,4 +912,5 @@ GNUNET_MULTICAST_member_to_origin_cancel (struct GNUNET_MULTICAST_MemberTransmit /* ifndef GNUNET_MULTICAST_SERVICE_H */ #endif -/* end of gnunet_multicast_service.h */ + +/** @} */ /* end of group */ diff --git a/src/include/gnunet_mysql_lib.h b/src/include/gnunet_mysql_lib.h index 83b10cf79..e9a6158c1 100644 --- a/src/include/gnunet_mysql_lib.h +++ b/src/include/gnunet_mysql_lib.h @@ -207,7 +207,6 @@ GNUNET_MYSQL_statement_run_prepared (struct GNUNET_MYSQL_Context *mc, struct GNUNET_MYSQL_StatementHandle *sh, unsigned long long *insert_id, ...); -/** @} */ /* end of group */ #if 0 /* keep Emacsens' auto-indent happy */ { @@ -216,5 +215,6 @@ GNUNET_MYSQL_statement_run_prepared (struct GNUNET_MYSQL_Context *mc, } #endif -/* end of gnunet_mysql_lib.h */ #endif + +/** @} */ /* end of group */ diff --git a/src/include/gnunet_namecache_plugin.h b/src/include/gnunet_namecache_plugin.h index ec3e22bd2..31a235b66 100644 --- a/src/include/gnunet_namecache_plugin.h +++ b/src/include/gnunet_namecache_plugin.h @@ -19,9 +19,14 @@ */ /** - * @file include/gnunet_namecache_plugin.h - * @brief plugin API for the namecache database backend * @author Christian Grothoff + * + * @file + * Plugin API for the namecache database backend + * + * @defgroup namecache-plugin Name Cache service plugin API + * Plugin API for the namecache database backend. + * @{ */ #ifndef GNUNET_NAMECACHE_PLUGIN_H #define GNUNET_NAMECACHE_PLUGIN_H @@ -97,5 +102,6 @@ struct GNUNET_NAMECACHE_PluginFunctions } #endif -/* end of gnunet_namecache_plugin.h */ #endif + +/** @} */ /* end of group */ diff --git a/src/include/gnunet_namecache_service.h b/src/include/gnunet_namecache_service.h index b5209338a..da0e53859 100644 --- a/src/include/gnunet_namecache_service.h +++ b/src/include/gnunet_namecache_service.h @@ -19,12 +19,19 @@ */ /** - * @file include/gnunet_namecache_service.h - * @brief API that can be used to store naming information on a GNUnet node; - * Naming information can either be records for which this peer/user - * is authoritative, or blocks which are cached, encrypted naming - * data from other peers. * @author Christian Grothoff + * + * @file + * API that can be used to store naming information on a GNUnet node. + * + * @defgroup namecache Name Cache service + * Store naming information on a GNUnet node. + * + * Naming information can either be records for which this peer/user is + * authoritative, or blocks which are cached, encrypted naming data from other + * peers. + * + * @{ */ #ifndef GNUNET_NAMECACHE_SERVICE_H #define GNUNET_NAMECACHE_SERVICE_H @@ -159,5 +166,6 @@ GNUNET_NAMECACHE_cancel (struct GNUNET_NAMECACHE_QueueEntry *qe); } #endif -/* end of gnunet_namecache_service.h */ #endif + +/** @} */ /* end of group */ diff --git a/src/include/gnunet_namestore_plugin.h b/src/include/gnunet_namestore_plugin.h index 7f2b5cecc..9ebb7badf 100644 --- a/src/include/gnunet_namestore_plugin.h +++ b/src/include/gnunet_namestore_plugin.h @@ -19,9 +19,14 @@ */ /** - * @file include/gnunet_namestore_plugin.h - * @brief plugin API for the namestore database backend * @author Christian Grothoff + * + * @file + * Plugin API for the namestore database backend + * + * @defgroup namestore-plugin Name Store service plugin API + * Plugin API for the namestore database backend + * @{ */ #ifndef GNUNET_NAMESTORE_PLUGIN_H #define GNUNET_NAMESTORE_PLUGIN_H @@ -143,5 +148,6 @@ struct GNUNET_NAMESTORE_PluginFunctions } #endif -/* end of gnunet_namestore_plugin.h */ #endif + +/** @} */ /* end of group */ diff --git a/src/include/gnunet_namestore_service.h b/src/include/gnunet_namestore_service.h index 8b17c23b9..b1cb81240 100644 --- a/src/include/gnunet_namestore_service.h +++ b/src/include/gnunet_namestore_service.h @@ -19,12 +19,19 @@ */ /** - * @file include/gnunet_namestore_service.h - * @brief API that can be used to store naming information on a GNUnet node; - * Naming information can either be records for which this peer/user - * is authoritative, or blocks which are cached, encrypted naming - * data from other peers. * @author Christian Grothoff + * + * @file + * API that can be used to store naming information on a GNUnet node; + * + * @defgroup namestore Name Store service + * Store naming information on a GNUnet node. + * + * Naming information can either be records for which this peer/user is + * authoritative, or blocks which are cached, encrypted naming data from other + * peers. + * + * @{ */ #ifndef GNUNET_NAMESTORE_SERVICE_H #define GNUNET_NAMESTORE_SERVICE_H @@ -305,7 +312,6 @@ void GNUNET_NAMESTORE_zone_monitor_stop (struct GNUNET_NAMESTORE_ZoneMonitor *zm); - #if 0 /* keep Emacsens' auto-indent happy */ { #endif @@ -313,5 +319,6 @@ GNUNET_NAMESTORE_zone_monitor_stop (struct GNUNET_NAMESTORE_ZoneMonitor *zm); } #endif -/* end of gnunet_namestore_service.h */ #endif + +/** @} */ /* end of group */ diff --git a/src/include/gnunet_nat_lib.h b/src/include/gnunet_nat_lib.h index aeb5eac23..ab643fd95 100644 --- a/src/include/gnunet_nat_lib.h +++ b/src/include/gnunet_nat_lib.h @@ -19,11 +19,18 @@ */ /** - * @file include/gnunet_nat_lib.h - * @brief Library handling UPnP and NAT-PMP port forwarding and - * external IP address retrieval * @author Christian Grothoff * @author Milan Bouchet-Valat + * + * @file + * Library handling UPnP and NAT-PMP port forwarding + * and external IP address retrieval + * + * @defgroup nat NAT library + * Library handling UPnP and NAT-PMP port forwarding + * and external IP address retrieval + * + * @{ */ #ifndef GNUNET_NAT_LIB_H @@ -578,7 +585,8 @@ GNUNET_NAT_is_valid_stun_packet (void *cls, size_t len); - #endif +/** @} */ /* end of group */ + /* end of gnunet_nat_lib.h */ diff --git a/src/include/gnunet_network_lib.h b/src/include/gnunet_network_lib.h index 83d820a5b..e350d6430 100644 --- a/src/include/gnunet_network_lib.h +++ b/src/include/gnunet_network_lib.h @@ -19,9 +19,14 @@ */ /** - * @file include/gnunet_network_lib.h - * @brief basic low-level networking interface * @author Nils Durner + * + * @file + * Basic low-level networking interface + * + * @defgroup network Network library + * Basic low-level networking interface + * @{ */ #ifndef GNUNET_NETWORK_LIB_H #define GNUNET_NETWORK_LIB_H @@ -591,3 +596,5 @@ GNUNET_NETWORK_fdset_destroy (struct GNUNET_NETWORK_FDSet *fds); #endif #endif /* GNUNET_NETWORK_LIB_H */ + +/** @} */ /* end of group */ diff --git a/src/include/gnunet_nse_service.h b/src/include/gnunet_nse_service.h index 365b35d9b..91a185992 100644 --- a/src/include/gnunet_nse_service.h +++ b/src/include/gnunet_nse_service.h @@ -22,13 +22,18 @@ #define GNUNET_NSE_SERVICE_H_ /** + * @author Nathan Evans + * * @file - * API to retrieve the current network size estimate, + * API to retrieve the current network size estimate + * + * @defgroup nse NSE service + * Network Size Estimation + * + * Provides an API to retrieve the current network size estimate, * also to register for notifications whenever a new * network size estimate is calculated. * - * @author Nathan Evans - * @defgroup nse Network size estimation service * @{ */ diff --git a/src/include/gnunet_os_lib.h b/src/include/gnunet_os_lib.h index bb0840029..4a1a6377a 100644 --- a/src/include/gnunet_os_lib.h +++ b/src/include/gnunet_os_lib.h @@ -19,9 +19,6 @@ */ /** - * @file - * Low level process routines - * * @author Christian Grothoff * @author Krista Bennett * @author Gerd Knorr @@ -29,6 +26,12 @@ * @author Tzvetan Horozov * @author Milan * + * @file + * Low level process routines + * + * @defgroup os OS library + * Low level process routines. + * * This code manages child processes. We can communicate with child * processes using signals. Because signals are not supported on W32 * and Java (at least not nicely), we can alternatively use a pipe @@ -38,6 +41,8 @@ * termination via signals, and not as a replacement for SIGKILL. * Thus using pipes to communicate signals should only be enabled if * the child is a Java process OR if we are on Windoze. + * + * @{ */ #ifndef GNUNET_OS_LIB_H @@ -528,7 +533,9 @@ GNUNET_OS_check_helper_binary (const char *binary, } #endif - /* ifndef GNUNET_OS_LIB_H */ #endif + +/** @} */ /* end of group */ + /* end of gnunet_os_lib.h */ diff --git a/src/include/gnunet_peer_lib.h b/src/include/gnunet_peer_lib.h index d82f0a9fe..644c8ecaa 100644 --- a/src/include/gnunet_peer_lib.h +++ b/src/include/gnunet_peer_lib.h @@ -19,9 +19,14 @@ */ /** - * @file include/gnunet_peer_lib.h - * @brief helper library for interning of peer identifiers * @author Christian Grothoff + * + * @file + * Helper library for interning of peer identifiers + * + * @defgroup peer Peer library + * Helper library for interning of peer identifiers + * @{ */ #ifndef GNUNET_PEER_LIB_H @@ -116,7 +121,9 @@ GNUNET_PEER_resolve2 (GNUNET_PEER_Id id); } #endif - /* ifndef GNUNET_PEER_LIB_H */ #endif + +/** @} */ /* end of group */ + /* end of gnunet_peer_lib.h */ diff --git a/src/include/gnunet_peerinfo_service.h b/src/include/gnunet_peerinfo_service.h index fdb3204c4..b1996b3e6 100644 --- a/src/include/gnunet_peerinfo_service.h +++ b/src/include/gnunet_peerinfo_service.h @@ -18,10 +18,17 @@ Boston, MA 02110-1301, USA. */ /** - * @file include/gnunet_peerinfo_service.h - * @brief Code to maintain the list of currently known hosts - * (in memory structure of data/hosts). * @author Christian Grothoff + * + * @file + * Maintain the list of currently known hosts + * + * @defgroup peerinfo Peer Info service + * Maintain the list of currently known hosts. + * + * Holds an in-memory structure of data/hosts. + * + * @{ */ #ifndef GNUNET_PEERINFO_SERVICE_H @@ -223,6 +230,6 @@ GNUNET_PEERINFO_notify_cancel (struct GNUNET_PEERINFO_NotifyContext *nc); } #endif - -/* end of gnunet_peerinfo_service.h */ #endif + +/** @} */ /* end of group */ diff --git a/src/include/gnunet_peerstore_plugin.h b/src/include/gnunet_peerstore_plugin.h index 90ef619ac..90931b4e3 100644 --- a/src/include/gnunet_peerstore_plugin.h +++ b/src/include/gnunet_peerstore_plugin.h @@ -19,9 +19,14 @@ */ /** - * @file include/gnunet_peerstore_plugin.h - * @brief plugin API for the peerstore database backend * @author Omar Tarabai + * + * @file + * Plugin API for the peerstore database backend + * + * @defgroup peerstore-plugin Peer Store service plugin API + * Plugin API for the peerstore database backend + * @{ */ #ifndef GNUNET_PEERSTORE_PLUGIN_H #define GNUNET_PEERSTORE_PLUGIN_H @@ -124,5 +129,6 @@ struct GNUNET_PEERSTORE_PluginFunctions } #endif -/* end of gnunet_peerstore_plugin.h */ #endif + +/** @} */ /* end of group */ diff --git a/src/include/gnunet_peerstore_service.h b/src/include/gnunet_peerstore_service.h index 556260928..7520efad1 100644 --- a/src/include/gnunet_peerstore_service.h +++ b/src/include/gnunet_peerstore_service.h @@ -19,9 +19,14 @@ */ /** - * @file include/gnunet_peerstore_service.h - * @brief API to the peerstore service * @author Omar Tarabai + * + * @file + * API to the peerstore service + * + * @defgroup peerstore Peer Store service + * + * @{ */ #ifndef GNUNET_PEERSTORE_SERVICE_H #define GNUNET_PEERSTORE_SERVICE_H @@ -253,6 +258,7 @@ GNUNET_PEERSTORE_watch (struct GNUNET_PEERSTORE_Handle *h, void GNUNET_PEERSTORE_watch_cancel (struct GNUNET_PEERSTORE_WatchContext *wc); + #if 0 /* keep Emacsens' auto-indent happy */ { #endif @@ -261,3 +267,5 @@ GNUNET_PEERSTORE_watch_cancel (struct GNUNET_PEERSTORE_WatchContext *wc); #endif #endif + +/** @} */ /* end of group */ diff --git a/src/include/gnunet_plugin_lib.h b/src/include/gnunet_plugin_lib.h index 0720e2f0b..9ece4790c 100644 --- a/src/include/gnunet_plugin_lib.h +++ b/src/include/gnunet_plugin_lib.h @@ -19,9 +19,14 @@ */ /** - * @file include/gnunet_plugin_lib.h - * @brief plugin loading and unloading * @author Christian Grothoff + * + * @file + * Plugin loading and unloading + * + * @defgroup plugin Plugin library + * Plugin loading and unloading + * @{ */ #ifndef GNUNET_PLUGIN_LIB_H @@ -131,7 +136,9 @@ GNUNET_PLUGIN_unload (const char *library_name, void *arg); } #endif - /* ifndef GNUNET_PLUGIN_LIB_H */ #endif + +/** @} */ /* end of group */ + /* end of gnunet_plugin_lib.h */ diff --git a/src/include/gnunet_postgres_lib.h b/src/include/gnunet_postgres_lib.h index b0a8f9229..bad9e5e86 100644 --- a/src/include/gnunet_postgres_lib.h +++ b/src/include/gnunet_postgres_lib.h @@ -18,9 +18,14 @@ Boston, MA 02110-1301, USA. */ /** - * @file include/gnunet_postgres_lib.h - * @brief library to help with access to a Postgres database * @author Christian Grothoff + * + * @file + * Helper library to access a PostgreSQL database + * + * @defgroup postgres PostgreSQL library + * Helper library to access a PostgreSQL database. + * @{ */ #ifndef GNUNET_POSTGRES_LIB_H #define GNUNET_POSTGRES_LIB_H @@ -151,7 +156,6 @@ GNUNET_POSTGRES_delete_by_rowid (PGconn *dbh, uint32_t rowid); - #if 0 /* keep Emacsens' auto-indent happy */ { #endif @@ -159,5 +163,6 @@ GNUNET_POSTGRES_delete_by_rowid (PGconn *dbh, } #endif -/* end of gnunet_postgres_lib.h */ #endif + +/** @} */ /* end of group */ diff --git a/src/include/gnunet_program_lib.h b/src/include/gnunet_program_lib.h index 85c802285..68ff0f2a7 100644 --- a/src/include/gnunet_program_lib.h +++ b/src/include/gnunet_program_lib.h @@ -19,11 +19,13 @@ */ /** + * @author Christian Grothoff + * * @file * Functions related to starting programs * - * @author Christian Grothoff - * @defgroup program Functions for writing command-line programs + * @defgroup program Program library + * Start command-line programs. * @{ */ @@ -104,7 +106,6 @@ GNUNET_PROGRAM_run (int argc, GNUNET_PROGRAM_Main task, void *task_cls); - #if 0 /* keep Emacsens' auto-indent happy */ { #endif @@ -112,8 +113,9 @@ GNUNET_PROGRAM_run (int argc, } #endif -/** @} */ /* end of group program */ - /* ifndef GNUNET_PROGRAM_LIB_H */ #endif + +/** @} */ /* end of group program */ + /* end of gnunet_program_lib.h */ diff --git a/src/include/gnunet_protocols.h b/src/include/gnunet_protocols.h index a3e4199a4..de029aeae 100644 --- a/src/include/gnunet_protocols.h +++ b/src/include/gnunet_protocols.h @@ -19,10 +19,13 @@ */ /** - * @file include/gnunet_protocols.h - * @brief constants for network protocols * @author Christian Grothoff - * @defgroup protocols Types of messages used in GNUnet + * + * @file + * Constants for network protocols + * + * @defgroup protocols Network protocol definitions + * Types of messages used in GNUnet. * @{ */ @@ -2857,8 +2860,9 @@ extern "C" } #endif -/** @} */ /* end of group protocols */ - /* ifndef GNUNET_PROTOCOLS_H */ #endif + +/** @} */ /* end of group protocols */ + /* end of gnunet_protocols.h */ diff --git a/src/include/gnunet_psyc_service.h b/src/include/gnunet_psyc_service.h index 2bbe8cdd6..de31fe216 100644 --- a/src/include/gnunet_psyc_service.h +++ b/src/include/gnunet_psyc_service.h @@ -19,20 +19,24 @@ */ /** - * @file include/gnunet_psyc_service.h - * @brief PSYC service; high-level access to the PSYC protocol - * note that clients of this API are NOT expected to - * understand the PSYC message format, only the semantics! - * Parsing (and serializing) the PSYC stream format is done - * within the implementation of the libgnunetpsyc library, - * and this API deliberately exposes as little as possible - * of the actual data stream format to the application! - * @author Christian Grothoff * @author Gabor X Toth + * @author Christian Grothoff + * + * @file + * PSYC service + * + * @defgroup psyc PSYC service + * Send/receive messages in PSYC channels and access the PSYC Store. + * + * Note that clients of this API are NOT expected to understand the PSYC message + * format, only the semantics! Parsing (and serializing) the PSYC stream format + * is done within the implementation of the libgnunetpsyc library, and this API + * deliberately exposes as little as possible of the actual data stream format + * to the application! * * NOTE: - * - this API does not know about psyc's "root" and "places"; - * there is no 'root' in GNUnet-Psyc as we're decentralized; + * - this API does not know about PSYC's "root" and "places"; + * there is no 'root' in GNUnet-PSYC as we're decentralized; * 'places' and 'persons' are combined within the same * abstraction, that of a "channel". Channels are identified * and accessed in this API using a public/private key. @@ -72,6 +76,8 @@ * be called 'PSYC-low', whereas a higher-level API * implementing defaults for standard methods and * variables might be called 'PSYC-std' or 'PSYC-high'. + * + * @{ */ #ifndef GNUNET_PSYC_SERVICE_H @@ -1331,4 +1337,5 @@ GNUNET_PSYC_channel_state_get_cancel (struct GNUNET_PSYC_StateRequest *sr); /* ifndef GNUNET_PSYC_SERVICE_H */ #endif -/* end of gnunet_psyc_service.h */ + +/** @} */ /* end of group */ diff --git a/src/include/gnunet_psyc_util_lib.h b/src/include/gnunet_psyc_util_lib.h index 10cfc68d9..0b9ba8207 100644 --- a/src/include/gnunet_psyc_util_lib.h +++ b/src/include/gnunet_psyc_util_lib.h @@ -19,9 +19,14 @@ */ /** - * @file include/gnunet_psyc_service.h - * @brief PSYC utilities; receiving/transmitting/logging PSYC messages. * @author Gabor X Toth + * + * @file + * PSYC utilities; receiving/transmitting/logging PSYC messages + * + * @defgroup psyc-util PSYC Utilities library + * Receiving, transmitting, logging PSYC messages. + * @{ */ #ifndef GNUNET_PSYC_UTIL_LIB_H @@ -263,4 +268,5 @@ GNUNET_PSYC_message_header_create_from_psyc (const struct GNUNET_PSYC_Message *m /* ifndef GNUNET_PSYC_UTIL_LIB_H */ #endif -/* end of gnunet_psyc_util_lib.h */ + +/** @} */ /* end of group */ diff --git a/src/include/gnunet_psycstore_plugin.h b/src/include/gnunet_psycstore_plugin.h index bc5ac2542..f1512f1d9 100644 --- a/src/include/gnunet_psycstore_plugin.h +++ b/src/include/gnunet_psycstore_plugin.h @@ -19,9 +19,14 @@ */ /** - * @file include/gnunet_psycstore_plugin.h - * @brief plugin API for the PSYCstore database backend * @author Gabor X Toth + * + * @file + * Plugin API for the PSYCstore database backend + * + * @defgroup psycstore-plugin PSYC Store plugin API + * Plugin API for the PSYC Store database backend + * @{ */ #ifndef GNUNET_PSYCSTORE_PLUGIN_H #define GNUNET_PSYCSTORE_PLUGIN_H @@ -373,5 +378,6 @@ struct GNUNET_PSYCSTORE_PluginFunctions } #endif -/* end of gnunet_psycstore_plugin.h */ #endif + +/** @} */ /* end of group */ diff --git a/src/include/gnunet_psycstore_service.h b/src/include/gnunet_psycstore_service.h index 615481b91..aac2955cf 100644 --- a/src/include/gnunet_psycstore_service.h +++ b/src/include/gnunet_psycstore_service.h @@ -19,10 +19,15 @@ */ /** - * @file include/gnunet_psycstore_service.h - * @brief PSYCstore service; implements persistent storage for the PSYC service * @author Gabor X Toth * @author Christian Grothoff + * + * @file + * PSYCstore service; implements persistent storage for the PSYC service + * + * @defgroup psycstore PSYC Store service + * Persistent storage for the PSYC service. + * @{ */ #ifndef GNUNET_PSYCSTORE_SERVICE_H #define GNUNET_PSYCSTORE_SERVICE_H @@ -692,4 +697,5 @@ GNUNET_PSYCSTORE_operation_cancel (struct GNUNET_PSYCSTORE_OperationHandle *op); /* ifndef GNUNET_PSYCSTORE_SERVICE_H */ #endif -/* end of gnunet_psycstore_service.h */ + +/** @} */ /* end of group */ diff --git a/src/include/gnunet_regex_service.h b/src/include/gnunet_regex_service.h index 15e86610c..67cf2106f 100644 --- a/src/include/gnunet_regex_service.h +++ b/src/include/gnunet_regex_service.h @@ -18,11 +18,18 @@ Boston, MA 02110-1301, USA. */ /** - * @file include/gnunet_regex_service.h - * @brief access regex service to advertise capabilities via regex and discover - * respective peers using matching strings * @author Maximilian Szengel * @author Christian Grothoff + * + * @file + * API to access regex service to advertise capabilities via regex and discover + * respective peers using matching strings + * + * @defgroup regex RegEx service + * Advertise capabilities via RegEx and discover + * respective peers using matching strings. + * + * @{ */ #ifndef GNUNET_REGEX_SERVICE_H #define GNUNET_REGEX_SERVICE_H @@ -136,5 +143,6 @@ GNUNET_REGEX_search_cancel (struct GNUNET_REGEX_Search *s); } #endif -/* end of gnunet_regex_service.h */ #endif + +/** @} */ /* end of group */ diff --git a/src/include/gnunet_resolver_service.h b/src/include/gnunet_resolver_service.h index 3806cbdcf..7f434ca8b 100644 --- a/src/include/gnunet_resolver_service.h +++ b/src/include/gnunet_resolver_service.h @@ -173,8 +173,9 @@ GNUNET_RESOLVER_request_cancel (struct GNUNET_RESOLVER_RequestHandle *rh); } #endif -/** @} */ /* end of group resolver */ - /* ifndef GNUNET_RESOLVER_SERVICE_H */ #endif + +/** @} */ /* end of group resolver */ + /* end of gnunet_resolver_service.h */ diff --git a/src/include/gnunet_rest_lib.h b/src/include/gnunet_rest_lib.h index a449d7dee..a1274dbfd 100644 --- a/src/include/gnunet_rest_lib.h +++ b/src/include/gnunet_rest_lib.h @@ -19,9 +19,14 @@ */ /** - * @file include/gnunet_rest_lib.h - * @brief API for helper library to parse/create REST * @author Martin Schanzenbach + * + * @file + * API for helper library to parse/create REST + * + * @defgroup rest REST library + * Helper library to parse/create REST + * @{ */ #ifndef GNUNET_REST_LIB_H #define GNUNET_REST_LIB_H @@ -159,7 +164,7 @@ int GNUNET_REST_jsonapi_resource_check_type (const struct JsonApiResource *resource, const char* type); - + /** * Create a JSON API primary data * @@ -180,7 +185,7 @@ GNUNET_REST_jsonapi_object_new (); struct JsonApiObject* GNUNET_REST_jsonapi_object_parse (const char* data); - + /** * Delete a JSON API primary data * @@ -268,4 +273,7 @@ GNUNET_REST_handle_request (struct RestConnectionDataHandle *conn, const struct GNUNET_REST_RestConnectionHandler *handlers, void *cls); + #endif + +/** @} */ /* end of group */ diff --git a/src/include/gnunet_rest_plugin.h b/src/include/gnunet_rest_plugin.h index cdb3018e7..632ab99ff 100644 --- a/src/include/gnunet_rest_plugin.h +++ b/src/include/gnunet_rest_plugin.h @@ -19,9 +19,12 @@ */ /** * @author Martin Schanzenbach - * @file include/gnunet_rest_plugin.h - * @brief GNUnet service REST plugin header * + * @file + * GNUnet service REST plugin header + * + * @defgroup rest-plugin REST plugin for GNUnet services + * @{ */ #ifndef GNUNET_REST_PLUGIN_H #define GNUNET_REST_PLUGIN_H @@ -60,7 +63,7 @@ struct GNUNET_REST_Plugin /** * Function to process a REST call - * + * * @param method the HTTP method called * @param url the relative url accessed * @param data the REST data (can be NULL) @@ -82,6 +85,6 @@ struct GNUNET_REST_Plugin } #endif -/* end of gnunet_rest_plugin.h */ #endif +/** @} */ /* end of group */ diff --git a/src/include/gnunet_revocation_service.h b/src/include/gnunet_revocation_service.h index 919f62db9..d25e95404 100644 --- a/src/include/gnunet_revocation_service.h +++ b/src/include/gnunet_revocation_service.h @@ -22,10 +22,13 @@ #define GNUNET_REVOCATION_SERVICE_H_ /** - * @file include/gnunet_revocation_service.h - * @brief API to perform and access key revocations * @author Christian Grothoff - * @defgroup revocation Key revocation service + * + * @file + * API to perform and access key revocations + * + * @defgroup revocation Revocation service + * Perform and access key revocations. * @{ */ @@ -157,6 +160,6 @@ GNUNET_REVOCATION_sign_revocation (const struct GNUNET_CRYPTO_EcdsaPrivateKey *k } #endif -/** @} */ /* end of group revocation */ - #endif /* GNUNET_REVOCATION_SERVICE_H_ */ + +/** @} */ /* end of group revocation */ diff --git a/src/include/gnunet_rps_service.h b/src/include/gnunet_rps_service.h index 47b153b14..c91804a60 100644 --- a/src/include/gnunet_rps_service.h +++ b/src/include/gnunet_rps_service.h @@ -1,6 +1,6 @@ /* This file is part of GNUnet - Copyright (C) + Copyright (C) GNUnet is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published @@ -19,9 +19,14 @@ */ /** - * @file include/gnunet_rps_service.h - * @brief API to the rps service * @author Julius Bünger + * + * @file + * API to the rps service + * + * @defgroup rps RPS service + * Random Peer Sampling + * @{ */ #ifndef GNUNET_RPS_SERVICE_H #define GNUNET_RPS_SERVICE_H @@ -140,6 +145,7 @@ GNUNET_RPS_act_malicious (struct GNUNET_RPS_Handle *h, void GNUNET_RPS_disconnect (struct GNUNET_RPS_Handle *h); + #if 0 /* keep Emacsens' auto-indent happy */ { #endif @@ -148,3 +154,5 @@ GNUNET_RPS_disconnect (struct GNUNET_RPS_Handle *h); #endif #endif + +/** @} */ /* end of group */ diff --git a/src/include/gnunet_scalarproduct_service.h b/src/include/gnunet_scalarproduct_service.h index d34237035..04db16ed3 100644 --- a/src/include/gnunet_scalarproduct_service.h +++ b/src/include/gnunet_scalarproduct_service.h @@ -19,10 +19,15 @@ */ /** - * @file include/gnunet_scalarproduct_service.h - * @brief API to the scalarproduct service * @author Christian M. Fuchs * @author Gaurav Kukreja + * + * @file + * API to the scalarproduct service + * + * @defgroup scalarproduct Scalar Product service + * + * @{ */ #ifndef GNUNET_SCALARPRODUCT_SERVICE_H #define GNUNET_SCALARPRODUCT_SERVICE_H @@ -183,6 +188,7 @@ GNUNET_SCALARPRODUCT_accept_computation (const struct GNUNET_CONFIGURATION_Handl void GNUNET_SCALARPRODUCT_cancel (struct GNUNET_SCALARPRODUCT_ComputationHandle *h); + #if 0 /* keep Emacsens' auto-indent happy */ { #endif @@ -191,3 +197,5 @@ GNUNET_SCALARPRODUCT_cancel (struct GNUNET_SCALARPRODUCT_ComputationHandle *h); #endif #endif + +/** @} */ /* end of group */ diff --git a/src/include/gnunet_scheduler_lib.h b/src/include/gnunet_scheduler_lib.h index ab1e09e89..2d3ada251 100644 --- a/src/include/gnunet_scheduler_lib.h +++ b/src/include/gnunet_scheduler_lib.h @@ -19,10 +19,16 @@ */ /** - * @file include/gnunet_scheduler_lib.h - * @brief API to schedule computations using continuation passing style * @author Christian Grothoff - * @defgroup scheduler Event loop (scheduler) + * + * @file + * API to schedule computations using continuation passing style + * + * @defgroup scheduler Scheduler library + * Event loop (scheduler) + * + * Schedule computations using continuation passing style. + * * @{ */ @@ -537,8 +543,6 @@ GNUNET_SCHEDULER_set_select (GNUNET_SCHEDULER_select new_select, void *new_select_cls); -/** @} */ /* end of group scheduler */ - #if 0 /* keep Emacsens' auto-indent happy */ { #endif @@ -547,3 +551,5 @@ GNUNET_SCHEDULER_set_select (GNUNET_SCHEDULER_select new_select, #endif #endif + +/** @} */ /* end of group scheduler */ diff --git a/src/include/gnunet_secretsharing_service.h b/src/include/gnunet_secretsharing_service.h index 69f22532a..793d33ba0 100644 --- a/src/include/gnunet_secretsharing_service.h +++ b/src/include/gnunet_secretsharing_service.h @@ -19,9 +19,14 @@ */ /** - * @file include/gnunet_secretsharing_service.h - * @brief verifiable additive secret sharing and cooperative decryption * @author Florian Dold + * + * @file + * Verifiable additive secret sharing and cooperative decryption + * + * @defgroup secretsharing Secret Sharing service + * Verifiable additive secret sharing and cooperative decryption. + * @{ */ #ifndef GNUNET_SECRETSHARING_SERVICE_H @@ -319,8 +324,6 @@ GNUNET_SECRETSHARING_plaintext_generate_i (struct GNUNET_SECRETSHARING_Plaintext int64_t exponent); - - #if 0 /* keep Emacsens' auto-indent happy */ { #endif @@ -329,3 +332,5 @@ GNUNET_SECRETSHARING_plaintext_generate_i (struct GNUNET_SECRETSHARING_Plaintext #endif #endif + +/** @} */ /* end of group */ diff --git a/src/include/gnunet_sensor_service.h b/src/include/gnunet_sensor_service.h index 3bfec64d2..6b0692c6f 100644 --- a/src/include/gnunet_sensor_service.h +++ b/src/include/gnunet_sensor_service.h @@ -1,6 +1,6 @@ /* This file is part of GNUnet - Copyright (C) + Copyright (C) GNUnet is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published @@ -19,10 +19,16 @@ */ /** - * @file include/gnunet_sensor_service.h - * @brief API to the sensor service * @author Omar Tarabai + * + * @file + * API to the sensor service + * + * @defgroup sensor Sensor service + * + * @{ */ + #ifndef GNUNET_SENSOR_SERVICE_H #define GNUNET_SENSOR_SERVICE_H @@ -180,6 +186,7 @@ GNUNET_SENSOR_force_anomaly (struct GNUNET_SENSOR_Handle *h, char *sensor_name, int anomalous, GNUNET_SENSOR_Continuation cont, void *cont_cls); + #if 0 /* keep Emacsens' auto-indent happy */ { #endif @@ -188,3 +195,5 @@ GNUNET_SENSOR_force_anomaly (struct GNUNET_SENSOR_Handle *h, char *sensor_name, #endif #endif + +/** @} */ /* end of group */ diff --git a/src/include/gnunet_sensor_util_lib.h b/src/include/gnunet_sensor_util_lib.h index 0b9a7ba71..63a6fc10f 100644 --- a/src/include/gnunet_sensor_util_lib.h +++ b/src/include/gnunet_sensor_util_lib.h @@ -19,9 +19,14 @@ */ /** - * @file sensor/sensor_util_lib.c - * @brief sensor utilities * @author Omar Tarabai + * + * @file + * Sensor utilities + * + * @defgroup sensor Sensor Utilities library + * + * @{ */ #ifndef GNUNET_SENSOR_UTIL_LIB_H @@ -509,4 +514,7 @@ GNUNET_SENSOR_crypto_verify_pow_sign (struct GNUNET_SENSOR_crypto_pow_block * /* ifndef GNUNET_SENSOR_UTIL_LIB_H */ #endif + +/** @} */ /* end of group */ + /* end of gnunet_sensor_util_lib.h */ diff --git a/src/include/gnunet_sensordashboard_service.h b/src/include/gnunet_sensordashboard_service.h index 9960dc652..4c08a14b6 100644 --- a/src/include/gnunet_sensordashboard_service.h +++ b/src/include/gnunet_sensordashboard_service.h @@ -1,6 +1,6 @@ /* This file is part of GNUnet - Copyright (C) + Copyright (C) GNUnet is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published @@ -19,9 +19,14 @@ */ /** - * @file include/gnunet_sensordashboard_service.h - * @brief API to the sensordashboard service * @author Omar Tarabai + * + * @file + * API to the sensordashboard service + * + * @defgroup sensordashboard Sensor Dashboard service + * + * @{ */ #ifndef GNUNET_SENSORDASHBOARD_SERVICE_H #define GNUNET_SENSORDASHBOARD_SERVICE_H @@ -46,3 +51,5 @@ extern "C" #endif #endif + +/** @} */ /* end of group */ diff --git a/src/include/gnunet_server_lib.h b/src/include/gnunet_server_lib.h index b1be9ee3a..86b2d9de7 100644 --- a/src/include/gnunet_server_lib.h +++ b/src/include/gnunet_server_lib.h @@ -19,10 +19,16 @@ */ /** - * @file include/gnunet_server_lib.h - * @brief library for building GNUnet network servers * @author Christian Grothoff - * @defgroup server Functions for a server that communicates with clients + * + * @file + * Library for building GNUnet network servers + + * @defgroup server Server library + * Library for building GNUnet network servers + * + * Provides functions for a server that communicates with clients. + * * @{ */ @@ -851,8 +857,9 @@ GNUNET_SERVER_set_callbacks (struct GNUNET_SERVER_Handle *server, } #endif -/** @} */ /* end of group server */ - /* ifndef GNUNET_SERVER_LIB_H */ #endif + +/** @} */ /* end of group server */ + /* end of gnunet_server_lib.h */ diff --git a/src/include/gnunet_service_lib.h b/src/include/gnunet_service_lib.h index 9f3947dda..589ea0270 100644 --- a/src/include/gnunet_service_lib.h +++ b/src/include/gnunet_service_lib.h @@ -19,10 +19,13 @@ */ /** - * @file include/gnunet_service_lib.h - * @brief functions related to starting services * @author Christian Grothoff - * @defgroup service Generic functions for implementing service processes + * + * @file + * Functions related to starting services + * + * @defgroup service Service library + * Start service processes. * @{ */ @@ -186,10 +189,9 @@ GNUNET_SERVICE_stop (struct GNUNET_SERVICE_Context *sctx); } #endif - -/** @} */ /* end of group service */ - - /* ifndef GNUNET_SERVICE_LIB_H */ #endif + +/** @} */ /* end of group service */ + /* end of gnunet_service_lib.h */ diff --git a/src/include/gnunet_set_service.h b/src/include/gnunet_set_service.h index 7246f9b42..75dc6049e 100644 --- a/src/include/gnunet_set_service.h +++ b/src/include/gnunet_set_service.h @@ -19,10 +19,15 @@ */ /** - * @file include/gnunet_set_service.h - * @brief two-peer set operations * @author Florian Dold * @author Christian Grothoff + * + * @file + * Two-peer set operations + * + * @defgroup set Set service + * Two-peer set operations + * @{ */ #ifndef GNUNET_SET_SERVICE_H @@ -161,7 +166,7 @@ enum GNUNET_SET_ResultMode * Client gets notified of the required changes * for both the local and the remote set. * - * Only supported for set + * Only supported for set */ GNUNET_SET_RESULT_SYMMETRIC, @@ -499,3 +504,5 @@ GNUNET_SET_element_hash (const struct GNUNET_SET_Element *element, struct GNUNET #endif #endif + +/** @} */ /* end of group */ diff --git a/src/include/gnunet_signal_lib.h b/src/include/gnunet_signal_lib.h index 9cb032b3b..2b4dbe459 100644 --- a/src/include/gnunet_signal_lib.h +++ b/src/include/gnunet_signal_lib.h @@ -19,9 +19,14 @@ */ /** - * @file include/gnunet_signal_lib.h - * @brief functions related to signals * @author Christian Grothoff + * + * @file + * Functions related to signals + * + * @defgroup signal Signal library + * Manage signal handlers. + * @{ */ #ifndef GNUNET_SIGNAL_LIB_H @@ -97,4 +102,7 @@ GNUNET_SIGNAL_raise (const int sig); /* ifndef GNUNET_SIGNAL_LIB_H */ #endif + +/** @} */ /* end of group */ + /* end of gnunet_signal_lib.h */ diff --git a/src/include/gnunet_signatures.h b/src/include/gnunet_signatures.h index 95d570b54..e8e63a6d2 100644 --- a/src/include/gnunet_signatures.h +++ b/src/include/gnunet_signatures.h @@ -19,9 +19,13 @@ */ /** - * @file include/gnunet_signatures.h - * @brief constants for network signatures * @author Christian Grothoff + * + * @file + * Constants for network signatures + * + * @defgroup signatures Network signature definitions + * @{ */ #ifndef GNUNET_SIGNATURES_H @@ -195,4 +199,7 @@ extern "C" /* ifndef GNUNET_SIGNATURES_H */ #endif + +/** @} */ /* end of group */ + /* end of gnunet_signatures.h */ diff --git a/src/include/gnunet_social_service.h b/src/include/gnunet_social_service.h index c5e55bbab..4bdad6834 100644 --- a/src/include/gnunet_social_service.h +++ b/src/include/gnunet_social_service.h @@ -1514,7 +1514,6 @@ GNUNET_SOCIAL_zone_add_nym (const struct GNUNET_SOCIAL_App *app, GNUNET_ResultCallback result_cb, void *result_cls); -/** @} */ /* end of group social */ #if 0 /* keep Emacsens' auto-indent happy */ { @@ -1525,4 +1524,5 @@ GNUNET_SOCIAL_zone_add_nym (const struct GNUNET_SOCIAL_App *app, /* ifndef GNUNET_SOCIAL_SERVICE_H */ #endif -/* end of gnunet_social_service.h */ + +/** @} */ /* end of group social */ diff --git a/src/include/gnunet_socks.h b/src/include/gnunet_socks.h index 6ac3919e8..9ec5d7e6b 100644 --- a/src/include/gnunet_socks.h +++ b/src/include/gnunet_socks.h @@ -19,9 +19,14 @@ */ /** - * @file include/gnunet_socks.h - * @brief SOCKS proxy for connections * @author Jeffrey Burdges + * + * @file + * SOCKS proxy for connections + * + * @defgroup socks SOCKS proxy + * SOCKS proxy for connections. + * @{ */ #ifndef GNUNET_SOCKS_H @@ -71,7 +76,9 @@ GNUNET_SOCKS_do_connect (const char *service_name, } #endif - /* ifndef GNUNET_SOCKS_H */ #endif + +/** @} */ /* end of group */ + /* end of gnunet_socks.h */ diff --git a/src/include/gnunet_speaker_lib.h b/src/include/gnunet_speaker_lib.h index d3c4f3611..bd767fd2d 100644 --- a/src/include/gnunet_speaker_lib.h +++ b/src/include/gnunet_speaker_lib.h @@ -19,11 +19,16 @@ */ /** - * @file include/gnunet_speaker_lib.h - * @brief API to access an audio speaker; provides access to hardware speakers * @author Simon Dieterle * @author Andreas Fuchs * @author Christian Grothoff + * + * @file + * API to access an audio speaker; provides access to hardware speakers + * + * @defgroup speaker Speaker service + * Access hardware audio speakers. + * @{ */ #ifndef GNUNET_SPEAKER_SERVICE_H #define GNUNET_SPEAKER_SERVICE_H @@ -135,4 +140,7 @@ GNUNET_SPEAKER_destroy (struct GNUNET_SPEAKER_Handle *speaker); #endif #endif + +/** @} */ /* end of group */ + /* end of gnunet_speaker_lib.h */ diff --git a/src/include/gnunet_statistics_service.h b/src/include/gnunet_statistics_service.h index a5f5bdb20..7e6b969e2 100644 --- a/src/include/gnunet_statistics_service.h +++ b/src/include/gnunet_statistics_service.h @@ -19,12 +19,18 @@ */ /** - * @file include/gnunet_statistics_service.h - * @brief API to create, modify and access statistics about - * the operation of GNUnet; all statistical values - * must be of type `unsigned long long`. * @author Christian Grothoff - * @defgroup statistics Track statistics or provide access to statistics + * + * @file + * API to create, modify and access statistics. + * + * @defgroup statistics Statistics service + * Track statistics or provide access to statistics. + * + * Create, modify and access statistics about the operation of GNUnet. + * + * All statistical values must be of type `unsigned long long`. + * * @{ */ diff --git a/src/include/gnunet_strings_lib.h b/src/include/gnunet_strings_lib.h index e02884d40..a9e487cfa 100644 --- a/src/include/gnunet_strings_lib.h +++ b/src/include/gnunet_strings_lib.h @@ -19,15 +19,18 @@ */ /** - * @file include/gnunet_strings_lib.h - * @brief strings and string handling functions (including malloc - * and string tokenizing) - * * @author Christian Grothoff * @author Krista Bennett * @author Gerd Knorr * @author Ioana Patrascu * @author Tzvetan Horozov + * + * @file + * Strings and string handling functions + * + * @defgroup strings Strings library + * Strings and string handling functions, including malloc and string tokenizing. + * @{ */ #ifndef GNUNET_STRINGS_LIB_H @@ -615,7 +618,9 @@ GNUNET_STRINGS_parse_ipv6_policy (const char *routeListX); } #endif - /* ifndef GNUNET_UTIL_STRING_H */ #endif + +/** @} */ /* end of group */ + /* end of gnunet_util_string.h */ diff --git a/src/include/gnunet_testbed_logger_service.h b/src/include/gnunet_testbed_logger_service.h index 899e1c6c9..567ed3e48 100644 --- a/src/include/gnunet_testbed_logger_service.h +++ b/src/include/gnunet_testbed_logger_service.h @@ -19,9 +19,14 @@ */ /** - * @file include/gnunet_testbed_logger_service.h - * @brief API for submitting data to the testbed logger service * @author Sree Harsha Totakura + * + * @file + * API for submitting data to the testbed logger service + * + * @defgroup testbed-logger Testbed Logger service + * Submit data to the testbed logger service. + * @{ */ #ifndef GNUNET_TESTBED_LOGGER_SERVICE_H @@ -122,4 +127,6 @@ GNUNET_TESTBED_LOGGER_flush_cancel (struct GNUNET_TESTBED_LOGGER_Handle *h); #endif /* GNUNET_TESTBED_LOGGER_SERVICE_H */ +/** @} */ /* end of group */ + /* End of gnunet_testbed_logger_service.h */ diff --git a/src/include/gnunet_testbed_service.h b/src/include/gnunet_testbed_service.h index c36f068fb..04d7e93d6 100644 --- a/src/include/gnunet_testbed_service.h +++ b/src/include/gnunet_testbed_service.h @@ -19,10 +19,14 @@ */ /** - * @file include/gnunet_testbed_service.h - * @brief API for writing tests and creating large-scale - * emulation testbeds for GNUnet. * @author Christian Grothoff + * + * @file + * API for writing tests and creating large-scale emulation testbeds for GNUnet. + * + * @defgroup testbed Testbed service + * Writing tests and creating large-scale emulation testbeds for GNUnet. + * @{ */ #ifndef GNUNET_TESTBED_SERVICE_H @@ -1716,3 +1720,5 @@ GNUNET_TESTBED_underlaylinkmodel_free (struct GNUNET_TESTBED_UnderlayLinkModel * #endif #endif + +/** @} */ /* end of group */ diff --git a/src/include/gnunet_testing_lib.h b/src/include/gnunet_testing_lib.h index 0c63f047d..616125adc 100644 --- a/src/include/gnunet_testing_lib.h +++ b/src/include/gnunet_testing_lib.h @@ -19,15 +19,21 @@ */ /** - * @file include/gnunet_testing_lib.h - * @brief convenience API for writing testcases for GNUnet; - * can start/stop one or more peers on a system; - * testing is responsible for managing private keys, - * ports and paths; it is a low-level library that - * does not support higher-level functions such as - * P2P connection, topology management or distributed - * testbed maintenance (those are in gnunet_testbed_service.h) * @author Christian Grothoff + * + * @file + * Convenience API for writing testcases for GNUnet + * + * @defgroup testing Testing library + * Library for writing testcases for GNUnet. + * + * It can start/stop one or more peers on a system; testing is responsible for + * managing private keys, ports and paths; it is a low-level library that does + * not support higher-level functions such as P2P connection, topology + * management or distributed testbed maintenance (those are provided by the + * [Testbed service](@ref testbed)) + * + * @{ */ #ifndef GNUNET_TESTING_LIB_H @@ -460,3 +466,5 @@ GNUNET_TESTING_get_testname_from_underscore (const char *argv0); #endif #endif + +/** @} */ /* end of group */ diff --git a/src/include/gnunet_time_lib.h b/src/include/gnunet_time_lib.h index c4e771eeb..4077bd27d 100644 --- a/src/include/gnunet_time_lib.h +++ b/src/include/gnunet_time_lib.h @@ -19,10 +19,13 @@ */ /** - * @file include/gnunet_time_lib.h - * @brief functions related to time * @author Christian Grothoff - * @defgroup time Time and time calculations + * + * @file + * Functions related to time + * + * @defgroup time Time library + * Time and time calculations. * @{ */ @@ -521,9 +524,9 @@ GNUNET_TIME_time_to_year (struct GNUNET_TIME_Absolute at); } #endif -/** @} */ /* end of group time */ - - /* ifndef GNUNET_TIME_LIB_H */ #endif + +/** @} */ /* end of group time */ + /* end of gnunet_time_lib.h */ diff --git a/src/include/gnunet_transport_plugin.h b/src/include/gnunet_transport_plugin.h index 375104c46..515e66019 100644 --- a/src/include/gnunet_transport_plugin.h +++ b/src/include/gnunet_transport_plugin.h @@ -19,14 +19,19 @@ */ /** - * @file include/gnunet_transport_plugin.h - * @brief API for the transport services. This header - * specifies the struct that is given to the plugin's entry - * method and the other struct that must be returned. - * Note that the destructors of transport plugins will - * be given the value returned by the constructor - * and is expected to return a NULL pointer. * @author Christian Grothoff + * + * @file + * Transport service plugin API + * + * @defgroup transport-plugin Transport Service plugin API + * + * Specifies the struct that is given to the plugin's entry method and the other + * struct that must be returned. Note that the destructors of transport plugins + * will be given the value returned by the constructor and is expected to return + * a NULL pointer. + * + * @{ */ #ifndef PLUGIN_TRANSPORT_H #define PLUGIN_TRANSPORT_H @@ -706,4 +711,7 @@ struct GNUNET_TRANSPORT_PluginFunctions /*#ifndef PLUGIN_TRANSPORT_H*/ #endif + +/** @} */ /* end of group */ + /* end of gnunet_transport_plugin.h */ diff --git a/src/include/gnunet_transport_service.h b/src/include/gnunet_transport_service.h index 8a20c52a7..750330665 100644 --- a/src/include/gnunet_transport_service.h +++ b/src/include/gnunet_transport_service.h @@ -19,9 +19,14 @@ */ /** - * @file include/gnunet_transport_service.h - * @brief low-level P2P IO * @author Christian Grothoff + * + * @file + * Low-level P2P IO + * + * @defgroup transport Transport service + * Low-level P2P IO + * @{ */ #ifndef GNUNET_TRANSPORT_SERVICE_H @@ -950,4 +955,7 @@ GNUNET_TRANSPORT_monitor_plugins_cancel (struct GNUNET_TRANSPORT_PluginMonitor * /* ifndef GNUNET_TRANSPORT_SERVICE_H */ #endif + +/** @} */ /* end of group */ + /* end of gnunet_transport_service.h */ diff --git a/src/include/gnunet_tun_lib.h b/src/include/gnunet_tun_lib.h index 5c5627ee5..9b98ab13b 100644 --- a/src/include/gnunet_tun_lib.h +++ b/src/include/gnunet_tun_lib.h @@ -19,10 +19,15 @@ */ /** - * @file include/gnunet_tun_lib.h - * @brief standard TCP/IP network structs and IP checksum calculations for TUN interaction * @author Philipp Toelke * @author Christian Grothoff + * + * @file + * Standard TCP/IP network structs and IP checksum calculations for TUN interaction + * + * @defgroup tun TUN library + * Standard TCP/IP network structs and IP checksum calculations for TUN interaction + * @{ */ #ifndef GNUNET_TUN_LIB_H #define GNUNET_TUN_LIB_H @@ -912,3 +917,5 @@ GNUNET_TUN_service_name_to_hash (const char *service_name, struct GNUNET_HashCode *hc); #endif + +/** @} */ /* end of group */ diff --git a/src/include/gnunet_util_lib.h b/src/include/gnunet_util_lib.h index 43680fcbd..c2e18dd7c 100644 --- a/src/include/gnunet_util_lib.h +++ b/src/include/gnunet_util_lib.h @@ -19,10 +19,10 @@ */ /** - * @file include/gnunet_util_lib.h - * @brief convenience header including all headers of subsystems in - * gnunet_util library * @author Christian Grothoff + * + * @file + * Convenience header including all headers of subsystems in the gnunet_util library */ #ifndef GNUNET_UTIL_LIB_H diff --git a/src/include/gnunet_util_taler_wallet_lib.h b/src/include/gnunet_util_taler_wallet_lib.h index db2889928..725982277 100644 --- a/src/include/gnunet_util_taler_wallet_lib.h +++ b/src/include/gnunet_util_taler_wallet_lib.h @@ -19,15 +19,16 @@ */ /** - * @file include/gnunet_util_taler_wallet_lib.h - * @brief convenience header including all headers of subsystems in - * gnunet_util_taler_wallet library. Note that (due to the - * structure of the original headers), not all symbols declared - * by the included headers are actually included in the - * gnunet_util_taler_wallet library! The library excludes anything - * relating to the GNUnet installation location, scheduler, networking - * or OS-specific logic that would not apply to Apps/Browser extensions. * @author Christian Grothoff + * + * @file + * Convenience header including all headers of subsystems in + * gnunet_util_taler_wallet library. Note that (due to the structure of the + * original headers), not all symbols declared by the included headers are + * actually included in the gnunet_util_taler_wallet library! The library + * excludes anything relating to the GNUnet installation location, scheduler, + * networking or OS-specific logic that would not apply to Apps/Browser + * extensions. */ #ifndef GNUNET_UTIL_TALER_WALLET_LIB_H diff --git a/src/include/gnunet_vpn_service.h b/src/include/gnunet_vpn_service.h index 187a3ceda..2e09cf2e7 100644 --- a/src/include/gnunet_vpn_service.h +++ b/src/include/gnunet_vpn_service.h @@ -19,9 +19,14 @@ */ /** - * @file include/gnunet_vpn_service.h - * @brief API to access the VPN service. * @author Christian Grothoff + * + * @file + * API to access the VPN service. + * + * @defgroup vpn VPN service + * + * @{ */ #ifndef GNUNET_VPN_SERVICE_H #define GNUNET_VPN_SERVICE_H @@ -99,7 +104,7 @@ GNUNET_VPN_redirect_to_peer (struct GNUNET_VPN_Handle *vh, GNUNET_VPN_AllocationCallback cb, void *cb_cls); - + /** * Tell the VPN that forwarding to the Internet via some exit node is * requested. Note that both UDP and TCP traffic will be forwarded, @@ -152,3 +157,5 @@ void GNUNET_VPN_disconnect (struct GNUNET_VPN_Handle *vh); #endif + +/** @} */ /* end of group */ diff --git a/src/include/platform.h b/src/include/platform.h index 1529bde15..1d81b0ae8 100644 --- a/src/include/platform.h +++ b/src/include/platform.h @@ -19,10 +19,12 @@ */ /** - * @file include/platform.h - * @brief plaform specific includes and defines * @author Nils Durner * @author Christian Grothoff + * + * @file + * Plaform specific includes and defines. + * * This file should never be included by installed * header files (those starting with "gnunet_"). */ diff --git a/src/include/plibc.h b/src/include/plibc.h index c8b6453bf..9c1d954e9 100644 --- a/src/include/plibc.h +++ b/src/include/plibc.h @@ -18,10 +18,12 @@ */ /** - * @file include/plibc.h - * @brief PlibC header + * @file + * PlibC header + * * @attention This file is usually not installed under Unix, * so ship it with your application + * * @version $Revision: 158 $ */ diff --git a/src/include/tap-windows.h b/src/include/tap-windows.h index 09ca745b1..c9eb38eba 100644 --- a/src/include/tap-windows.h +++ b/src/include/tap-windows.h @@ -22,8 +22,9 @@ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA */ /** - * @file include/tap-windows.h - * @brief TAP32 virtual network driver defines + * @file + * TAP32 virtual network driver defines + * * @attention This file is part of openvpn and for kept * as a separate file to allow easier upgrading. */ diff --git a/src/include/winproc.h b/src/include/winproc.h index 3fbe13328..ef0bc7273 100644 --- a/src/include/winproc.h +++ b/src/include/winproc.h @@ -19,9 +19,10 @@ */ /** - * @file include/winproc.h - * @brief Definitions for MS Windows * @author Nils Durner + * + * @file + * Definitions for MS Windows */ #ifndef _WINPROC_H