[gnunet] 01/90: -DOC: Another comment-stripping pass through FS subsystem

[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 26a2f25692410bffd00e4a783b93ae822f58b221
Author: Willow Liquorice <willow@howhill.com>
AuthorDate: Wed Aug 31 20:42:31 2022 +0100

    -DOC: Another comment-stripping pass through FS subsystem
---
 src/fs/fs_dirmetascan.c         |  8 -----
 src/fs/fs_download.c            | 64 --------------------------------------
 src/fs/fs_file_information.c    | 69 -----------------------------------------
 src/fs/fs_list_indexed.c        |  8 -----
 src/fs/fs_namespace.c           | 15 ---------
 src/fs/fs_uri.c                 | 17 ----------
 src/include/gnunet_fs_service.h |  2 +-
 7 files changed, 1 insertion(+), 182 deletions(-)

diff --git a/src/fs/fs_dirmetascan.c b/src/fs/fs_dirmetascan.c
index cb50182f9..8dd216324 100644
--- a/src/fs/fs_dirmetascan.c
+++ b/src/fs/fs_dirmetascan.c
@@ -112,14 +112,6 @@ GNUNET_FS_directory_scan_abort (struct 
GNUNET_FS_DirScanner *ds)
 }
 
 
-/**
- * Obtain the result of the scan after the scan has signalled
- * completion.  Must not be called prior to completion.  The 'ds' is
- * freed as part of this call.
- *
- * @param ds directory scanner structure
- * @return the results of the scan (a directory tree)
- */
 struct GNUNET_FS_ShareTreeItem *
 GNUNET_FS_directory_scan_get_result (struct GNUNET_FS_DirScanner *ds)
 {
diff --git a/src/fs/fs_download.c b/src/fs/fs_download.c
index e0ad8cd1d..3f5ac6c64 100644
--- a/src/fs/fs_download.c
+++ b/src/fs/fs_download.c
@@ -2096,36 +2096,6 @@ create_download_context (struct GNUNET_FS_Handle *h,
 }
 
 
-/**
- * Download parts of a file.  Note that this will store
- * the blocks at the respective offset in the given file.  Also, the
- * download is still using the blocking of the underlying FS
- * encoding.  As a result, the download may *write* outside of the
- * given boundaries (if offset and length do not match the 32k FS
- * block boundaries). <p>
- *
- * This function should be used to focus a download towards a
- * particular portion of the file (optimization), not to strictly
- * limit the download to exactly those bytes.
- *
- * @param h handle to the file sharing subsystem
- * @param uri the URI of the file (determines what to download); CHK or LOC URI
- * @param meta known metadata for the file (can be NULL)
- * @param filename where to store the file, maybe NULL (then no file is
- *        created on disk and data must be grabbed from the callbacks)
- * @param tempname where to store temporary file data, not used if filename is 
non-NULL;
- *        can be NULL (in which case we will pick a name if needed); the 
temporary file
- *        may already exist, in which case we will try to use the data that is 
there and
- *        if it is not what is desired, will overwrite it
- * @param offset at what offset should we start the download (typically 0)
- * @param length how many bytes should be downloaded starting at offset
- * @param anonymity anonymity level to use for the download
- * @param options various options
- * @param cctx initial value for the client context for this download
- * @param parent parent download to associate this download with (use NULL
- *        for top-level downloads; useful for manually-triggered recursive 
downloads)
- * @return context that can be used to control this download
- */
 struct GNUNET_FS_DownloadContext *
 GNUNET_FS_download_start (struct GNUNET_FS_Handle *h,
                           const struct GNUNET_FS_Uri *uri,
@@ -2163,40 +2133,6 @@ GNUNET_FS_download_start (struct GNUNET_FS_Handle *h,
 }
 
 
-/**
- * Download parts of a file based on a search result.  The download
- * will be associated with the search result (and the association
- * will be preserved when serializing/deserializing the state).
- * If the search is stopped, the download will not be aborted but
- * be 'promoted' to a stand-alone download.
- *
- * As with the other download function, this will store
- * the blocks at the respective offset in the given file.  Also, the
- * download is still using the blocking of the underlying FS
- * encoding.  As a result, the download may *write* outside of the
- * given boundaries (if offset and length do not match the 32k FS
- * block boundaries). <p>
- *
- * The given range can be used to focus a download towards a
- * particular portion of the file (optimization), not to strictly
- * limit the download to exactly those bytes.
- *
- * @param h handle to the file sharing subsystem
- * @param sr the search result to use for the download (determines uri and
- *        meta data and associations)
- * @param filename where to store the file, maybe NULL (then no file is
- *        created on disk and data must be grabbed from the callbacks)
- * @param tempname where to store temporary file data, not used if filename is 
non-NULL;
- *        can be NULL (in which case we will pick a name if needed); the 
temporary file
- *        may already exist, in which case we will try to use the data that is 
there and
- *        if it is not what is desired, will overwrite it
- * @param offset at what offset should we start the download (typically 0)
- * @param length how many bytes should be downloaded starting at offset
- * @param anonymity anonymity level to use for the download
- * @param options various download options
- * @param cctx initial value for the client context for this download
- * @return context that can be used to control this download
- */
 struct GNUNET_FS_DownloadContext *
 GNUNET_FS_download_start_from_search (struct GNUNET_FS_Handle *h,
                                       struct GNUNET_FS_SearchResult *sr,
diff --git a/src/fs/fs_file_information.c b/src/fs/fs_file_information.c
index c5faa14d4..dc5db9d3f 100644
--- a/src/fs/fs_file_information.c
+++ b/src/fs/fs_file_information.c
@@ -83,20 +83,6 @@ GNUNET_FS_file_information_set_filename (struct 
GNUNET_FS_FileInformation *s,
 }
 
 
-/**
- * Create an entry for a file in a publish-structure.
- *
- * @param h handle to the file sharing subsystem
- * @param client_info initial value for the client-info value for this entry
- * @param filename name of the file or directory to publish
- * @param keywords under which keywords should this file be available
- *         directly; can be NULL
- * @param meta metadata for the file
- * @param do_index #GNUNET_YES for index, #GNUNET_NO for insertion,
- *                #GNUNET_SYSERR for simulation
- * @param bo block options
- * @return publish structure entry for the file
- */
 struct GNUNET_FS_FileInformation *
 GNUNET_FS_file_information_create_from_file (
   struct GNUNET_FS_Handle *h,
@@ -157,22 +143,6 @@ GNUNET_FS_file_information_create_from_file (
 }
 
 
-/**
- * Create an entry for a file in a publish-structure.
- *
- * @param h handle to the file sharing subsystem
- * @param client_info initial value for the client-info value for this entry
- * @param length length of the file
- * @param data data for the file (should not be used afterwards by
- *        the caller; callee will "free")
- * @param keywords under which keywords should this file be available
- *         directly; can be NULL
- * @param meta metadata for the file
- * @param do_index GNUNET_YES for index, GNUNET_NO for insertion,
- *                GNUNET_SYSERR for simulation
- * @param bo block options
- * @return publish structure entry for the file
- */
 struct GNUNET_FS_FileInformation *
 GNUNET_FS_file_information_create_from_data (
   struct GNUNET_FS_Handle *h,
@@ -202,22 +172,6 @@ GNUNET_FS_file_information_create_from_data (
 }
 
 
-/**
- * Create an entry for a file in a publish-structure.
- *
- * @param h handle to the file sharing subsystem
- * @param client_info initial value for the client-info value for this entry
- * @param length length of the file
- * @param reader function that can be used to obtain the data for the file
- * @param reader_cls closure for "reader"
- * @param keywords under which keywords should this file be available
- *         directly; can be NULL
- * @param meta metadata for the file
- * @param do_index #GNUNET_YES for index, #GNUNET_NO for insertion,
- *                #GNUNET_SYSERR for simulation
- * @param bo block options
- * @return publish structure entry for the file
- */
 struct GNUNET_FS_FileInformation *
 GNUNET_FS_file_information_create_from_reader (
   struct GNUNET_FS_Handle *h,
@@ -267,18 +221,6 @@ GNUNET_FS_file_information_is_directory (
 }
 
 
-/**
- * Create an entry for an empty directory in a publish-structure.
- *
- * @param h handle to the file sharing subsystem
- * @param client_info initial value for the client-info value for this entry
- * @param meta metadata for the directory
- * @param keywords under which keywords should this directory be available
- *         directly; can be NULL
- * @param bo block options
- * @param filename name of the directory; can be NULL
- * @return publish structure entry for the directory , NULL on error
- */
 struct GNUNET_FS_FileInformation *
 GNUNET_FS_file_information_create_empty_directory (
   struct GNUNET_FS_Handle *h,
@@ -303,17 +245,6 @@ GNUNET_FS_file_information_create_empty_directory (
 }
 
 
-/**
- * Add an entry to a directory in a publish-structure.  Clients
- * should never modify publish structures that were passed to
- * #GNUNET_FS_publish_start already.
- *
- * @param dir the directory
- * @param ent the entry to add; the entry must not have been
- *            added to any other directory at this point and
- *            must not include @a dir in its structure
- * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
- */
 int
 GNUNET_FS_file_information_add (struct GNUNET_FS_FileInformation *dir,
                                 struct GNUNET_FS_FileInformation *ent)
diff --git a/src/fs/fs_list_indexed.c b/src/fs/fs_list_indexed.c
index 0e16fb01b..6a2ddd93c 100644
--- a/src/fs/fs_list_indexed.c
+++ b/src/fs/fs_list_indexed.c
@@ -155,14 +155,6 @@ mq_error_handler (void *cls,
 }
 
 
-/**
- * Iterate over all indexed files.
- *
- * @param h handle to the file sharing subsystem
- * @param iterator function to call on each indexed file
- * @param iterator_cls closure for iterator
- * @return NULL on error ('iter' is not called)
- */
 struct GNUNET_FS_GetIndexedContext *
 GNUNET_FS_get_indexed_files (struct GNUNET_FS_Handle *h,
                              GNUNET_FS_IndexedFileProcessor iterator,
diff --git a/src/fs/fs_namespace.c b/src/fs/fs_namespace.c
index 155486be5..bc94dd1fc 100644
--- a/src/fs/fs_namespace.c
+++ b/src/fs/fs_namespace.c
@@ -423,21 +423,6 @@ sks_publish_cont (void *cls, const char *msg)
 }
 
 
-/**
- * Publish an SBlock on GNUnet.
- *
- * @param h handle to the file sharing subsystem
- * @param ns namespace to publish in
- * @param identifier identifier to use
- * @param update update identifier to use
- * @param meta metadata to use
- * @param uri URI to refer to in the SBlock
- * @param bo block options
- * @param options publication options
- * @param cont continuation
- * @param cont_cls closure for cont
- * @return NULL on error ('cont' will still be called)
- */
 struct GNUNET_FS_PublishSksContext *
 GNUNET_FS_publish_sks (struct GNUNET_FS_Handle *h,
                        const struct GNUNET_CRYPTO_EcdsaPrivateKey *ns,
diff --git a/src/fs/fs_uri.c b/src/fs/fs_uri.c
index 2d5566b54..cdea8b72d 100644
--- a/src/fs/fs_uri.c
+++ b/src/fs/fs_uri.c
@@ -91,14 +91,6 @@
 #include <unistdio.h>
 
 
-/**
- * Get a unique key from a URI.  This is for putting URIs
- * into HashMaps.  The key may change between FS implementations.
- *
- * @param uri uri to convert to a unique key
- * @param key where to store the unique key
- * @return #GNUNET_OK on success
- */
 int
 GNUNET_FS_uri_to_key (const struct GNUNET_FS_Uri *uri,
                       struct GNUNET_HashCode *key)
@@ -723,15 +715,6 @@ GNUNET_FS_uri_ksk_get_keyword_count (const struct 
GNUNET_FS_Uri *uri)
 }
 
 
-/**
- * Iterate over all keywords in this keyword URI.
- *
- * @param uri ksk uri to get the keywords from
- * @param iterator function to call on each keyword
- * @param iterator_cls closure for iterator
- * @return -1 if this is not a keyword URI, otherwise number of
- *   keywords iterated over until iterator aborted
- */
 int
 GNUNET_FS_uri_ksk_get_keywords (const struct GNUNET_FS_Uri *uri,
                                 GNUNET_FS_KeywordIterator iterator,
diff --git a/src/include/gnunet_fs_service.h b/src/include/gnunet_fs_service.h
index 6b664169a..f40670ea5 100644
--- a/src/include/gnunet_fs_service.h
+++ b/src/include/gnunet_fs_service.h
@@ -111,7 +111,7 @@ typedef int
  * into HashMaps.  The key may change between FS implementations.
  *
  * @param uri uri to convert to a unique key
- * @param key wherer to store the unique key
+ * @param key where to store the unique key
  * @return #GNUNET_OK on success
  */
 int

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