[gnunet] 02/90: -DOC: Pass through GNSRECORD library

[gnunet]

This is an automated email from the git hooks/post-receive script.

martin-schanzenbach pushed a commit to branch master
in repository gnunet.

commit 1e13d39e7c191b1bc6733b6505880ec34516b444
Author: Willow Liquorice <willow@howhill.com>
AuthorDate: Wed Aug 31 22:19:44 2022 +0100

    -DOC: Pass through GNSRECORD library
---
 src/gnsrecord/gnsrecord.c               | 16 ----------------
 src/gnsrecord/gnsrecord_crypto.c        | 19 -------------------
 src/gnsrecord/gnsrecord_misc.c          |  8 --------
 src/gnsrecord/gnsrecord_serialization.c | 17 -----------------
 src/include/gnunet_gnsrecord_lib.h      |  1 +
 5 files changed, 1 insertion(+), 60 deletions(-)

diff --git a/src/gnsrecord/gnsrecord.c b/src/gnsrecord/gnsrecord.c
index 52c480ef6..ae4223021 100644
--- a/src/gnsrecord/gnsrecord.c
+++ b/src/gnsrecord/gnsrecord.c
@@ -174,16 +174,6 @@ GNUNET_GNSRECORD_value_to_string (uint32_t type,
 }
 
 
-/**
- * Convert human-readable version of a 'value' of a record to the binary
- * representation.
- *
- * @param type type of the record
- * @param s human-readable string
- * @param data set to value in binary encoding (will be allocated)
- * @param data_size set to number of bytes in @a data
- * @return #GNUNET_OK on success
- */
 int
 GNUNET_GNSRECORD_string_to_value (uint32_t type,
                                   const char *s,
@@ -207,12 +197,6 @@ GNUNET_GNSRECORD_string_to_value (uint32_t type,
 }
 
 
-/**
- * Convert a type name (e.g "AAAA") to the corresponding number.
- *
- * @param dns_typename name to convert
- * @return corresponding number, UINT32_MAX on error
- */
 uint32_t
 GNUNET_GNSRECORD_typename_to_number (const char *dns_typename)
 {
diff --git a/src/gnsrecord/gnsrecord_crypto.c b/src/gnsrecord/gnsrecord_crypto.c
index b5e8be82b..6c1bc6045 100644
--- a/src/gnsrecord/gnsrecord_crypto.c
+++ b/src/gnsrecord/gnsrecord_crypto.c
@@ -868,17 +868,6 @@ block_decrypt_eddsa (const struct GNUNET_GNSRECORD_Block 
*block,
 }
 
 
-/**
- * Decrypt block.
- *
- * @param block block to decrypt
- * @param zone_key public key of the zone
- * @param label the name for the records
- * @param proc function to call with the result
- * @param proc_cls closure for proc
- * @return #GNUNET_OK on success, #GNUNET_SYSERR if the block was
- *        not well-formed
- */
 enum GNUNET_GenericReturnValue
 GNUNET_GNSRECORD_block_decrypt (const struct GNUNET_GNSRECORD_Block *block,
                                 const struct
@@ -946,14 +935,6 @@ GNUNET_GNSRECORD_query_from_private_key (const struct
 }
 
 
-/**
- * Calculate the DHT query for a given @a label in a given @a zone.
- * FIXME: We may want to plugin-ize this at some point.
- *
- * @param pub public key of the zone
- * @param label label of the record
- * @param query hash to use for the query
- */
 void
 GNUNET_GNSRECORD_query_from_public_key (const struct
                                         GNUNET_IDENTITY_PublicKey *pub,
diff --git a/src/gnsrecord/gnsrecord_misc.c b/src/gnsrecord/gnsrecord_misc.c
index 880fc68c6..5a24a83d3 100644
--- a/src/gnsrecord/gnsrecord_misc.c
+++ b/src/gnsrecord/gnsrecord_misc.c
@@ -62,14 +62,6 @@ GNUNET_GNSRECORD_label_check (const char*label, char **emsg)
 }
 
 
-/**
- * Convert a zone key to a string (for printing debug messages).
- * This is one of the very few calls in the entire API that is
- * NOT reentrant!
- *
- * @param z the zone key
- * @return string form; will be overwritten by next call to 
#GNUNET_GNSRECORD_z2s
- */
 const char *
 GNUNET_GNSRECORD_z2s (const struct GNUNET_IDENTITY_PublicKey *z)
 {
diff --git a/src/gnsrecord/gnsrecord_serialization.c 
b/src/gnsrecord/gnsrecord_serialization.c
index 97c488c2b..ef7684892 100644
--- a/src/gnsrecord/gnsrecord_serialization.c
+++ b/src/gnsrecord/gnsrecord_serialization.c
@@ -77,14 +77,6 @@ struct NetworkRecord
 GNUNET_NETWORK_STRUCT_END
 
 
-/**
- * Calculate how many bytes we will need to serialize the given
- * records.
- *
- * @param rd_count number of records in the rd array
- * @param rd array of #GNUNET_GNSRECORD_Data with @a rd_count elements
- * @return the required size to serialize, -1 on error
- */
 ssize_t
 GNUNET_GNSRECORD_records_get_size (unsigned int rd_count,
                                    const struct GNUNET_GNSRECORD_Data *rd)
@@ -143,15 +135,6 @@ GNUNET_GNSRECORD_records_get_size (unsigned int rd_count,
 }
 
 
-/**
- * Serialize the given records to the given destination buffer.
- *
- * @param rd_count number of records in the rd array
- * @param rd array of #GNUNET_GNSRECORD_Data 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
 GNUNET_GNSRECORD_records_serialize (unsigned int rd_count,
                                     const struct GNUNET_GNSRECORD_Data *rd,
diff --git a/src/include/gnunet_gnsrecord_lib.h 
b/src/include/gnunet_gnsrecord_lib.h
index 21fb610f3..4c16b26cf 100644
--- a/src/include/gnunet_gnsrecord_lib.h
+++ b/src/include/gnunet_gnsrecord_lib.h
@@ -528,6 +528,7 @@ GNUNET_GNSRECORD_query_from_private_key (
 
 /**
  * Calculate the DHT query for a given @a label in a given @a zone.
+ * FIXME: We may want to plugin-ize this at some point.
  *
  * @param pub public key of the zone
  * @param label label of the record

-- 
To stop receiving notification emails like this one, please contact
gnunet@gnunet.org.