summaryrefslogtreecommitdiff
path: root/content/fetch.h
diff options
context:
space:
mode:
authorJames Bursa <james@netsurf-browser.org>2003-09-17 23:27:33 +0000
committerJames Bursa <james@netsurf-browser.org>2003-09-17 23:27:33 +0000
commit4e67d451a799d15d724140df490518f5438a4dd2 (patch)
treefff4b35317cb20864da06debb9d8b4be569787ec /content/fetch.h
parent62f5ea585b1c8fe065d61f0236bd0fa34c41faa3 (diff)
downloadnetsurf-4e67d451a799d15d724140df490518f5438a4dd2.tar.gz
netsurf-4e67d451a799d15d724140df490518f5438a4dd2.tar.bz2
[project @ 2003-09-17 23:27:33 by bursa]
Documented fetch. svn path=/import/netsurf/; revision=303
Diffstat (limited to 'content/fetch.h')
-rw-r--r--content/fetch.h27
1 files changed, 2 insertions, 25 deletions
diff --git a/content/fetch.h b/content/fetch.h
index cc52cd414..ed469de04 100644
--- a/content/fetch.h
+++ b/content/fetch.h
@@ -5,31 +5,8 @@
* Copyright 2003 James Bursa <bursa@users.sourceforge.net>
*/
-/**
- * This module handles fetching of data from any url.
- *
- * Usage:
- *
- * fetch_init() must be called once before any other function. fetch_quit()
- * must be called before exiting.
- *
- * fetch_start() will begin fetching a url. The function returns immediately.
- * A pointer to an opaque struct fetch is returned, which can be passed to
- * fetch_abort() to abort the fetch at any time. The caller must supply a
- * callback function which is called when anything interesting happens. The
- * callback function is first called with msg = FETCH_TYPE, with the
- * Content-Type 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_TYPE, 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.
- *
- * fetch_poll() must be called regularly to make progress on fetches.
- *
- * fetch_filetype() is used internally to determine the mime type of local
- * files. It is platform specific, and implemented elsewhere.
+/** \file
+ * Fetching of data from a URL (interface).
*/
#ifndef _NETSURF_DESKTOP_FETCH_H_