From 5599d5db9973688a098b3c58bc72f31382e5c1d8 Mon Sep 17 00:00:00 2001 From: Willow Liquorice Date: Sat, 17 Sep 2022 08:43:59 +0100 Subject: -DOC: Continued organisation of modules into nested groups --- src/include/block_dns.h | 5 +++++ src/include/block_fs.h | 5 +++++ src/include/gnunet_abd_service.h | 7 ++++++- src/include/gnunet_applications.h | 5 +++++ src/include/gnunet_container_lib.h | 18 ++++++++++++------ src/include/gnunet_curl_lib.h | 5 +++++ src/include/gnunet_friends_lib.h | 5 +++++ src/include/gnunet_load_lib.h | 5 +++++ src/include/gnunet_my_lib.h | 5 +++++ src/include/gnunet_nat_auto_service.h | 2 +- src/include/gnunet_nt_lib.h | 5 +++++ src/include/gnunet_resolver_service.h | 5 +++++ src/include/gnunet_socks.h | 5 +++++ src/include/gnunet_transport_application_service.h | 4 +--- 14 files changed, 70 insertions(+), 11 deletions(-) (limited to 'src/include') diff --git a/src/include/block_dns.h b/src/include/block_dns.h index 2186cb1a1..2c573fb20 100644 --- a/src/include/block_dns.h +++ b/src/include/block_dns.h @@ -19,6 +19,9 @@ */ /** + * @addtogroup vpn_suite + * @{ + * * @author Christian Grothoff * * @file @@ -65,3 +68,5 @@ GNUNET_NETWORK_STRUCT_END #endif /** @} */ /* end of group */ + +/** @} */ /* end of group addition to vpn_suite */ diff --git a/src/include/block_fs.h b/src/include/block_fs.h index e4caf6e50..f05bb4a29 100644 --- a/src/include/block_fs.h +++ b/src/include/block_fs.h @@ -19,6 +19,9 @@ */ /** + * @addtogroup fs_l2 + * @{ + * * @author Christian Grothoff * * @file @@ -98,3 +101,5 @@ GNUNET_NETWORK_STRUCT_END #endif /** @} */ /* end of group */ + +/** @} */ /* end of group addition to fs_l2 */ diff --git a/src/include/gnunet_abd_service.h b/src/include/gnunet_abd_service.h index ad0719d2c..a52ed29ff 100644 --- a/src/include/gnunet_abd_service.h +++ b/src/include/gnunet_abd_service.h @@ -19,13 +19,16 @@ */ /** + * @addtogroup reclaim_suite + * @{ + * * @author Martin Schanzenbach * * @file * API to the Credential service * * @defgroup abd Credential service - * Credentials + * Credential service for Attribute-Based Decryption * * @{ */ @@ -415,3 +418,5 @@ GNUNET_ABD_request_cancel (struct GNUNET_ABD_Request *lr); #endif /** @} */ /* end of group */ + +/** @} */ /* end of group addition to reclaim_suite */ diff --git a/src/include/gnunet_applications.h b/src/include/gnunet_applications.h index 1e2ac59f7..489dc7050 100644 --- a/src/include/gnunet_applications.h +++ b/src/include/gnunet_applications.h @@ -19,6 +19,9 @@ */ /** + * @addtogroup Backbone + * @{ + * * @author Christian Grothoff * * @file @@ -133,4 +136,6 @@ extern "C" /** @} */ /* end of group */ +/** @} */ /* end of group addition to Backbone */ + /* end of gnunet_applications.h */ diff --git a/src/include/gnunet_container_lib.h b/src/include/gnunet_container_lib.h index 097ee040d..b31a95fac 100644 --- a/src/include/gnunet_container_lib.h +++ b/src/include/gnunet_container_lib.h @@ -28,24 +28,30 @@ * * @file * Container classes for GNUnet - * - * @defgroup hashmap Container library: MultiHashMap + * + * @addtogroup container + * Common data structures in GNUnet programs + * @{ + * + * @defgroup hashmap MultiHashMap * Hash map with multiple values per key. * * @see [Documentation](https://gnunet.org/util_multihashmap) * - * @defgroup heap Container library: Heap + * @defgroup heap Heap * Min- or max-heap with arbitrary element removal * - * @defgroup bloomfilter Container library: Bloom filter + * @defgroup bloomfilter Bloom filter * Probabilistic set tests * - * @defgroup dll Container library: Doubly-linked list + * @defgroup dll Doubly-linked list * * @see [Documentation](https://gnunet.org/mdll-api) * - * @defgroup metadata Container library: Metadata + * @defgroup metadata Metadata * GNU libextractor key-value pairs + * + * @} */ #ifndef GNUNET_CONTAINER_LIB_H diff --git a/src/include/gnunet_curl_lib.h b/src/include/gnunet_curl_lib.h index ab2d82060..92334887d 100644 --- a/src/include/gnunet_curl_lib.h +++ b/src/include/gnunet_curl_lib.h @@ -18,6 +18,9 @@ SPDX-License-Identifier: AGPL3.0-or-later */ /** + * @addtogroup lib_extra Additional libraries + * @{ + * * @file src/include/gnunet_curl_lib.h * @brief library to make it easy to download JSON replies over HTTP * @author Sree Harsha Totakura @@ -436,4 +439,6 @@ GNUNET_CURL_is_valid_scope_id (const char *scope_id); #endif /** @} */ /* end of group */ +/** @} */ /* end of group addition to lib_extra */ + /* end of gnunet_curl_lib.h */ diff --git a/src/include/gnunet_friends_lib.h b/src/include/gnunet_friends_lib.h index d591ea082..03fa6c72d 100644 --- a/src/include/gnunet_friends_lib.h +++ b/src/include/gnunet_friends_lib.h @@ -19,6 +19,9 @@ */ /** + * @addtogroup Backbone + * @{ + * * @author Christian Grothoff * * @file @@ -116,3 +119,5 @@ GNUNET_FRIENDS_write (struct GNUNET_FRIENDS_Writer *w, #endif /** @} */ /* end of group */ + +/** @} */ /* end of group addition to backbone */ diff --git a/src/include/gnunet_load_lib.h b/src/include/gnunet_load_lib.h index ef596807a..397d3aa2d 100644 --- a/src/include/gnunet_load_lib.h +++ b/src/include/gnunet_load_lib.h @@ -19,6 +19,9 @@ */ /** + * @addtogroup libgnunetutil + * @{ + * * @author Christian Grothoff * * @file @@ -124,4 +127,6 @@ GNUNET_LOAD_update (struct GNUNET_LOAD_Value *load, uint64_t data); /** @} */ /* end of group */ +/** @} */ /* end of group addition to libgnunetutil */ + /* end of gnunet_load_lib.h */ diff --git a/src/include/gnunet_my_lib.h b/src/include/gnunet_my_lib.h index 16b609979..96d8cab42 100644 --- a/src/include/gnunet_my_lib.h +++ b/src/include/gnunet_my_lib.h @@ -18,6 +18,9 @@ SPDX-License-Identifier: AGPL3.0-or-later */ /** + * @addtogroup lib_extra + * @{ + * * @author Christian Grothoff * @author Christophe Genevey * @@ -498,3 +501,5 @@ GNUNET_MY_cleanup_result (struct GNUNET_MY_ResultSpec *rs); #endif /** @} */ /* end of group */ + +/** @} */ /* end of group addition to lib_extra */ diff --git a/src/include/gnunet_nat_auto_service.h b/src/include/gnunet_nat_auto_service.h index 78284dc01..db3a8460d 100644 --- a/src/include/gnunet_nat_auto_service.h +++ b/src/include/gnunet_nat_auto_service.h @@ -26,7 +26,7 @@ * Service for testing and autoconfiguration of * NAT traversal functionality * - * @defgroup nat NAT testing library + * @defgroup nat NAT library * * @{ */ diff --git a/src/include/gnunet_nt_lib.h b/src/include/gnunet_nt_lib.h index 5c3ec86af..144a3daa3 100644 --- a/src/include/gnunet_nt_lib.h +++ b/src/include/gnunet_nt_lib.h @@ -18,6 +18,9 @@ SPDX-License-Identifier: AGPL3.0-or-later */ /** + * @addtogroup Backbone + * @{ + * * @file network type characterization * @author Christian Grothoff * @author Matthias Wachs @@ -122,3 +125,5 @@ GNUNET_NT_scanner_done (struct GNUNET_NT_InterfaceScanner *is); #endif /** @} */ /* end of group */ + +/** @} */ /* end of group addition to backbone */ diff --git a/src/include/gnunet_resolver_service.h b/src/include/gnunet_resolver_service.h index 956e4d67e..80c92dc4e 100644 --- a/src/include/gnunet_resolver_service.h +++ b/src/include/gnunet_resolver_service.h @@ -19,6 +19,9 @@ */ /** + * @addtogroup vpn_suite + * @{ + * * @author Christian Grothoff * * @file @@ -178,4 +181,6 @@ GNUNET_RESOLVER_request_cancel (struct GNUNET_RESOLVER_RequestHandle *rh); /** @} */ /* end of group resolver */ +/** @} */ /* end of group addition to vpn_suite */ + /* end of gnunet_resolver_service.h */ diff --git a/src/include/gnunet_socks.h b/src/include/gnunet_socks.h index 1a6ae1119..b82943da3 100644 --- a/src/include/gnunet_socks.h +++ b/src/include/gnunet_socks.h @@ -19,6 +19,9 @@ */ /** + * @addtogroup libgnunetutil + * @{ + * * @author Jeffrey Burdges * * @file @@ -81,4 +84,6 @@ GNUNET_SOCKS_do_connect (const char *service_name, /** @} */ /* end of group */ +/** @} */ /* end of group addition to libgnunetutil */ + /* end of gnunet_socks.h */ diff --git a/src/include/gnunet_transport_application_service.h b/src/include/gnunet_transport_application_service.h index 5767082d9..9a6ddd36a 100644 --- a/src/include/gnunet_transport_application_service.h +++ b/src/include/gnunet_transport_application_service.h @@ -27,9 +27,7 @@ * @author Christian Grothoff * @author Matthias Wachs * - * @defgroup TRANSPORT service - * Bandwidth allocation - * + * @defgroup transport Transport service * @{ */ #ifndef GNUNET_TRANSPORT_APPLICATION_SERVICE_H -- cgit v1.2.3