From 4e67d451a799d15d724140df490518f5438a4dd2 Mon Sep 17 00:00:00 2001 From: James Bursa Date: Wed, 17 Sep 2003 23:27:33 +0000 Subject: [project @ 2003-09-17 23:27:33 by bursa] Documented fetch. svn path=/import/netsurf/; revision=303 --- content/fetch.h | 27 ++------------------------- 1 file changed, 2 insertions(+), 25 deletions(-) (limited to 'content/fetch.h') 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 */ -/** - * 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_ -- cgit v1.2.3