commit f0e8d8a426ab418be6aa37411e94c716e461bc75
parent c068395ea77dbb8c9d1a63f549d9c0e0c7f148f5
Author: Christian Grothoff <christian@grothoff.org>
Date: Thu, 5 Sep 2013 15:04:48 +0000
-doxygen, remove GNUNET_FS_uri_sks_to_string_fancy (dead)
Diffstat:
4 files changed, 17 insertions(+), 64 deletions(-)
diff --git a/src/fs/fs.h b/src/fs/fs.h
@@ -37,7 +37,7 @@
/**
* Size of the individual blocks used for file-sharing.
*/
-#define DBLOCK_SIZE (32*1024)
+#define DBLOCK_SIZE (32 * 1024)
/**
* Blocksize to use when hashing files for indexing (blocksize for IO,
@@ -83,7 +83,7 @@ struct IndexStartMessage
{
/**
- * Message type will be GNUNET_MESSAGE_TYPE_FS_INDEX_START.
+ * Message type will be #GNUNET_MESSAGE_TYPE_FS_INDEX_START.
*/
struct GNUNET_MessageHeader header;
@@ -129,7 +129,7 @@ struct IndexInfoMessage
{
/**
* Message type will be
- * GNUNET_MESSAGE_TYPE_FS_INDEX_LIST_ENTRY.
+ * #GNUNET_MESSAGE_TYPE_FS_INDEX_LIST_ENTRY.
*/
struct GNUNET_MessageHeader header;
@@ -161,8 +161,7 @@ struct UnindexMessage
{
/**
- * Message type will be
- * GNUNET_MESSAGE_TYPE_FS_UNINDEX.
+ * Message type will be #GNUNET_MESSAGE_TYPE_FS_UNINDEX.
*/
struct GNUNET_MessageHeader header;
@@ -206,8 +205,7 @@ struct SearchMessage
{
/**
- * Message type will be
- * GNUNET_MESSAGE_TYPE_FS_START_SEARCH.
+ * Message type will be #GNUNET_MESSAGE_TYPE_FS_START_SEARCH.
*/
struct GNUNET_MessageHeader header;
@@ -268,7 +266,7 @@ struct PutMessage
{
/**
- * Message type will be GNUNET_MESSAGE_TYPE_FS_PUT.
+ * Message type will be #GNUNET_MESSAGE_TYPE_FS_PUT.
*/
struct GNUNET_MessageHeader header;
@@ -296,7 +294,7 @@ struct ClientPutMessage
{
/**
- * Message type will be GNUNET_MESSAGE_TYPE_FS_PUT.
+ * Message type will be #GNUNET_MESSAGE_TYPE_FS_PUT.
*/
struct GNUNET_MessageHeader header;
diff --git a/src/fs/fs_api.h b/src/fs/fs_api.h
@@ -35,11 +35,6 @@
#include "fs.h"
/**
- * Size of the individual blocks used for file-sharing.
- */
-#define DBLOCK_SIZE (32*1024)
-
-/**
* Pick a multiple of 2 here to achive 8-byte alignment! We also
* probably want DBlocks to have (roughly) the same size as IBlocks.
* With SHA-512, the optimal value is 32768 byte / 128 byte = 256 (128
@@ -206,10 +201,11 @@ struct GNUNET_FS_Uri
struct GNUNET_CRYPTO_EccPublicKey ns;
/**
- * Human-readable identifier chosen for this
- * entry in the namespace.
+ * Human-readable identifier chosen for this entry in the
+ * namespace.
*/
char *identifier;
+
} sks;
/**
diff --git a/src/fs/fs_uri.c b/src/fs/fs_uri.c
@@ -1352,38 +1352,10 @@ GNUNET_FS_uri_sks_get_content_id (const struct GNUNET_FS_Uri *uri)
/**
- * Convert namespace URI to a human readable format
- * (using the namespace description, if available).
- *
- * @param cfg configuration to use
- * @param uri SKS uri to convert
- * @return NULL on error (not an SKS URI)
- */
-char *
-GNUNET_FS_uri_sks_to_string_fancy (struct GNUNET_CONFIGURATION_Handle *cfg,
- const struct GNUNET_FS_Uri *uri)
-{
- char *ret;
- char *name;
- char *unique_name;
-
- if (uri->type != GNUNET_FS_URI_SKS)
- return NULL;
- (void) GNUNET_FS_pseudonym_get_info (cfg, &uri->data.sks.ns,
- NULL, NULL, &name, NULL);
- unique_name = GNUNET_FS_pseudonym_name_uniquify (cfg, &uri->data.sks.ns, name, NULL);
- GNUNET_free (name);
- GNUNET_asprintf (&ret, "%s: %s", unique_name, uri->data.sks.identifier);
- GNUNET_free (unique_name);
- return ret;
-}
-
-
-/**
* Is this a keyword URI?
*
* @param uri the uri
- * @return GNUNET_YES if this is a KSK uri
+ * @return #GNUNET_YES if this is a KSK uri
*/
int
GNUNET_FS_uri_test_ksk (const struct GNUNET_FS_Uri *uri)
diff --git a/src/include/gnunet_fs_service.h b/src/include/gnunet_fs_service.h
@@ -85,7 +85,7 @@ struct GNUNET_FS_Uri;
* @param cls closure
* @param keyword the keyword
* @param is_mandatory is the keyword mandatory (in a search)
- * @return GNUNET_OK to continue to iterate, GNUNET_SYSERR to abort
+ * @return #GNUNET_OK to continue to iterate, #GNUNET_SYSERR to abort
*/
typedef int (*GNUNET_FS_KeywordIterator) (void *cls, const char *keyword,
int is_mandatory);
@@ -101,7 +101,7 @@ typedef int (*GNUNET_FS_KeywordIterator) (void *cls, const char *keyword,
* @param unique_name unique name of the pseudonym (might be NULL)
* @param md meta data known about the pseudonym
* @param rating the local rating of the pseudonym
- * @return GNUNET_OK to continue iteration, GNUNET_SYSERR to abort
+ * @return #GNUNET_OK to continue iteration, #GNUNET_SYSERR to abort
*/
typedef int (*GNUNET_FS_PseudonymIterator) (void *cls,
const struct GNUNET_CRYPTO_EccPublicKey *pseudonym,
@@ -217,9 +217,9 @@ GNUNET_FS_pseudonym_name_uniquify (const struct GNUNET_CONFIGURATION_Handle *cfg
* @param ret_rank a location to store rank. NULL, if rank not needed.
* @param ret_name a location to store human-readable name. Name is not unique.
* NULL, if name is not needed. Free with GNUNET_free().
- * @param name_is_a_dup is set to GNUNET_YES, if ret_name was filled with
+ * @param name_is_a_dup is set to #GNUNET_YES, if ret_name was filled with
* a duplicate of a "no-name" placeholder
- * @return GNUNET_OK on success. GNUENT_SYSERR if the data was
+ * @return #GNUNET_OK on success. #GNUENT_SYSERR if the data was
* unobtainable (in that case ret_* are filled with placeholders -
* empty metadata container, rank -1 and a "no-name" name).
*/
@@ -238,7 +238,7 @@ GNUNET_FS_pseudonym_get_info (const struct GNUNET_CONFIGURATION_Handle *cfg,
* @param cfg configuration to use
* @param ns_uname unique (!) human-readable name for the pseudonym
* @param pseudonym set to pseudonym ID based on 'ns_uname'
- * @return GNUNET_OK on success, GNUNET_SYSERR on failure
+ * @return #GNUNET_OK on success, #GNUNET_SYSERR on failure
*/
int
GNUNET_FS_pseudonym_name_to_id (const struct GNUNET_CONFIGURATION_Handle *cfg,
@@ -256,7 +256,7 @@ GNUNET_FS_pseudonym_name_to_id (const struct GNUNET_CONFIGURATION_Handle *cfg,
* @param md metadata to set
* May be NULL, in which case it erases pseudonym's metadata!
* @param rank rank to assign
- * @return GNUNET_OK on success, GNUNET_SYSERR on failure
+ * @return #GNUNET_OK on success, #GNUNET_SYSERR on failure
*/
int
GNUNET_FS_pseudonym_set_info (const struct GNUNET_CONFIGURATION_Handle *cfg,
@@ -538,19 +538,6 @@ GNUNET_FS_uri_sks_get_content_id (const struct GNUNET_FS_Uri *uri);
/**
- * Convert namespace URI to a human readable format
- * (using the namespace description, if available).
- *
- * @param cfg configuration to use
- * @param uri SKS uri to convert
- * @return NULL on error (not an SKS URI)
- */
-char *
-GNUNET_FS_uri_sks_to_string_fancy (struct GNUNET_CONFIGURATION_Handle *cfg,
- const struct GNUNET_FS_Uri *uri);
-
-
-/**
* Is this a keyword URI?
*
* @param uri the uri
