summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorVincent Sanders <vince@netsurf-browser.org>2011-03-17 08:11:54 +0000
committerVincent Sanders <vince@netsurf-browser.org>2011-03-17 08:11:54 +0000
commitbd39eb42670d1ba66193a59821b6443d2bd16cf8 (patch)
tree9bb42afaa649ca99b900dcc58367eb677dcd144e
parentb96104fe8f351c5b0add8e208e86e130c161bde8 (diff)
downloadnetsurf-bd39eb42670d1ba66193a59821b6443d2bd16cf8.tar.gz
netsurf-bd39eb42670d1ba66193a59821b6443d2bd16cf8.tar.bz2
make resource header documentation more explicit
svn path=/trunk/netsurf/; revision=12083
-rw-r--r--content/fetchers/resource.h21
1 files changed, 18 insertions, 3 deletions
diff --git a/content/fetchers/resource.h b/content/fetchers/resource.h
index 6c590d390..8a6c230f5 100644
--- a/content/fetchers/resource.h
+++ b/content/fetchers/resource.h
@@ -17,21 +17,36 @@
*/
/** \file
- * resource: URL method handler
+ * resource: URL method handler.
+ *
+ * The resource fetcher is intended to provide a flat uniform URL
+ * space for browser local resources referenced by URL. Using this
+ * scheme each frontend is only required to provide a single entry
+ * point to locate resources which can be accessed by the standard URL
+ * type scheme.
+ *
*/
#ifndef NETSURF_CONTENT_FETCHERS_FETCH_RESOURCE_H
#define NETSURF_CONTENT_FETCHERS_FETCH_RESOURCE_H
/**
- * register the resource scheme.
+ * Register the resource scheme.
*
* should only be called from the fetch initialise
*/
void fetch_resource_register(void);
/**
- * callback to translate resource to full url
+ * Callback to translate resource to full url.
+ *
+ * Transforms a resource: filename into a full URL. The returned URL
+ * is used as the target for a redirect. The caller takes ownership of
+ * the returned string including freeing it when finished with it.
+ *
+ * \param filename The filename of the resource to locate.
+ * \return A string containing the full URL of the target object or
+ * NULL if no suitable resource can be found.
*/
char* gui_find_resource(const char *filename);