summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAshish Gupta <ashmew2@gmail.com>2017-10-09 01:04:31 +0200
committerAshish Gupta <ashmew2@gmail.com>2017-10-09 01:04:52 +0200
commitfda2c1a4c7241b27ea884f4ba9190fedd0631caa (patch)
tree0ae384db07efaa74102814fe9862ed3dcfdb43a5
parent2f466751ca15ee334bc8fbb694dacc2ed33e9bd2 (diff)
downloadnetsurf-ashmew2/fix-description.tar.gz
netsurf-ashmew2/fix-description.tar.bz2
Fix descriptions in curl fetcher and fetch.hashmew2/fix-description
-rw-r--r--content/fetch.h8
-rw-r--r--content/fetchers/curl.c20
2 files changed, 6 insertions, 22 deletions
diff --git a/content/fetch.h b/content/fetch.h
index 5521778ea..79fb0ede3 100644
--- a/content/fetch.h
+++ b/content/fetch.h
@@ -103,14 +103,14 @@ typedef void (*fetch_callback)(const fetch_msg *msg, void *p);
* The function returns immediately. The fetch may be queued for later
* processing.
*
- * A pointer to an opaque struct fetch is returned, which can be passed to
+ * A pointer to an opaque struct fetch_info is returned, which can be passed to
* fetch_abort() to abort the fetch at any time. Returns NULL if memory is
* exhausted (or some other fatal error occurred).
*
* The caller must supply a callback function which is called when anything
- * interesting happens. The callback function is first called with msg
- * FETCH_HEADER, with the header in data, then one or more times
- * with FETCH_DATA with some data for the url, and finally with
+ * interesting happens. The callback function is first called one or more times
+ * with msg.type FETCH_HEADER for each line of the header in data, then one or
+ * more times with FETCH_DATA with some data for the url, and finally with
* FETCH_FINISHED. Alternatively, FETCH_ERROR indicates an error occurred:
* data contains an error message. FETCH_REDIRECT may replace the FETCH_HEADER,
* FETCH_DATA, FETCH_FINISHED sequence if the server sends a replacement URL.
diff --git a/content/fetchers/curl.c b/content/fetchers/curl.c
index a6146edb3..2c15cc106 100644
--- a/content/fetchers/curl.c
+++ b/content/fetchers/curl.c
@@ -295,24 +295,8 @@ fetch_curl_post_convert(const struct fetch_multipart_data *control)
/**
* Start fetching data for the given URL.
- *
- * The function returns immediately. The fetch may be queued for later
- * processing.
- *
- * A pointer to an opaque struct curl_fetch_info is returned, which can be
- * passed to fetch_abort() to abort the fetch at any time. Returns 0 if memory
- * is exhausted (or some other fatal error occurred).
- *
- * The caller must supply a callback function which is called when anything
- * interesting happens. The callback function is first called with msg
- * FETCH_HEADER, with the header in data, then one or more times
- * with FETCH_DATA with some data for the url, and finally with
- * FETCH_FINISHED. Alternatively, FETCH_ERROR indicates an error occurred:
- * data contains an error message. FETCH_REDIRECT may replace the FETCH_HEADER,
- * FETCH_DATA, FETCH_FINISHED sequence if the server sends a replacement URL.
- *
- * Some private data can be passed as the last parameter to fetch_start, and
- * callbacks will contain this.
+ * Returns a pointer to struct curl_fetch_info.
+ * See content/fetch.h for more information.
*/
static void *
fetch_curl_setup(struct fetch *parent_fetch,