aboutsummaryrefslogtreecommitdiff
path: root/src/include
diff options
context:
space:
mode:
authorWillow Liquorice <willow@howhill.com>2022-09-17 08:43:59 +0100
committerWillow Liquorice <willow@howhill.com>2022-10-03 13:14:45 +0100
commit5599d5db9973688a098b3c58bc72f31382e5c1d8 (patch)
tree63b1c9f24b1292bad1354f315062c08e8da21b54 /src/include
parent43dc9b3ebcd7803c8184c89ecf45b9fee6ba7d88 (diff)
downloadgnunet-5599d5db9973688a098b3c58bc72f31382e5c1d8.tar.gz
gnunet-5599d5db9973688a098b3c58bc72f31382e5c1d8.zip
-DOC: Continued organisation of modules into nested groups
Diffstat (limited to 'src/include')
-rw-r--r--src/include/block_dns.h5
-rw-r--r--src/include/block_fs.h5
-rw-r--r--src/include/gnunet_abd_service.h7
-rw-r--r--src/include/gnunet_applications.h5
-rw-r--r--src/include/gnunet_container_lib.h18
-rw-r--r--src/include/gnunet_curl_lib.h5
-rw-r--r--src/include/gnunet_friends_lib.h5
-rw-r--r--src/include/gnunet_load_lib.h5
-rw-r--r--src/include/gnunet_my_lib.h5
-rw-r--r--src/include/gnunet_nat_auto_service.h2
-rw-r--r--src/include/gnunet_nt_lib.h5
-rw-r--r--src/include/gnunet_resolver_service.h5
-rw-r--r--src/include/gnunet_socks.h5
-rw-r--r--src/include/gnunet_transport_application_service.h4
14 files changed, 70 insertions, 11 deletions
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 @@
19 */ 19 */
20 20
21/** 21/**
22 * @addtogroup vpn_suite
23 * @{
24 *
22 * @author Christian Grothoff 25 * @author Christian Grothoff
23 * 26 *
24 * @file 27 * @file
@@ -65,3 +68,5 @@ GNUNET_NETWORK_STRUCT_END
65#endif 68#endif
66 69
67/** @} */ /* end of group */ 70/** @} */ /* end of group */
71
72/** @} */ /* 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 @@
19 */ 19 */
20 20
21/** 21/**
22 * @addtogroup fs_l2
23 * @{
24 *
22 * @author Christian Grothoff 25 * @author Christian Grothoff
23 * 26 *
24 * @file 27 * @file
@@ -98,3 +101,5 @@ GNUNET_NETWORK_STRUCT_END
98#endif 101#endif
99 102
100/** @} */ /* end of group */ 103/** @} */ /* end of group */
104
105/** @} */ /* 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 @@
19 */ 19 */
20 20
21/** 21/**
22 * @addtogroup reclaim_suite
23 * @{
24 *
22 * @author Martin Schanzenbach 25 * @author Martin Schanzenbach
23 * 26 *
24 * @file 27 * @file
25 * API to the Credential service 28 * API to the Credential service
26 * 29 *
27 * @defgroup abd Credential service 30 * @defgroup abd Credential service
28 * Credentials 31 * Credential service for Attribute-Based Decryption
29 * 32 *
30 * @{ 33 * @{
31 */ 34 */
@@ -415,3 +418,5 @@ GNUNET_ABD_request_cancel (struct GNUNET_ABD_Request *lr);
415#endif 418#endif
416 419
417/** @} */ /* end of group */ 420/** @} */ /* end of group */
421
422/** @} */ /* 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 @@
19 */ 19 */
20 20
21/** 21/**
22 * @addtogroup Backbone
23 * @{
24 *
22 * @author Christian Grothoff 25 * @author Christian Grothoff
23 * 26 *
24 * @file 27 * @file
@@ -133,4 +136,6 @@ extern "C"
133 136
134/** @} */ /* end of group */ 137/** @} */ /* end of group */
135 138
139/** @} */ /* end of group addition to Backbone */
140
136/* end of gnunet_applications.h */ 141/* 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 @@
28 * 28 *
29 * @file 29 * @file
30 * Container classes for GNUnet 30 * Container classes for GNUnet
31 * 31 *
32 * @defgroup hashmap Container library: MultiHashMap 32 * @addtogroup container
33 * Common data structures in GNUnet programs
34 * @{
35 *
36 * @defgroup hashmap MultiHashMap
33 * Hash map with multiple values per key. 37 * Hash map with multiple values per key.
34 * 38 *
35 * @see [Documentation](https://gnunet.org/util_multihashmap) 39 * @see [Documentation](https://gnunet.org/util_multihashmap)
36 * 40 *
37 * @defgroup heap Container library: Heap 41 * @defgroup heap Heap
38 * Min- or max-heap with arbitrary element removal 42 * Min- or max-heap with arbitrary element removal
39 * 43 *
40 * @defgroup bloomfilter Container library: Bloom filter 44 * @defgroup bloomfilter Bloom filter
41 * Probabilistic set tests 45 * Probabilistic set tests
42 * 46 *
43 * @defgroup dll Container library: Doubly-linked list 47 * @defgroup dll Doubly-linked list
44 * 48 *
45 * @see [Documentation](https://gnunet.org/mdll-api) 49 * @see [Documentation](https://gnunet.org/mdll-api)
46 * 50 *
47 * @defgroup metadata Container library: Metadata 51 * @defgroup metadata Metadata
48 * GNU libextractor key-value pairs 52 * GNU libextractor key-value pairs
53 *
54 * @}
49 */ 55 */
50 56
51#ifndef GNUNET_CONTAINER_LIB_H 57#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 @@
18 SPDX-License-Identifier: AGPL3.0-or-later 18 SPDX-License-Identifier: AGPL3.0-or-later
19 */ 19 */
20/** 20/**
21 * @addtogroup lib_extra Additional libraries
22 * @{
23 *
21 * @file src/include/gnunet_curl_lib.h 24 * @file src/include/gnunet_curl_lib.h
22 * @brief library to make it easy to download JSON replies over HTTP 25 * @brief library to make it easy to download JSON replies over HTTP
23 * @author Sree Harsha Totakura <sreeharsha@totakura.in> 26 * @author Sree Harsha Totakura <sreeharsha@totakura.in>
@@ -436,4 +439,6 @@ GNUNET_CURL_is_valid_scope_id (const char *scope_id);
436#endif 439#endif
437/** @} */ /* end of group */ 440/** @} */ /* end of group */
438 441
442/** @} */ /* end of group addition to lib_extra */
443
439/* end of gnunet_curl_lib.h */ 444/* 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 @@
19 */ 19 */
20 20
21/** 21/**
22 * @addtogroup Backbone
23 * @{
24 *
22 * @author Christian Grothoff 25 * @author Christian Grothoff
23 * 26 *
24 * @file 27 * @file
@@ -116,3 +119,5 @@ GNUNET_FRIENDS_write (struct GNUNET_FRIENDS_Writer *w,
116#endif 119#endif
117 120
118/** @} */ /* end of group */ 121/** @} */ /* end of group */
122
123/** @} */ /* 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 @@
19 */ 19 */
20 20
21/** 21/**
22 * @addtogroup libgnunetutil
23 * @{
24 *
22 * @author Christian Grothoff 25 * @author Christian Grothoff
23 * 26 *
24 * @file 27 * @file
@@ -124,4 +127,6 @@ GNUNET_LOAD_update (struct GNUNET_LOAD_Value *load, uint64_t data);
124 127
125/** @} */ /* end of group */ 128/** @} */ /* end of group */
126 129
130/** @} */ /* end of group addition to libgnunetutil */
131
127/* end of gnunet_load_lib.h */ 132/* 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 @@
18 SPDX-License-Identifier: AGPL3.0-or-later 18 SPDX-License-Identifier: AGPL3.0-or-later
19 */ 19 */
20/** 20/**
21 * @addtogroup lib_extra
22 * @{
23 *
21 * @author Christian Grothoff 24 * @author Christian Grothoff
22 * @author Christophe Genevey 25 * @author Christophe Genevey
23 * 26 *
@@ -498,3 +501,5 @@ GNUNET_MY_cleanup_result (struct GNUNET_MY_ResultSpec *rs);
498#endif 501#endif
499 502
500/** @} */ /* end of group */ 503/** @} */ /* end of group */
504
505/** @} */ /* 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 @@
26 * Service for testing and autoconfiguration of 26 * Service for testing and autoconfiguration of
27 * NAT traversal functionality 27 * NAT traversal functionality
28 * 28 *
29 * @defgroup nat NAT testing library 29 * @defgroup nat NAT library
30 * 30 *
31 * @{ 31 * @{
32 */ 32 */
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 @@
18 SPDX-License-Identifier: AGPL3.0-or-later 18 SPDX-License-Identifier: AGPL3.0-or-later
19 */ 19 */
20/** 20/**
21 * @addtogroup Backbone
22 * @{
23 *
21 * @file network type characterization 24 * @file network type characterization
22 * @author Christian Grothoff 25 * @author Christian Grothoff
23 * @author Matthias Wachs 26 * @author Matthias Wachs
@@ -122,3 +125,5 @@ GNUNET_NT_scanner_done (struct GNUNET_NT_InterfaceScanner *is);
122#endif 125#endif
123 126
124/** @} */ /* end of group */ 127/** @} */ /* end of group */
128
129/** @} */ /* 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 @@
19 */ 19 */
20 20
21/** 21/**
22 * @addtogroup vpn_suite
23 * @{
24 *
22 * @author Christian Grothoff 25 * @author Christian Grothoff
23 * 26 *
24 * @file 27 * @file
@@ -178,4 +181,6 @@ GNUNET_RESOLVER_request_cancel (struct GNUNET_RESOLVER_RequestHandle *rh);
178 181
179/** @} */ /* end of group resolver */ 182/** @} */ /* end of group resolver */
180 183
184/** @} */ /* end of group addition to vpn_suite */
185
181/* end of gnunet_resolver_service.h */ 186/* 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 @@
19 */ 19 */
20 20
21/** 21/**
22 * @addtogroup libgnunetutil
23 * @{
24 *
22 * @author Jeffrey Burdges 25 * @author Jeffrey Burdges
23 * 26 *
24 * @file 27 * @file
@@ -81,4 +84,6 @@ GNUNET_SOCKS_do_connect (const char *service_name,
81 84
82/** @} */ /* end of group */ 85/** @} */ /* end of group */
83 86
87/** @} */ /* end of group addition to libgnunetutil */
88
84/* end of gnunet_socks.h */ 89/* 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 @@
27 * @author Christian Grothoff 27 * @author Christian Grothoff
28 * @author Matthias Wachs 28 * @author Matthias Wachs
29 * 29 *
30 * @defgroup TRANSPORT service 30 * @defgroup transport Transport service
31 * Bandwidth allocation
32 *
33 * @{ 31 * @{
34 */ 32 */
35#ifndef GNUNET_TRANSPORT_APPLICATION_SERVICE_H 33#ifndef GNUNET_TRANSPORT_APPLICATION_SERVICE_H