summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorChristian Grothoff <christian@grothoff.org>2014-03-04 21:42:35 +0000
committerChristian Grothoff <christian@grothoff.org>2014-03-04 21:42:35 +0000
commit1a4116176c28e1edc534a568fc1e9085e3b6b3ce (patch)
treeaf09722a944cf05b12d292d9bb6f15e837e74d66
parentdd5c9a16d543a336adec30723215a3125e842bac (diff)
-doxygen
-rw-r--r--po/POTFILES.in5
-rw-r--r--src/include/gnunet_hello_lib.h59
2 files changed, 39 insertions, 25 deletions
diff --git a/po/POTFILES.in b/po/POTFILES.in
index 5e917d135..0e683b682 100644
--- a/po/POTFILES.in
+++ b/po/POTFILES.in
@@ -5,6 +5,7 @@ src/arm/gnunet-service-arm.c
src/arm/mockup-service.c
src/ats/ats_api_performance.c
src/ats/ats_api_scheduling.c
+src/ats/gnunet-ats-solver-eval.c
src/ats/gnunet-service-ats_addresses.c
src/ats/gnunet-service-ats.c
src/ats/gnunet-service-ats_normalization.c
@@ -17,8 +18,10 @@ src/ats/plugin_ats_ril.c
src/ats-tests/ats-testing.c
src/ats-tests/ats-testing-experiment.c
src/ats-tests/ats-testing-log.c
+src/ats-tests/ats-testing-preferences.c
src/ats-tests/ats-testing-traffic.c
src/ats-tests/gnunet-ats-sim.c
+src/ats-tests/gnunet-solver-eval.c
src/ats-tool/gnunet-ats.c
src/block/block.c
src/block/plugin_block_template.c
@@ -182,6 +185,7 @@ src/mesh/gnunet-service-mesh.c
src/mesh/gnunet-service-mesh_channel.c
src/mesh/gnunet-service-mesh_connection.c
src/mesh/gnunet-service-mesh_dht.c
+src/mesh/gnunet-service-mesh_hello.c
src/mesh/gnunet-service-mesh_local.c
src/mesh/gnunet-service-mesh_peer.c
src/mesh/gnunet-service-mesh_tunnel.c
@@ -190,7 +194,6 @@ src/mesh/mesh_common.c
src/mesh/mesh_path.c
src/mesh/mesh_test_lib.c
src/mesh/mesh_tunnel_tree.c
-src/mesh/plugin_block_mesh.c
src/multicast/gnunet-multicast.c
src/multicast/gnunet-service-multicast.c
src/multicast/multicast_api.c
diff --git a/src/include/gnunet_hello_lib.h b/src/include/gnunet_hello_lib.h
index 694dfe066..8e96b5879 100644
--- a/src/include/gnunet_hello_lib.h
+++ b/src/include/gnunet_hello_lib.h
@@ -85,18 +85,6 @@ struct GNUNET_HELLO_Address
struct GNUNET_PeerIdentity peer;
/**
- * Extended information about address
- *
- * This field contains additional #GNUNET_HELLO_AddressInfo flags e.g.
- * to indicate an address is inbound and cannot be used to initiate an
- * outbound connection.
- *
- * These information are only valid for the local peer and are not serialized
- * when a #GNUNET_HELLO_Message is created
- */
- enum GNUNET_HELLO_AddressInfo local_info;
-
- /**
* Name of the transport plugin enabling the communication using
* this address.
*/
@@ -108,28 +96,43 @@ struct GNUNET_HELLO_Address
const void *address;
/**
- * Number of bytes in 'address'.
+ * Number of bytes in @e address.
*/
size_t address_length;
+ /**
+ * Extended information about address
+ *
+ * This field contains additional #GNUNET_HELLO_AddressInfo flags e.g.
+ * to indicate an address is inbound and cannot be used to initiate an
+ * outbound connection.
+ *
+ * These information are only valid for the local peer and are not serialized
+ * when a #GNUNET_HELLO_Message is created
+ */
+ enum GNUNET_HELLO_AddressInfo local_info;
+
};
+
/**
* Allocate an address struct.
*
* @param peer the peer
* @param transport_name plugin name
* @param address binary address
- * @param address_length number of bytes in 'address'
+ * @param address_length number of bytes in @a address
* @param local_info additional local information for the address
* @return the address struct
*/
struct GNUNET_HELLO_Address *
GNUNET_HELLO_address_allocate (const struct GNUNET_PeerIdentity *peer,
- const char *transport_name, const void *address,
+ const char *transport_name,
+ const void *address,
size_t address_length,
enum GNUNET_HELLO_AddressInfo local_info);
+
/**
* Copy an address struct.
*
@@ -146,12 +149,13 @@ GNUNET_HELLO_address_copy (const struct GNUNET_HELLO_Address *address);
*
* @param a1 first address
* @param a2 second address
- * @return 0 if the addresses are equal, -1 if a1<a2, 1 if a1>a2.
+ * @return 0 if the addresses are equal, -1 if @a a1< @a a2, 1 if @a a1> @a a2.
*/
int
GNUNET_HELLO_address_cmp (const struct GNUNET_HELLO_Address *a1,
const struct GNUNET_HELLO_Address *a2);
+
/**
* Get the size of an address struct.
*
@@ -161,16 +165,17 @@ GNUNET_HELLO_address_cmp (const struct GNUNET_HELLO_Address *a1,
size_t
GNUNET_HELLO_address_get_size (const struct GNUNET_HELLO_Address *address);
+
/**
* Check if an address has a local option set
*
* @param address the address to check
* @param option the respective option to check for
- * @return GNUNET_YES or GNUNET_NO
+ * @return #GNUNET_YES or #GNUNET_NO
*/
int
-GNUNET_HELLO_address_check_option (const struct GNUNET_HELLO_Address * address,
- enum GNUNET_HELLO_AddressInfo option);
+GNUNET_HELLO_address_check_option (const struct GNUNET_HELLO_Address *address,
+ enum GNUNET_HELLO_AddressInfo option);
/**
@@ -184,7 +189,7 @@ GNUNET_HELLO_address_check_option (const struct GNUNET_HELLO_Address * address,
/**
* A HELLO message is used to exchange information about
* transports with other peers. This struct is guaranteed
- * to start with a "GNUNET_MessageHeader", everything else
+ * to start with a `struct GNUNET_MessageHeader`, everything else
* should be internal to the HELLO library.
*/
struct GNUNET_HELLO_Message;
@@ -213,7 +218,8 @@ GNUNET_HELLO_is_friend_only (const struct GNUNET_HELLO_Message *h);
*/
size_t
GNUNET_HELLO_add_address (const struct GNUNET_HELLO_Address *address,
- struct GNUNET_TIME_Absolute expiration, char *target,
+ struct GNUNET_TIME_Absolute expiration,
+ char *target,
size_t max);
@@ -239,9 +245,13 @@ typedef size_t
* expiration time and an iterator that spews the
* transport addresses.
*
- * If friend only is set to #GNUNET_YES we create a FRIEND_HELLO which will
- * not be gossiped to other peers
+ * If friend only is set to #GNUNET_YES we create a FRIEND_HELLO which
+ * will not be gossiped to other peers.
*
+ * @param publicKey public key to include in the HELLO
+ * @param addrgen callback to invoke to get addresses
+ * @param addrgen_cls closure for @a addrgen
+ * @param friend_only should the returned HELLO be only visible to friends?
* @return the hello message
*/
struct GNUNET_HELLO_Message *
@@ -349,7 +359,7 @@ GNUNET_HELLO_iterate_addresses (const struct GNUNET_HELLO_Message *msg,
* @param expiration_limit ignore addresses in old_hello
* that expired before the given time stamp
* @param it iterator to call on each address
- * @param it_cls closure for it
+ * @param it_cls closure for @a it
*/
void
GNUNET_HELLO_iterate_new_addresses (const struct GNUNET_HELLO_Message *new_hello,
@@ -410,6 +420,7 @@ char *
GNUNET_HELLO_compose_uri (const struct GNUNET_HELLO_Message *hello,
GNUNET_HELLO_TransportPluginsFind plugins_find);
+
/**
* Parse a hello URI string to a hello message.
*