[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[GNUnet-SVN] r28560 - in gnunet/src: hostlist include namestore transpor
|
From: |
gnunet |
|
Subject: |
[GNUnet-SVN] r28560 - in gnunet/src: hostlist include namestore transport |
|
Date: |
Tue, 13 Aug 2013 11:18:29 +0200 |
Author: grothoff
Date: 2013-08-13 11:18:29 +0200 (Tue, 13 Aug 2013)
New Revision: 28560
Modified:
gnunet/src/hostlist/hostlist-client.c
gnunet/src/include/gnunet_namestore_service.h
gnunet/src/namestore/namestore_api_common.c
gnunet/src/transport/plugin_transport_http_server.c
Log:
-doxygen fixes
Modified: gnunet/src/hostlist/hostlist-client.c
===================================================================
--- gnunet/src/hostlist/hostlist-client.c 2013-08-13 08:56:23 UTC (rev
28559)
+++ gnunet/src/hostlist/hostlist-client.c 2013-08-13 09:18:29 UTC (rev
28560)
@@ -1226,7 +1226,13 @@
/**
+ * We've received the previous delay value from statistics. Remember it.
+ *
+ * @param cls NULL, unused
+ * @param subsystem should be "hostlist", unused
+ * @param name will be "milliseconds between hostlist downloads", unused
* @param value previous delay value, in milliseconds (!)
+ * @param is_persistent unused, will be GNUNET_YES
*/
static int
process_stat (void *cls, const char *subsystem, const char *name,
Modified: gnunet/src/include/gnunet_namestore_service.h
===================================================================
--- gnunet/src/include/gnunet_namestore_service.h 2013-08-13 08:56:23 UTC
(rev 28559)
+++ gnunet/src/include/gnunet_namestore_service.h 2013-08-13 09:18:29 UTC
(rev 28560)
@@ -365,7 +365,7 @@
* Cancel a namestore operation. The final callback from the
* operation must not have been done yet. Must be called on any
* namestore operation that has not yet completed prior to calling
- * 'GNUNET_NAMESTORE_disconnect'.
+ * #GNUNET_NAMESTORE_disconnect.
*
* @param qe operation to cancel
*/
@@ -375,13 +375,11 @@
/**
* Starts a new zone iteration (used to periodically PUT all of our
- * records into our DHT). "proc" will be called once immediately, and
- * then again after "GNUNET_NAMESTORE_zone_iterator_next" is invoked.
+ * records into our DHT). @a proc will be called once immediately, and
+ * then again after #GNUNET_NAMESTORE_zone_iterator_next is invoked.
*
* @param h handle to the namestore
* @param zone zone to access
- * @param must_have_flags flags that must be set for the record to be returned
- * @param must_not_have_flags flags that must NOT be set for the record to be
returned
* @param proc function to call on each name from the zone; it
* will be called repeatedly with a value (if available)
* and always once at the end with a name of NULL.
@@ -408,7 +406,7 @@
/**
* Stops iteration and releases the namestore handle for further calls. Must
* be called on any iteration that has not yet completed prior to calling
- * 'GNUNET_NAMESTORE_disconnect'.
+ * #GNUNET_NAMESTORE_disconnect.
*
* @param it the iterator
*/
@@ -441,11 +439,6 @@
* the connection is re-established, the process begins from the start (all
* existing records, sync, then updates).
*
- * Note that the 'signature' in the 'monitor' callback will always be
- * NULL (as signatures are usually not valuable to monitoring clients,
- * the service does not bother to generate a valid signature for
- * monitoring).
- *
* @param cfg configuration to use to connect to namestore
* @param zone zone to monitor
* @param monitor function to call on zone changes
@@ -477,7 +470,7 @@
* records.
*
* @param rd_count number of records in the rd array
- * @param rd array of GNUNET_NAMESTORE_RecordData with rd_count elements
+ * @param rd array of #GNUNET_NAMESTORE_RecordData with @a rd_count elements
*
* @return the required size to serialize
*
@@ -491,10 +484,9 @@
* Serialize the given records to the given destination buffer.
*
* @param rd_count number of records in the rd array
- * @param rd array of GNUNET_NAMESTORE_RecordData with rd_count elements
+ * @param rd array of #GNUNET_NAMESTORE_RecordData with @a rd_count elements
* @param dest_size size of the destination array
* @param dest where to write the result
- *
* @return the size of serialized records, -1 if records do not fit
*/
ssize_t
@@ -576,8 +568,8 @@
* Test if a given record is expired.
*
* @param rd record to test
- * @return GNUNET_YES if the record is expired,
- * GNUNET_NO if not
+ * @return #GNUNET_YES if the record is expired,
+ * #GNUNET_NO if not
*/
int
GNUNET_NAMESTORE_is_expired (const struct GNUNET_NAMESTORE_RecordData *rd);
@@ -598,18 +590,18 @@
* NOT reentrant!
*
* @param z public key of a zone
- * @return string form; will be overwritten by next call to GNUNET_h2s.
+ * @return string form; will be overwritten by next call to
#GNUNET_NAMESTORE_z2s.
*/
const char *
GNUNET_NAMESTORE_z2s (const struct GNUNET_CRYPTO_EccPublicKey *z);
/**
- * Calculate the DHT query for a given 'label' in a given zone.
+ * Calculate the DHT query for a given @a label in a given @a zone.
*
* @param zone private key of the zone
* @param label label of the record
- * @return query hash to use for the query
+ * @param query hash to use for the query
*/
void
GNUNET_NAMESTORE_query_from_private_key (const struct
GNUNET_CRYPTO_EccPrivateKey *zone,
@@ -618,11 +610,11 @@
/**
- * Calculate the DHT query for a given 'label' in a given zone.
+ * Calculate the DHT query for a given @a label in a given @a zone.
*
* @param pub public key of the zone
* @param label label of the record
- * @return query hash to use for the query
+ * @param query hash to use for the query
*/
void
GNUNET_NAMESTORE_query_from_public_key (const struct
GNUNET_CRYPTO_EccPublicKey *pub,
@@ -638,7 +630,6 @@
* @param label the name for the records
* @param rd record data
* @param rd_count number of records
- * @param signature where to store the signature
*/
struct GNUNET_NAMESTORE_Block *
GNUNET_NAMESTORE_block_create (const struct GNUNET_CRYPTO_EccPrivateKey *key,
@@ -653,7 +644,7 @@
* to validate signatures received from the network.
*
* @param block block to verify
- * @return GNUNET_OK if the signature is valid
+ * @return #GNUNET_OK if the signature is valid
*/
int
GNUNET_NAMESTORE_block_verify (const struct GNUNET_NAMESTORE_Block *block);
@@ -667,7 +658,7 @@
* @param label the name for the records
* @param proc function to call with the result
* @param proc_cls closure for proc
- * @param GNUNET_OK on success, GNUNET_SYSERR if the block was
+ * @return #GNUNET_OK on success, #GNUNET_SYSERR if the block was
* not well-formed
*/
int
@@ -681,10 +672,9 @@
/**
* Compares if two records are equal
*
- * @param a Record a
- * @param b Record b
- *
- * @return GNUNET_YES or GNUNET_NO
+ * @param a a record
+ * @param b another record
+ * @return #GNUNET_YES if the records are equal, or #GNUNET_NO if not.
*/
int
GNUNET_NAMESTORE_records_cmp (const struct GNUNET_NAMESTORE_RecordData *a,
Modified: gnunet/src/namestore/namestore_api_common.c
===================================================================
--- gnunet/src/namestore/namestore_api_common.c 2013-08-13 08:56:23 UTC (rev
28559)
+++ gnunet/src/namestore/namestore_api_common.c 2013-08-13 09:18:29 UTC (rev
28560)
@@ -95,7 +95,7 @@
* NOT reentrant!
*
* @param z the zone key
- * @return string form; will be overwritten by next call to
GNUNET_NAMESTORE_z2s
+ * @return string form; will be overwritten by next call to
#GNUNET_NAMESTORE_z2s
*/
const char *
GNUNET_NAMESTORE_z2s (const struct GNUNET_CRYPTO_EccPublicKey *z)
@@ -121,10 +121,8 @@
* records.
*
* @param rd_count number of records in the rd array
- * @param rd array of GNUNET_NAMESTORE_RecordData with rd_count elements
- *
+ * @param rd array of #GNUNET_NAMESTORE_RecordData with @a rd_count elements
* @return the required size to serialize
- *
*/
size_t
GNUNET_NAMESTORE_records_get_size (unsigned int rd_count,
@@ -147,10 +145,9 @@
* Serialize the given records to the given destination buffer.
*
* @param rd_count number of records in the rd array
- * @param rd array of GNUNET_NAMESTORE_RecordData with rd_count elements
+ * @param rd array of #GNUNET_NAMESTORE_RecordData with @a rd_count elements
* @param dest_size size of the destination array
* @param dest where to write the result
- *
* @return the size of serialized records, -1 if records do not fit
*/
ssize_t
@@ -190,7 +187,7 @@
*
* @param a record
* @param b record
- * @return GNUNET_YES if the records are equal or GNUNET_NO if they are not
+ * @return #GNUNET_YES if the records are equal or #GNUNET_NO if they are not
*/
int
GNUNET_NAMESTORE_records_cmp (const struct GNUNET_NAMESTORE_RecordData *a,
@@ -245,8 +242,7 @@
* @param src the serialized record data
* @param rd_count number of records in the rd array
* @param dest where to put the data
- *
- * @return GNUNET_OK on success, GNUNET_SYSERR on error
+ * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
*/
int
GNUNET_NAMESTORE_records_deserialize (size_t len,
@@ -284,7 +280,7 @@
* expiration time is the expiration time of the block with smallest
* expiration time.
*
- * @param rd_count number of records given in 'rd'
+ * @param rd_count number of records given in @a rd
* @param rd array of records
* @return absolute expiration time
*/
@@ -325,7 +321,6 @@
* @param label the name for the records
* @param rd record data
* @param rd_count number of records
- * @param signature where to store the signature
*/
struct GNUNET_NAMESTORE_Block *
GNUNET_NAMESTORE_block_create (const struct GNUNET_CRYPTO_EccPrivateKey *key,
@@ -344,7 +339,7 @@
* to validate signatures received from the network.
*
* @param block block to verify
- * @return GNUNET_OK if the signature is valid
+ * @return #GNUNET_OK if the signature is valid
*/
int
GNUNET_NAMESTORE_block_verify (const struct GNUNET_NAMESTORE_Block *block)
@@ -362,7 +357,7 @@
* @param label the name for the records
* @param proc function to call with the result
* @param proc_cls closure for proc
- * @param GNUNET_OK on success, GNUNET_SYSERR if the block was
+ * @return #GNUNET_OK on success, #GNUNET_SYSERR if the block was
* not well-formed
*/
int
@@ -898,8 +893,8 @@
/**
* Test if a given record is expired.
*
- * @return GNUNET_YES if the record is expired,
- * GNUNET_NO if not
+ * @return #GNUNET_YES if the record is expired,
+ * #GNUNET_NO if not
*/
int
GNUNET_NAMESTORE_is_expired (const struct GNUNET_NAMESTORE_RecordData *rd)
@@ -914,11 +909,11 @@
/**
- * Calculate the DHT query for a given 'label' in a given zone.
+ * Calculate the DHT query for a given @a label in a given @a zone.
*
* @param zone private key of the zone
* @param label label of the record
- * @return query hash to use for the query
+ * @param query hash to use for the query
*/
void
GNUNET_NAMESTORE_query_from_private_key (const struct
GNUNET_CRYPTO_EccPrivateKey *zone,
@@ -933,11 +928,11 @@
/**
- * Calculate the DHT query for a given 'label' in a given zone.
+ * Calculate the DHT query for a given @a label in a given @a zone.
*
* @param pub public key of the zone
* @param label label of the record
- * @return query hash to use for the query
+ * @param query hash to use for the query
*/
void
GNUNET_NAMESTORE_query_from_public_key (const struct
GNUNET_CRYPTO_EccPublicKey *pub,
Modified: gnunet/src/transport/plugin_transport_http_server.c
===================================================================
--- gnunet/src/transport/plugin_transport_http_server.c 2013-08-13 08:56:23 UTC
(rev 28559)
+++ gnunet/src/transport/plugin_transport_http_server.c 2013-08-13 09:18:29 UTC
(rev 28560)
@@ -879,7 +879,7 @@
/**
- * Tell MHD that the connection should timeout after #to seconds.
+ * Tell MHD that the connection should timeout after @a to seconds.
*
* @param plugin our plugin
* @param s session for which the timeout changes
| [Prev in Thread] |
Current Thread |
[Next in Thread] |
- [GNUnet-SVN] r28560 - in gnunet/src: hostlist include namestore transport,
gnunet <=